Skip to content
OpenBot

organizations.declineInvitation

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

Says no to an invitation. You need the session cookie and the email of the invitation.

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
invitationId
required
string
>= 1 characters <= 128 characters

Responses

Section titled “Responses”

200

Section titled “200”

Success

Media typeapplication/json
object
id
required
string
>= 1 characters <= 128 characters
organizationId
required
string
organizationName
required
string
email
required
string
roles
required
Array
status
required
string
Allowed values: pending accepted declined revoked expired
invitedBy
required
string
createdAt
required
string
expiresAt
required
string
bot
object
id
required
string
name
required
string

Example 

{
  "roles": [
    "super_administrator"
  ],
  "status": "pending"
}

400

Section titled “400”

InvitationInvalid

Media typeapplication/json
object
_tag
required
string
Allowed values: InvitationInvalid
message
required
string

Example 

{
  "_tag": "InvitationInvalid"
}

401

Section titled “401”

AuthenticationRequired

Media typeapplication/json
object
_tag
required
string
Allowed values: AuthenticationRequired

Example 

{
  "_tag": "AuthenticationRequired"
}

403

Section titled “403”

PermissionDenied | MembershipRequired | ForbiddenOrigin

Media typeapplication/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

Section titled “404”

InvitationNotFound | RoleNotFound

Media typeapplication/json
Any of:
object
_tag
required
string
Allowed values: InvitationNotFound
invitationId
required
string

Example 

{
  "_tag": "InvitationNotFound"
}

503

Section titled “503”

OrganizationStorageUnavailable | AuthorizationUnavailable | AuthenticationUnavailable

Media typeapplication/json
Any of:
object
_tag
required
string
Allowed values: OrganizationStorageUnavailable

Example 

{
  "_tag": "OrganizationStorageUnavailable"
}