Update Customer Attributes

Rate Limit

This endpoint is subject to the general API rate limit of 50 requests per 10 seconds. Learn more about handling rate limits.

Notes

• Attributes are identified by their RealFieldName values. You can retrieve all available customer attribute names and a description of each using the GetCustomerAttributeList function or by accessing the Customer Attributes list in Optimove’s interface and exporting the list.
• Attribute values supplied in this call overwrite any previous values in the database.
• Each call may include up to 1,000 customer IDs, with a maximum of 10 attributes per customer ID.
• To avoid high volumes of these requests, which may result in delays, it is recommended only to use this call for specific customer attributes based on your use cases.
• If a Callback URL was defined, you would receive the following response to the Webhook up to 1 minute after the call:
  • IsSuccess: true or false
  • Request ID
  • Error in case of failure. The error will consist of error details, customer id, and real field name. Possible values for Error in the response:
    • 1:“INVALID_CUSTOMER” = Specified CustomerID does not exist
    • 2:“INVALID_FIELD” = Specified RealFieldName does not exist
    • 3:“INVALID_VALUE” = Specified value is invalid
    • 4:“UPDATE_FIELD_TEMPORARY_UNAVAILABLE” = This attribute must be enabled by support to allow updates. Please contact Optimove's support team for assistance.
• Please note that this API call was previously accessed by a different request and responded differently, with a different logic. Starting in June 2023, this API call will support only the documented way.

Examples for reference:

{"isSuccess":false,"errors":[{"error":"UPDATE_FIELD_TEMPORARY_UNAVAILABLE","customerId":"1289049",
"realFieldName":"DaysSinceFirstAbsGameDate"}],"requestId":"77e34963-8142-4fde-a403-ebe03feec41e"}

{"isSuccess":true,"requestId":"0386932e-db94-4567-9d38-76d98ce50e4a"}

Error Handling

Errors while using this endpoint typically occur due to invalid input or schema violations, such as:

• Field values exceeding maximum length or precision.
• Providing unsupported or incorrect data types.
• Missing required attributes.

To understand these errors and how to resolve them, visit the Error Handling Page.

Sample Request

{
  "CustomerNewAttributesValuesList": [{
    "CustomerID":"0192837821",
    "Attributes":[{
      "RealFieldName":"FavoriteColor",
      "Value":"Orange"
      },
      {"RealFieldName":"Rank",
      "Value":"Gold"
      }]
  }]
  "CallbackURL":"https://tenantname.requestcatcher.com/test"
}