Replace

See create to see an introduction about Audience API.

API Description

Replace

post

Replace all audience users. It removes all previously added users and adds the given ones.

Authorizations

Header parameters

X-Batch-Projectstringrequired

The unique project key, identifying a project on the Batch platform

Example: project_0664hxvwffvbpn278gxdyhsadddqgna6

Body

namestringrequired

The name of the existing audience you want this operation to be applied to.

idsobject[] · max: 10000required

An array of objects describing ids to be added to the audience.

Responses

application/json

objectoptional

application/json

application/json

application/json

application/json

application/json

post

HTTPcURLJavaScriptPython

POST /2.4/audiences/replace HTTP/1.1
Host: api.batch.com
Authorization: Bearer YOUR_SECRET_TOKEN
X-Batch-Project: text
Content-Type: application/json
Accept: */*
Content-Length: 318

{
  "name": "AUDIENCE_NAME",
  "ids": [
    {
      "id": "CUSTOM-ID-1",
      "attributes": {
        "att1": 3,
        "att2": "string",
        "date(att15)": "2023-08-12T22:30:05Z",
        "url(att20)": "https://example.com/image.jpg"
      }
    },
    {
      "id": "CUSTOM-ID-2",
      "attributes": {
        "att1": 2,
        "att2": "string",
        "date(att15)": "2023-08-12T22:30:05Z",
        "url(att20)": "https://example.com/image.jpg"
      }
    }
  ]
}

{
  "indexing_token": "text"
}

Request structure

Route

The Audience API exposes a POST endpoint that allows to replace all audience profiles. It removes all previously added profiles and adds the given ones:

https://api.batch.com/2.4/audiences/replace

Headers and authentication

See Overview → Using Project APIs.

Post data

The body of the request must contain a valid JSON payload describing the operations to be executed on the audience.

Here is a how a complete JSON payload looks like:

{
  "name": "AUDIENCE_NAME",
  "ids": [
    {
      "id": "INSTALL-ID-1",
      "attributes": {
        "att1": 3,
        "att2": "string",
        "date(att15)": "2012-08-12T22:30:05"
      }
    },
    {
      "id": "INSTALL-ID-2",
      "attributes": {
        "att1": 2,
        "att2": "string",
        "date(att15)": "2013-08-12T22:30:05"
      }
    }
  ]
}

NOTE: If multiple actions are given for the same ID, only the last one will be taken into account.

Responses

Success

If the POST to the API endpoint is successful you will receive an HTTP 202 confirmation and a token.

{
  "indexing_token": "a0082dc6860938a26280bd3ba927303b"
}

Once you get your token, you can use it to check the indexing state of this update with the API.

Failure

If the POST data does not meet the API requirements you will receive an actionable error message. Contact us at [email protected] if you need further support.

See the list of potential failures in the API Description.

Processing time

While the indexation of IDs is usually done in real time, we offer no guarantees. If you send a campaign right after the audience creation, you might end up with a campaign targeting nobody. A call to the view action with the indexing token replies with an APPLIED indexing state if the processing is finished (and IN_PROCESS if it is still ongoing).