Update workspace invitation

curl --request PUT \
  --url https://app.getcensus.com/api/v1/workspaces/{workspace_id}/invitations/{invitation_id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "role": "owner"
}
'

{
  "status": "updated",
  "data": {
    "id": 90967,
    "email": "[email protected]",
    "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"
      }
    ]
  }
}

PUT

workspaces

{workspace_id}

invitations

{invitation_id}

Update workspace invitation

curl --request PUT \
  --url https://app.getcensus.com/api/v1/workspaces/{workspace_id}/invitations/{invitation_id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "role": "owner"
}
'

{
  "status": "updated",
  "data": {
    "id": 90967,
    "email": "[email protected]",
    "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"
      }
    ]
  }
}

Authorizations

Authorization

string

header

required

Bearer authorization using your Personal Access Token. Generate a new PAT on your user settings page.

Path Parameters

workspace_id

integer

required

ID of the workspace

invitation_id

integer

required

ID of the invitation

Body

application/json

role

enum<string>

required

The new role to be associated with this invitation that will be applied to the user once the invite is claimed.

Available options:

owner,

editor,

operator,

viewer

Example:

"owner"

Response

Successfully updated workspace invitation role.

status

enum<string>

required

The outcome of the update request

Available options:

updated

Example:

"updated"

data

object

required

Show child attributes

data.id

integer

Unique identifier for the invitation.

Example:

90967

data.email

string

Email address of the invitee.

Example:

"[email protected]"

data.created_at

string<date-time>

Timestamp when the invitation was created.

Example:

"2023-09-22T20:25:45.185Z"

data.created_by_id

integer

ID of the user who created the invitation.

Example:

13

data.claimed_at

string<date-time>

Timestamp when the invitation was claimed.

Example:

"2023-09-22T20:25:45.185Z"

data.claimed_by_id

integer

ID of the user who claimed the invitation.

Example:

11

data.role

enum<string>

Role assigned to the invitee.

Available options:

admin,

member

Example:

"admin"

data.associated_workspace_invitations

object[]

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.

Show child attributes

data.associated_workspace_invitations.id

integer

Unique identifier for the invitation to a specific workspace.

Example:

90967

data.associated_workspace_invitations.workspace_id

integer

Unique identifier for the workspace.

Example:

1234

data.associated_workspace_invitations.role

enum<string>

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

Available options:

Viewer,

Operator,

Editor,

Owner

Example:

"Viewer"

List workspace invitations Revoke workspace invitation

⌘I

Introduction

Organization APIs

Workspace APIs

Update workspace invitation

Authorizations

Path Parameters

Body

Response