Create a user
Creates a user.
Authorizations
API key used to authenticate and authorise every request.
Include it in the x-api-key header.
Headers
Defines the response type.
application/vnd.Creative Force.v2.3+json, application/vnd.Creative Force.v2.3+xml Body
User create payload.
- Option 1
- Option 2
User's first name.
User's last name.
Password for the new user. The minimum length and complexity requirements are configured per account, so a value accepted on one account may be rejected on another.
User's email address. Required if mobile is not set.
User's mobile number in E.164 international format, such as +14155552671. Required if email is not set.
Role slugs to assign to the user. If omitted or empty, the default role for the account is assigned instead, so the user is never left without a role.
User notification preferences.
User field values, keyed by field slug. For example, { "fJkIjGmB": "Test value" }. Single-value fields take a string; multi-value fields, such as checkbox or multi-select, take an array of strings.
Response
User created, or an existing user added to the account.
Two outcomes share this status code:
- New user — a new user record is created. The body is the full user resource and the
Locationheader links to it. - Existing user — the email or mobile already belongs to a user on another account, so that user is added to the current account instead. The body is a confirmation message and no
Locationheader is returned.
- Option 1
- Option 2
Detailed user fields returned only for a single user.
Specifies whether the user accepted analytics cookies.
Specifies whether the user accepted broadcast emails.
Administrative notes recorded against the user, formatted for export.
Account confirmation status of the user, such as Confirmed or Invited.
Date and time when the user confirmed the account. Value is null for an invited user who has not yet confirmed.
Date and time when the user account was created.
Method by which the user account was created, such as manual or registration.
Email address of the user. Value is null when no email address is recorded.
First name of the user.
Preferred language of the user.
Last name of the user.
Specifies whether the user accepted marketing cookies.
Mobile phone number of the user.
Full name of the user.
Specifies whether the user accepted necessary cookies.
Specifies whether the user accepted notification emails.
Specifies whether the user accepted notification text messages.
Roles assigned to the user within the account.
URL-safe identifier of the user.
Date and time when the user account was last updated.
Notification preferences selected by the user.
Specifies whether the user opted in to social sharing.
Custom field responses captured on the user profile.