Invite user to workspace
Invite a user to a workspace. If the user already exists in the organization they will be automatically added to the workspace.
Request schema
Path parameters
workspace_id
integerrequired
ID of the workspace
Header parameters
Authorization
stringrequired
HTTP: basicAuth
HTTP AuthorizationScheme: basic
Request
emails
array
Email addresses of the invitees.
example:
type:
role
string
Role assigned to the invitee.
enum:
Http + 1.1
POST
https://app.getcensus.com/api/v1/workspaces/{workspace_id}/invitations
POST /api/v1/workspaces/{workspace_id}/invitations HTTP/1.1 Authorization: Bearer REPLACE_BEARER_TOKEN Content-Type: application/json Host: app.getcensus.com Content-Length: 66 { "emails": [ "newuser@example.com" ], "role": "owner" }
Responses
200
Successfully created workspace invitation.
404
Resource not found.
200
status
stringrequired
The outcome of the creation request
enum:
data
objectrequired
id
integer
Unique identifier for the invitation.
example:
email
string
Email address of the invitee.
example:
created_at
string
Timestamp when the invitation was created.
format:
example:
created_by_id
integer
ID of the user who created the invitation.
example:
claimed_by_id
integer
ID of the user who claimed the invitation.
example:
role
string
Role assigned to the invitee.
enum:
404
status
integer
HTTP status code.
enum:
{ "status": "success", "data": { "id": 90967, "email": "newuser@example.com", "created_at": "2023-09-22T20:25:45.185Z", "created_by_id": 13, "claimed_by_id": 11, "role": "owner" } }