Withdraw Invitation

DELETE

/v1/invitations/{invitation_id}

curl --request DELETE \
  --url https://example.com/v1/invitations/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0 \
  --header 'X-API-Key: <X-API-Key>'

Withdraw a pending invitation: one to a workspace with project_id, or with none any in the organization. Needs members:write.

Authorizations

• ApiKey
• Bearer

Parameters

Path Parameters

invitation_id

required

string format: uuid

Query Parameters

project_id

A workspace of the organization; omit it for the organization itself. A workspace key names its own workspace.

string | null format: uuid

A workspace of the organization; omit it for the organization itself. A workspace key names its own workspace.

Responses

200

The invitation, withdrawn

Media type application/json

InvitationWithdrawn

object

invitation_id

required

string format: uuid

Example ^generated

{
  "invitation_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0"
}

400

Refused by the role rules

Media type application/json

ErrorResponse

Standard error response.

object

detail

required

Error message describing what went wrong

string

Example ^generated

{
  "detail": "example"
}

401

Invalid or missing API key

Media type application/json

ErrorResponse

Standard error response.

object

detail

required

Error message describing what went wrong

string

Example ^generated

{
  "detail": "example"
}

403

The key lacks members:write, or its creator may not give or take this role here (nobody grants above their own role)

Media type application/json

ErrorResponse

Standard error response.

object

detail

required

Error message describing what went wrong

string

Example ^generated

{
  "detail": "example"
}

404

Not found or not readable

Media type application/json

ErrorResponse

Standard error response.

object

detail

required

Error message describing what went wrong

string

Example ^generated

{
  "detail": "example"
}

409

The organization’s last owner stays

Media type application/json

ErrorResponse

Standard error response.

object

detail

required

Error message describing what went wrong

string

Example ^generated

{
  "detail": "example"
}

422

Validation Error

Media type application/json

HTTPValidationError

object

detail

Array<object>

ValidationError

object

loc

required

Location

Array<string | integer>

msg

required

Message

string

type

required

Error Type

string

input

ctx

Context

object

Example ^generated

{
  "detail": [
    {
      "loc": [
        "example"
      ],
      "msg": "example",
      "type": "example",
      "input": "example",
      "ctx": {}
    }
  ]
}