organizations.acceptInvitation

POST

/v1/invitations/{invitationId}/accept

const url = 'https://example.com/v1/invitations/example/accept';
const options = {method: 'POST', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request POST \
  --url https://example.com/v1/invitations/example/accept \
  --header 'Authorization: Bearer <token>'

Joins the organization of the invitation. You need the session cookie, and your verified email must be the email of the invitation. An invitation to use a Bot needs POST /v1/bot-invitations/accept instead.

Authorizations

token
session

Parameters

Path Parameters

invitationId

required

string

>= 1 characters <= 128 characters

Responses

200

Success

application/json

object

required

string

name

required

string

status

required

string

Allowed values: active suspended

createdAt

required

string

Example

{
  "status": "active"
}

400

InvitationInvalid

application/json

object

_tag

required

string

Allowed values: InvitationInvalid

message

required

string

Example

{
  "_tag": "InvitationInvalid"
}

401

AuthenticationRequired

application/json

object

_tag

required

string

Allowed values: AuthenticationRequired

Example

{
  "_tag": "AuthenticationRequired"
}

403

PermissionDenied | MembershipRequired | ForbiddenOrigin

application/json

Any of:

object

_tag

required

string

Allowed values: PermissionDenied

permission

required

string

Allowed values: responses.run sessions.read sessions.write requests.resolve bots.read bots.write bots.delegate bots.share triggers.read triggers.write channels.read channels.write channels.use channel_identities.read channel_identities.write connections.read connections.write apps.use apps.publish computers.read computers.write computers.use computer_providers.read computer_providers.write computer_providers.use models.use tokens.read tokens.write organization.read organization.write roles.write model_providers.read model_providers.write sso.read sso.write platform.read platform.write members.read members.write audit_logs.read usage.read budgets.read budgets.write

resource

required

string

Example

{
  "_tag": "PermissionDenied",
  "permission": "responses.run"
}

404

InvitationNotFound | RoleNotFound

application/json

Any of:

object
object

object

_tag

required

string

Allowed values: InvitationNotFound

invitationId

required

string

Example

{
  "_tag": "InvitationNotFound"
}

503

OrganizationStorageUnavailable | AuthorizationUnavailable | AuthenticationUnavailable

application/json

Any of:

object

_tag

required

string

Allowed values: OrganizationStorageUnavailable

Example

{
  "_tag": "OrganizationStorageUnavailable"
}