Create or update a single user with attributes, subscriptions, and identifiers

post

https://api.attentivemobile.com/v2/user/attributes

Creates or updates a single user record, including associated attributes, subscriptions, and identifiers. If a user with the provided identifiers already exists, their information will be updated; otherwise, a new user will be created.

There is a limit of 100 of custom attributes that can be created. If intending to update an existing attribute, the name of the key must match the name of the existing attribute. If an existing attribute does not exist, a new attribute will be created with the given key as the name. Attributes with enumerated values must have a value that matches an existing enum value; new enum values will not be created. Attempting to pass custom attributes as an array or a map such as ["New York City] or {"favorite city": "Boston"} will result in a 400 error.

Default Rate Limit: 150 requests per second

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

attributes

object

Personal details about the user. These attributes will take priority over custom properties. All fields are considered optional.

subscriptions

array of objects

An array of subscription details, defining how the user prefers to receive communications.

Notes:

A legal disclosure is required when a user is opted-in programmatically.
- For marketing messages, required legal language must be included.
- For transactional messages, you must include a transactional opt-in unit.
By default, if a subscription already exists, it will try and record the attempt to create the subscription again. For TEXT subscriptions, this may result in a message being sent to the person indicating that they are already subscribed.
Requests to opt-in subscribers must contain a sign-up source id.
- The unique identifier of a sign-up source can be found in the Sign-up Units tab of the Attentive platform in the ID column.
  If this value is provided in the request, then this sign-up unit will be used for opting in the user in the request.
Phone numbers must be submitted in e164 format.
- valid examples: +19148440001, +442071838750, +551155256325
- invalid examples: 19148440001, +1---914---844---0001, 1 () 914 844 0001

subscriptions

identifiers

object

Contains various identifiers used to uniquely identify the user.

Notes:

Sending duplicate values could lead to unintentionally bridging users together.
Don't use customIdentifiers to send attributes (e.g., first name, last name). To send those types of attributes, add to the attributes payload.
Avoid sending null values or empty strings. If you don't have a valid identifier, you should omit the field from the payload.

Responses

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

202Accepted