v1
latestOpenAPI 3.0.32026-07-24235275.4 KBCreate or update a single user with attributes, subscriptions, and identifiers
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
Request body
Example request
{
"attributes": {
"firstName": "John",
"lastName": "Smith",
"demographic": {
"language": "English/American",
"dateOfBirth": "2022-11-08",
"age": 29,
"organization": "Acme Sports",
"title": "Mr",
"website": "http://johnsmith.com"
},
"location": {
"address1": "456 Elm Avenue",
"address2": "Suite 300",
"city": "Brooklyn",
"state": "NY",
"zip": "11222",
"latitude": "40.730610",
"longitude": "-73.935242",
"country": "US",
"region": "AU-NSW",
"timezone": "EST"
},
"locale": {
"language": "French",
"country": "CA"
},
"custom": {
"lucky number": 6,
"favorite color": "green",
"has pets": true
}
},
"subscriptions": [
{
"signUpSourceId": "string",
"channel": "TEXT",
"singleOptIn": true
}
],
"identifiers": {
"email": "jsmith@attentive.com",
"phone": "+15008675309",
"shopifyId": "345678901",
"klaviyoId": "a1b2c3d4e5f6a7b8c9d0e1f2",
"clientUserId": "freeform-client-id",
"customIdentifiers": [
{
"key": "loyalty_points_id",
"value": "ADFK4D7D"
}
]
}
}Response
Accepted