Update invitation

Update an unclaimed invitation's role within the organization.

Request schema

Path parameters

invitation_id

integerrequired

ID of the invitation

Header parameters

Authorization

stringrequired

HTTP: basicAuth

HTTP AuthorizationScheme: basic

Request

role

string

enum:

"admin""member"

Http + 1.1

PATCH

https://app.getcensus.com/api/v1/invitations/{invitation_id}

PATCH /api/v1/invitations/{invitation_id} HTTP/1.1
Authorization: Bearer REPLACE_BEARER_TOKEN
Content-Type: application/json
Host: app.getcensus.com
Content-Length: 21

{
  "role": "admin"
}

Responses

200

Successfully updated invitation's role.

404

Resource not found.

`200`

status

stringrequired

The outcome of the update request

enum:

"updated"

data

objectrequired

integer

Unique identifier for the invitation.

example:

90967

string

Email address of the invitee.

example:

newuser@example.com

created_at

string

Timestamp when the invitation was created.

format:

date-time

example:

2023-09-22T20:25:45.185Z

created_by_id

integer

ID of the user who created the invitation.

example:

claimed_at

string

Timestamp when the invitation was claimed.

format:

date-time

example:

2023-09-22T20:25:45.185Z

claimed_by_id

integer

ID of the user who claimed the invitation.

example:

role

string

Role assigned to the invitee.

enum:

"admin""member"

associated_workspace_invitations

array

The list of invitations to a specific workspace that have not yet been claimed. These will be accepted automatically when the user accepts their invite to the organization.

integer

Unique identifier for the invitation to a specific workspace.

example:

90967

workspace_id

integer

Unique identifier for the workspace.

example:

1234

role

string

Role assigned to the invitee. If the Organization does not have Access Controls OR no role is specified the default will be "Owner".

enum:

"Viewer""Operator""Editor""Owner"

`404`

status

integer

HTTP status code.

enum:

"404"

{
  "status": "updated",
  "data": {
    "id": 90967,
    "email": "newuser@example.com",
    "created_at": "2023-09-22T20:25:45.185Z",
    "created_by_id": 13,
    "claimed_at": "2023-09-22T20:25:45.185Z",
    "claimed_by_id": 11,
    "role": "admin",
    "associated_workspace_invitations": [
      {
        "id": 90967,
        "workspace_id": 1234,
        "role": "Viewer"
      }
    ]
  }
}