Skip to main content
POST
Send an assessment invite by email
Create the profile first with Create Profile. Creating a profile does not send anything; this endpoint delivers the assessment.

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

profileId
string
required

ID of the profile to invite.

Response

Success - the invite email was sent.

Standard response object for successful single-resource requests in the Profile Behavior API. Contains an HTTP status code, the returned resource data, and a status indicator.

code
integer<int32>
required

HTTP status code of the successful response.

status
enum<string>

Always "success" for successful responses.

Available options:
success