Create invitation

Create a new invitation for a user to join the current organization.

Request schema

Header parameters

Authorization

stringrequired

HTTP: basicAuth

HTTP AuthorizationScheme: basic

Request

string

Email address of the invitee.

example:

newuser@example.com

role

string

Role assigned to the invitee.

enum:

"admin""member"

workspaces

array

List of workspace to which the invitee will be added to once they accept their invitation and the role they'll be assigned for each one. Each workspace must exist as part of the current organization. If the user is already a member of the organization they'll be automatically added to each workspace listed.

integer

Unique identifier for the workspace.

role

string

Role assigned to the invitee.

enum:

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

Http + 1.1

POST

https://app.getcensus.com/api/v1/invitations

POST /api/v1/invitations HTTP/1.1
Authorization: Bearer REPLACE_BEARER_TOKEN
Content-Type: application/json
Host: app.getcensus.com
Content-Length: 185

{
  "email": "newuser@example.com",
  "role": "admin",
  "workspaces": [
    {
      "id": 1234,
      "role": "Viewer"
    },
    {
      "id": 4567,
      "role": "Editor"
    }
  ]
}

Responses

200

Successfully created the invitation

400

Bad Request. Invitations are disabled for this organization.

`200`

status

stringrequired

The outcome of the creation request

enum:

"success"

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"

{
  "status": "success",
  "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"
      }
    ]
  }
}