Set Custom Attributes for a User

Adds or updates custom attributes for a user

Setting attribute values

  • Pass a raw JSON body of { "attributes": { "API_Name": (new value) } }
  • You can set as many different attributes as you want at one time.

Sending Date values

When updating a Date type custom attribute, for this endpoint, please be aware of these formatting rules:

Standard Formats

Recommended: Use ISO8601 date format as a string: "2024-12-31"

  • {
      "attributes": {
      	dateOfBirth: "2024-12-31"
      }
    }
  • You can also use the above with slashes instead of the standard - : "2024/12/31"

Integer format (Deprecated):

  • EPOCH in miliseconds: e.g.1735678800000 passed as an integer in the JSON
  • Please note that this is not an ideal way to send a Date, because an Epoch represents a specific single moment in time, and when the application converts that to a calendar date, that could be one of two dates depending on which time zone we are interpreting the timestamp in. Many times in the day correspond to say, a Saturday in London, and a Friday in California. Our servers are in the UTC time zone (roughly corresponding to London time in the winter), so if you send this format, the date saved will reflect what calendar date it was in UTC when that moment took place.

Custom Formats (requires configuration by Support)

If you have a need for one of the below custom input formats, have the support team set one of these custom import formats for the field(s) where you need it.

  • Available Formats:
    • MM/DD/YYYY -- e.g. "12/31/2024"
    • DD/MM/YYYY -- e.g. "31/12/2024"
  • Once we have customized the import format for a field for you, you will need to always use the agreed-upon format for that field, unless you pass another key "skip_formatting": "true" at the top level of the object. If you pass this key, this reverts the processing to expect one of the Standard Formats (that is, "2024-12-31"or the integer format)

Example:

{
  "skip_formatting": "true",
  "attributes": {
  	dateOfBirth: "2024-12-31"
  }
}
Path Params
int32
required

ID to set attributes for

Body Params
json
Defaults to {}

Key attributes is required and is a dictionary of your attribute 'api names' → value

Responses

Language
Credentials
Header
LoadingLoading…
Response
Choose an example:
application/json