Skip to main content
POST

Authorizations

x-api-key
string
header
required

API key used to authenticate and authorise every request. Include it in the x-api-key header.

Headers

Accept
enum<string>
required

Defines the response type.

Available options:
application/vnd.Creative Force.v2.3+json,
application/vnd.Creative Force.v2.3+xml

Body

application/json

User create payload.

first_name
string
required

User's first name.

last_name
string
required

User's last name.

password
string
required

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.

email
string<email>
required

User's email address. Required if mobile is not set.

mobile
string

User's mobile number in E.164 international format, such as +14155552671. Required if email is not set.

roles
string[]

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.

preferences
object

User notification preferences.

user_fields
object

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 Location header 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 Location header is returned.

Detailed user fields returned only for a single user.

analytics_cookies
boolean

Specifies whether the user accepted analytics cookies.

broadcast_emails
boolean

Specifies whether the user accepted broadcast emails.

comments
string

Administrative notes recorded against the user, formatted for export.

confirmation
string

Account confirmation status of the user, such as Confirmed or Invited.

confirmed_at
string<date-time> | null

Date and time when the user confirmed the account. Value is null for an invited user who has not yet confirmed.

created_at
string<date-time>

Date and time when the user account was created.

created_by
string

Method by which the user account was created, such as manual or registration.

email
string<email> | null

Email address of the user. Value is null when no email address is recorded.

first_name
string

First name of the user.

language
object

Preferred language of the user.

last_name
string

Last name of the user.

marketing_cookies
boolean

Specifies whether the user accepted marketing cookies.

mobile
string

Mobile phone number of the user.

name
string

Full name of the user.

necessary_cookies
boolean

Specifies whether the user accepted necessary cookies.

notification_emails
boolean

Specifies whether the user accepted notification emails.

notification_sms
boolean

Specifies whether the user accepted notification text messages.

roles
object[]

Roles assigned to the user within the account.

slug
string

URL-safe identifier of the user.

updated
string<date-time>

Date and time when the user account was last updated.

preferences
object

Notification preferences selected by the user.

social_sharing
boolean

Specifies whether the user opted in to social sharing.

user_fields
object[]

Custom field responses captured on the user profile.