Update account settings

post

https://{youraccountname}.api-us1.com/api/3/settings/account

Update the settings of the user the API key belongs to, and the account wide date and time formats. This is the v3 replacement for the v1 settings_edit action, which wrote nothing but those formats.

The settings of the calling user (firstName, lastName, loginEmail, timezone, language) are required in every request: this endpoint writes the settings the request carries, so submit the values from GET /settings/account for the fields that should keep their value. The three formats are optional, and only an administrator may change them.

A successful request is a 202 reporting whether the update succeeded; it does not return the settings, so read them back with GET /settings/account. Invalid input is a 422.

❗️
Not /configs
The /configs endpoints are an internal store of per-user interface preferences. They hold none of these settings, and are not the v3 replacement for v1 settings_edit.

Body Params

firstName

string

required

The first name of the calling user. Required, and may not contain quotes.

lastName

string

required

The last name of the calling user. Required, and may not contain double quotes.

loginEmail

string

required

The email address the calling user signs in with, returned as email by GET /settings/account. Required, and has to be an address whose domain can receive email. Changing it to an address on an unverified domain sends a verification email and leaves the settings unchanged, reported as a 422; changing it is not allowed at all when the account signs in through SSO. When it changes, the user's other sessions are signed out.

notificationEmail

string

The address ActiveCampaign sends the calling user's notifications to. Optional, and has to be an address whose domain can receive email.

phoneNumber

string

The phone number of the calling user, returned as phone. Optional, and has to be a valid number in international format; a bare national number is a 422.

signature

string

The email signature of the calling user, which may contain HTML. Optional.

timezone

string

required

The timezone of the calling user. Required, and has to be a supported timezone.

language

string

required

The language the UI is shown in. Required, and has to be a supported language.

currentPassword

string

The calling user's current password, required only when newPassword is submitted.

newPassword

string

A new password for the calling user. Optional; when it is submitted it has to differ from the current password and satisfy the account's password policy.

dateFormat

string

The account wide date format, returned as date_format, as a PHP date format string. This is v1 settings_edit's dateformat. Optional, and only an administrator may change it; an empty or unsupported format is a 422.

timeFormat

string

The account wide time format, returned as time_format. This is v1 settings_edit's timeformat. Optional, administrator only.

dateTimeFormat

string

The account wide combined date and time format, returned as date_time_format. This is v1 settings_edit's datetimeformat. Optional, administrator only.

Responses

403

422

Language

Credentials

Header

URL

Loading…

Response

Choose an example:

application/json

202202