Skip to main content
POST
/
assessment-invite
Create or fetch an assessment invite link matching the provided parameters
curl --request POST \
  --url https://vanguard.profilebehavior.com/api/v4/assessment-invite \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "tags": [
    "<string>"
  ],
  "customId": "<string>"
}
'
{
  "code": 200,
  "link": "https://next.assesslink.co/a/aabbc",
  "status": "success"
}
If a customId is applied to an Assessment Invite, that ID will be applied to all profiles using that link.
This endpoint serves to create unique links for participants to take the Profile assessments. Links can optionally be pre-loaded with tags, to categorize and group profiles together, as well as a custom ID which is applied to all profiles completing the assessments using that link.

​
Why It’s Important

  • This endpoint is crucial for the collection of profile reports, categorizing profiles, and applying external IDs.

Authorizations

​
Authorization
string
header
required

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

Body

application/json

The properties that should be associated with the assessment invite.

​
tags
string[]

An array of tag IDs that will be applied to any profile that uses the link to take an assessment.

​
customId
string

A custom identifier that can be used to apply a unique foreign key to any profile that uses the link to take an assessment.

Response

Success

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
​
link
string

A generated assessment invite link that can be used by an individual to create a profile and take the assessment. Any tags or custom IDs submitted with the request are automatically applied to profiles using the link.