Users
Invite a user
Sends an invitation to a user to join the organization or profile with a specific role. Requires admin role. The user will receive an invitation email with a token to accept. Invitation tokens expire after 7 days.
post/v3/users
Headers
Idempotency-Keystring
Unique key to ensure idempotent request processing. Must be 1-255 alphanumeric characters, hyphens, or underscores. Responses are cached for 24 hours per key per customer.
x-profile-idstring uuid
Profile UUID to scope the request to a child profile. Only organization API keys can use this header. The profile must belong to the calling organization.
Request body
Example request
{
"email": "newuser@example.com",
"name": "New User",
"role": "developer",
"sandbox": false
}Response
User invited successfully