Accept user invitation
<Info icon="fa-light fa-lock-open" className="permission-callout">
<div className="permission-callout__header"><span className="permission-callout__title"><span className="permission-callout__label">Required permissions</span> <span className="fern-docs-badge small blue subtle rounded-full permission-callout__beta">Beta</span></span> <span className="permission-callout__learn-more">[Learn more](/developers/api-guidelines/permissions#how-permissions-work)</span></div>
Public endpoint. No permission required.
</Info>
Accepts a user invitation to join a Workspace.
The following fields may be provided:
- `activationKey` (String, required) - the JWT token received in the verification email
- `password` (String) - only mandatory if the user is invited to an organization without single sign-on (SSO) and doesn't have a password yet
- `name` (String) - name of the user
Authentication
AuthorizationBearer
An auth_token should be provided to authenticate a session.
To obtain an auth_token, see the /api/v1/authenticate POST request.
Request
This endpoint expects an object.
activationKey
password
name
Response
User successfully accepted the invitation
Errors
403
Forbidden Error