Accept a user invitation
POST
/users/{user_id}/invite/consume Accepts the invitation sent with Invite a user to set a password and sets the user's first password.
Pass the inviteCode from the invitation URL together with the tokenized password. Check the invite
is still valid first with Validate a user's invite, so
the user doesn't fill in a form for an expired link.
Request
Available on
SandboxProduction
Header parameters
Path parameters
Request body
*application/json
objectobject · 3 fields
Responses
200OK
Success
Headers
Body
application/json
TokenResponseTokenResponse · object · 1 field
Response example
{ "token": "eyJraWQiOiJnZW5lcmF0b3IiLCJhbGciOiJFUzI1NiJ9.eyJzdWIiOiJST09ULDk4NzY1NDMyMSJ9.1KnuaBkSX_YfempeNMkUbxkkXsNz65-lQQXAhXrhiEI"}