Skip to main content
POST
/
profile
Create a new profile by sending an invite to the provided email
curl --request POST \
  --url https://vanguard.profilebehavior.com/api/v4/profile \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "email": "[email protected]",
  "customId": "<string>"
}
'
{
  "code": 200,
  "tag": {
    "email": "[email protected]"
  },
  "status": "success"
}
Note: Sending an assessment invite is done after creating a new profile resource.

Authorizations

​
Authorization
string
header
required

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

Body

application/json

The properties to be assigned to the new profile.

​
email
string
required

The email which will be associated with the profile.

Example:

"[email protected]"

​
customId
string

A custom identifier that can be used to apply a unique foreign key to the profile. This creates a Resource Alias object with the provided customId being the consumerKey and the resourceId being the ID of the newly created profile.

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
​
profile
object

Represents an account assessment invite for an individual.