Invite User

POST 
/api/content/:contentType/invitations/:key

Invite a user to access or edit a content object.

You can find more information about invitations and content here.

Locale

A locale can be specified for this request. The email will be sent in the specified locale. You can learn more about locale in emails here.

If no locale is specified, the applications default locale will be used. You can learn more about configuring the default locale here.

Tokens

• A valid AccessToken with MAINTAINER access on this object is required.

Request

Responses

200

The content object the user was invited to. The response depends on the content object. For articles it will return FullArticleResponseand for file metadata it will return FileMetadataResponse.

401

The following error codes correspond to this status:

• ACCESS_TOKEN_EXPIRED: Indicates that the access token is expired.
• ACCESS_TOKEN_INVALID: Indicates that the access token cannot be decoded.
• AUTHENTICATION_REQUIRED: User is not authenticated.

403

The following error codes correspond to this status:

• NOT_AUTHORIZED: Action not authorized.

404

The following error codes correspond to this status:

• USER_NOT_FOUND: User not found.
• CONTENT_TYPE_NOT_FOUND: Content type not found.
• CONTENT_NOT_FOUND: Content not found.

500

The following error codes correspond to this status:

• ACCESS_TOKEN_ALLOWLIST_READING_FAILURE: Represents an exception indicating a failure when reading the allowlist for an access token cache.
• DATABASE_FAILURE: Exception representing a general failure related to database operations.
• DATABASE_ENCRYPTION_FAILURE: Exception representing a general failure related to database encryption operations.
• EMAIL_AUTHENTICATION_FAILURE: Thrown when there is a failure related to email authentication.
• INVALID_DOCUMENT: Invalid document.
• INVITATION_TOKEN_CREATION_FAILURE: Represents an exception that occurs during the creation of an invitation token.
• POST_COMMIT_SIDE_EFFECT_FAILURE: Exception representing a failure to perform a side effect after a successful database operation.
• EMAIL_SEND_FAILURE: Represents an exception that occurs when an email cannot be sent.
• EMAIL_TEMPLATE_FAILURE: Thrown when there is a failure related to email template creation.

503

The following error codes correspond to this status:

• EMAIL_DISABLED: Thrown when email functionality is disabled in the application.