Editar grupo

post

https://sua-plataforma.ensinio.cloud/public/api/v1/groups/{id}

Atualiza só os campos enviados de um grupo. Este endpoint precisa estar habilitado no seu plano.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

integer

required

Group ID.

Body Params

Every field is optional; only the ones sent change.

title

string

length ≤ 256

subscription_method

string

enum

How users join the group:

free_access: open, anyone joins without approval.
request_access: restricted, the user asks to join and an admin approves.
paid_access: paid, access comes from buying an offer.

Allowed:

description

string | null

Accepts HTML. null clears the description.

visibility

string

enum

Visibility of the group:

public: shown in the showcase, the search and the trails. Default on creation.
restricted: not shown in the showcase, the search or the trails; members still see the group in their content.
inactive: hidden from members too, in their content, profile and feed.

Allowed:

logo_vertical

uri | null

Link to the new cover, or null to remove the current one.

logo_horizontal

uri | null

Link to the new cover, or null to remove the current one.

Headers

content-type

string

enum

Defaults to application/json

Generated from available request content types

Allowed:

Responses

200Group updated

401Missing or invalid token

403Feature not enabled in the plan

404Group not found. Archived groups are not found either.

422Invalid field, cover link that could not be downloaded or is not an image, or plan group limit reached

429Rate limit exceeded