Skip to main content
POST
Create a profile
Creating a profile is the first of two steps. No assessment invite is sent by this endpoint. Once you have the profile.id, deliver the assessment with Send Invite by Email, Send Invite by SMS, or Get Assessment Link.

Authorizations

Authorization
string
header
required

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

Body

application/json

The contact details and metadata for the profile. At least one of email or phone is required.

email
string<email>

The email address of the individual. Stored in lowercase. Required if phone is not provided, and required to send email invites. A value that is not a valid email address rejects the request with 400.

Example:

"hello@profilebehavior.com"

phone
string

The individual's mobile phone number. E.164 format is recommended; other formats are parsed with US as the default region and stored in E.164. Required if email is not provided, and required to send SMS invites. A number that cannot be parsed as a valid phone number is ignored, so a request with an invalid phone and no email is rejected with 400.

Example:

"+15555550123"

tags
string[]

IDs of tags on your account to apply to the profile. Every ID must belong to your account or the request is rejected.

Example:
customId
string

A custom identifier to apply as an alias for the profile. This creates a Resource Alias with the provided customId as the alias and the profile's ID as the resourceId. Sending the same customId again for the same profile reuses the existing alias.

Example:

"employee-1042"

Response

OK - a profile already existed for the provided contact details and was updated. The profile is the full Profile when the individual has already consented to sharing their data with your account; otherwise it is the partial CreatedProfile.

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

The partial profile returned by POST /profile for a newly created profile, or for an existing profile whose behavioral data has not yet been shared with your account. It contains contact details and assessment progress only; no scores are included until the individual consents to sharing their data with your account.