Update a user
Updates the user identified by the specified slug.
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 Path Parameters
User slug
^[A-Za-z]{8}$Body
User update payload.
User's first name.
User's last name.
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.
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.
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.
Array of role slugs.
User notification preferences.
Cookie consent preferences. Applied only on accounts where cookie consent is enabled.
User field values, keyed by field slug. For example, { "fJkIjGmB": "Test value" }.
Response
User updated.
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.