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 User access token authentication. Every endpoint accepts it, and endpoints that act as a person accept only it. Send a WorkOS access token in the Authorization header as: Bearer <token>.
In: header
Path Parameters
The workspace slug — the {slug} segment of your Clarify workspace URL.
Query Parameters
When true, suppresses in-app and Slack notifications for this mutation.
Header Parameters
The API version for this request. Send 2026-10 to get the behavior documented here. Omit it to use your API key's version, which this header can raise but not lower.
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
curl -X POST "https://example.com/workspaces/string/invitations" \ -H "clarify-version: 2026-10" \ -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" } }}