/ Docs
APIUsers

Accept Invitation

Accept a pending invitation, becoming a member of the organization.

POST
/v1/users/me/invitations/{invitation_id}/accept

Authorization

BearerAuth
AuthorizationBearer <token>

Botyard API key — see /docs/authentication.

In: header

Path Parameters

invitation_id*Invitation Id

Response Body

application/json

curl -X POST "https://example.com/v1/users/me/invitations/string/accept"
{
  "user_id": "string",
  "org_id": "string",
  "role_id": "string",
  "user": {
    "user_id": "string",
    "email": "string",
    "name": "string",
    "avatar_url": "string",
    "created_at": "2019-08-24T14:15:22Z",
    "updated_at": "2019-08-24T14:15:22Z"
  },
  "created_at": "2019-08-24T14:15:22Z",
  "updated_at": "2019-08-24T14:15:22Z"
}
{
  "type": "string",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string",
  "error_code": "string",
  "errors": [
    {
      "pointer": "string",
      "detail": "string",
      "type": "string"
    }
  ],
  "trace_id": "string"
}

List My Invitations

List pending invitations for the current user's email.

Decline Invitation

Decline a pending invitation addressed to the current user. 404 when the invitation does not exist or is addressed to someone else; 409 when it is yours but no longer pending. Declining never creates a membership, releases the seat the invitation reserved, and leaves the org free to invite the same address again. The decline is recorded in the inviting org's audit log.