FOfolk
Group members

Add a group member

Changed on

Adds a member to a group.

post/v1/groups/{groupId}/members

Request

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

Path parameters

groupIdstring required

The identifier of the group. You can retrieve a list of group identifiers using the /v1/groups endpoint.

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

idstring required
role'admin' | 'contributor' | 'reader' required

Response

The group member that was added.

deprecationsstring[]

Example response

{
  "data": {
    "id": "usr_bc984b3f-0386-434d-82d7-a91eb6badd71",
    "fullName": "John Doe",
    "email": "john.doe@example.com",
    "role": "contributor"
  },
  "deprecations": [
    "This field is deprecated"
  ]
}

Changes