Invite a user

Emails an invitation to join the workspace and returns the outcome as a JSON:API resource. Inviting someone with a pending invitation resends it, and inviting an existing member sends nothing and returns a `null` id.

Authorization

bearer

AuthorizationBearer <token>

User access token authentication for endpoints that act across workspaces. Send a WorkOS access token in the Authorization header as: Bearer <token>.

In: header

Path Parameters

workspace*string

The workspace slug — the {slug} segment of your Clarify workspace URL.

Query Parameters

silent?boolean

When true, suppresses in-app and Slack notifications for this mutation.

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

data*

The resource to create.

Response Body

`application/json`

curl -X POST "https://example.com/workspaces/string/invitations" \  -H "Content-Type: application/json" \  -d '{    "data": {      "type": "invitation",      "attributes": {        "email": "jane@acme.com"      }    }  }'

{  "data": {    "type": "invitation",    "id": "invitation_01HXYZACMEJANEDOE00000000",    "attributes": {      "id": "invitation_01HXYZACMEJANEDOE00000000",      "invitee_email": "jane@acme.com",      "message": "Invitation sent to jane@acme.com"    }  }}