Custom Attributes

Use the Custom Attributes API to apply customizable data or characteristics to each of your subscribers. You can then build segments based on that information to send targeted campaigns and journeys.

Custom Attributes

Make a call to this endpoint for any attribute-based data. There are no limits to the amount of custom attributes that can be created. Note that you can create net-new properties with this API, however, it cannot be used to create new values for an existing UI-created property name. If a property name is created through the Attentive platform, all possible property values must also be defined in the platform.

Request
Security:
OAuthFlow (attributes:write)
Request Body schema: application/json
properties
required
object

Any metadata associated with the attribute. Object keys are expected to be strings. Object values can be any type. Both object keys and object values are case sensitive. "Favorite color" and "Favorite Color" would be considered different custom attributes.

required
object (EventUser)

User associated with the action. Note that this is a visitor to the site and does not need to be actively subscribed to Attentive.

Responses
200

Ok

400

Invalid parameter in request query or body

401

Unauthorized

403

Access Denied

404

The specified resource was not found

429

The user has sent too many requests in a given amount of time

500

Internal Server Error

post/attributes/custom
Request samples
application/json
{
  • "properties": {
    },
  • "user": {
    }
}