Skip to main content
PUT

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

Path Parameters

user_slug
string
required

User slug

Pattern: ^[A-Za-z]{8}$

Body

application/json

User update payload.

first_name
string

User's first name.

last_name
string

User's last name.

password
string

New password for the user. The minimum length and complexity requirements are configured per account. A user who belongs to more than one account cannot have their password changed through this endpoint. If the user owns an account, only that same user can change the password.

email
string<email>

User's email address. Must be unique across all users; the request is rejected if another user already uses it. A user who belongs to more than one account cannot have their email address changed through this endpoint. If the user owns an account, only that same user can change the email address.

mobile
string

User's mobile number in E.164 international format, such as +14155552671. Must be unique across all users; the request is rejected if another user already uses it. A user who belongs to more than one account cannot have their mobile number changed through this endpoint. If the user owns an account, only that same user can change the mobile number.

roles
string[]

Array of role slugs.

preferences
object

User notification preferences.

cookies
object

Cookie consent preferences. Applied only on accounts where cookie consent is enabled.

user_fields
object

User field values, keyed by field slug. For example, { "fJkIjGmB": "Test value" }.

Response

User updated.

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.