Workspace Users

Create Invite

Invite a user to your organization  <b><a target='_blank' href='https://evidence.dev/pricing'>Enterprise Only</a></b>

post/v1/workspaces/users/invites

Request

  • Base URL: https://management.evidence.studio
  • URL: https://management.evidence.studio/v1/workspaces/users/invites
  • Auth: one of:
    • API key in header Authorization
    • API key in cookie wos-session

Request body

emailstring email required

Email address of the person to invite

role'admin' | 'viewer' | 'external-viewer' | 'org-viewer' | 'developer' | 'member'

Role for the invitee once they join — must be external-viewer when the invite is pre-mapped to a customer

customerIdstring

Pre-map the invitee to this customer (group_...): the invitation is sent with role external-viewer and the invitee becomes a member of the customer immediately. Only external-viewer invites can be mapped to a customer.

expiresInDaysinteger

How many days the invitation stays valid

Example request

{
  "email": "jane.doe@acme.com",
  "role": "external-viewer",
  "customerId": "group_01J2ABC3DEF",
  "expiresInDays": 7
}

Response

Invite created

emailstring required

Email address the invite was issued to

rolestring required

Role the invitee will receive

inviteUrlstring required

The invite link — the same one delivered in the invitation email. Forward it in your own message if you want the invitee to have it from you as well.

Example response

{
  "email": "jane.doe@acme.com",
  "role": "viewer",
  "inviteUrl": "https://studio.example.com/invitation?invitation_token=YNfaBZ6lcuNlFVg4Wmzn8UTp7"
}

Changes

No recorded changes to this operation across all 1 revision of this API.