FOfolk
Groups

Update a group

Changed on

Update a group's name and/or visibility.

patch/v1/groups/{groupId}

Request

  • Base URL
    https://api.folk.app
  • URL
    https://api.folk.app/v1/groups/{groupId}
  • Auth
    HTTP bearer

Path parameters

groupIdstring required

The identifier of the group to update.

Headers

Idempotency-Keystring

A unique key, such as a UUID, that makes retrying this request safe: a retry with the same key and body returns the original response without running the operation again. Keys are kept for 24 hours after the request completes.

Example:8e03978e-40d5-43e8-bc93-6894a57f9324

Request body

namestring

The new name of the group.

visibility'public' | 'private'

The visibility of a group.

  • public: The group is visible to all users in the workspace.
  • private: The group is visible only to explicitly added group members.
emojistring emoji

The new emoji of the group, as a single native emoji. Omit it to keep the current emoji; it cannot be removed.

Example request

{
  "name": "Investors",
  "emoji": "🤝"
}

Response

The updated group result.

deprecationsstring[]

Example response

{
  "data": {
    "id": "grp_bc984b3f-0386-434d-82d7-a91eb6badd71",
    "name": "Group Name",
    "visibility": "private",
    "createdBy": "usr_abc84b3f-0386-434d-82d7-a91eb6bad999",
    "emoji": "🤝"
  },
  "deprecations": [
    "This field is deprecated"
  ]
}

Changes