Bulk User Attributes

This endpoint allows clients to submit multiple user attribute updates in bulk, accepting up to 256 payloads per request. Each request is validated, and a unique batch ID is returned for tracking the status of the batch.

Each individual record must not exceed 1 MiB (1,048,576 bytes). Records that exceed this limit are rejected with a 413 in the job results and are not processed.

Scopes Required: [attributes:all, subscriptions:all]

Default Rate Limit: 100 requests per second

post/v2/bulk/user/attributes

Request

Base URL
https://api.attentivemobile.com
Auth
- HTTP bearer
- or OAuth 2
  Authorization code: https://ui-devel.attentivemobile.com/integrations/oauth-install?client_id={clientId}&redirect_uri={redirectUri}&scope={scope}
  Token URL: https://api.attentivemobile.com/v1/authorization-codes/tokens scopes: attributes:write, subscriptions:write

Headers

Authorizationstring required

Authorization for the request

Request body

Example request

{
  "users": [
    {
      "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

The bulk job request was successfully received and accepted for asynchronous processing. The response includes a batchJobId to track the status of the job, along with a confirmation message. Processing has not yet completed, please use the job status endpoint to monitor progress and retrieve results once available.

messagestring

A human-readable message confirming that the bulk job was successfully submitted.

batchJobIdstring

A unique identifier representing the submitted batch job. Use this ID to query the job's status, retrieve results, or diagnose any errors related to the job. This ID is returned upon successful job submission and required for all follow-up actions related to the batch.

Changes

No recorded changes to this operation across all 2 revisions of this API.