Invitations

Update an invitation

Changed on

Changes a pending invitation's role.

patch/invitations/{id}

Request

  • Base URL: https://api.cavuno.com/v1
  • URL: https://api.cavuno.com/v1/invitations/{id}
  • Auth: HTTP bearer

Path parameters

idstring required

The invitation ID.

Request body

role'admin' | 'member' required

The new role for the pending invitation.

Response

Successful response.

idstring required

Unique identifier for the invitation.

object'invitation' required

String representing the object's type.

emailstring required

The invited email address.

rolestring required

The role the invitee will receive on accept.

statusstring required

The invitation status: pending, expired, accepted, declined.

expiresAtstring required

ISO-8601 timestamp of when the invitation expires.

invitedByUserIdstring nullable required

Identifier of the user who created the invitation.

createdAtstring required

ISO-8601 timestamp of when the invitation was created.

Changes

  • c34152c38176Revision changes
    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status