Sign in
latestOpenAPI 3.1.02026-08-085123123.9 KB

bf0b51ee8e8a

Batches

Add a batch

Submit a batch for processing. Batches can be of three types: addMembers, unsubscribe, and deleteMembers.

Batch type: unsubscribe

Provide a list of member IDs (integer) or email addresses (string) to unsubscribe.

Batch type: deleteMembers

Provide a list of member IDs (integer) or email addresses (string) to delete.

Batch type: addMembers

Add or update members in bulk. Key behaviors:

  • If a member already exists, it is updated with the provided information.
  • If a field is empty and data already exists for that field, the existing data is kept.
  • To explicitly clear a field, use the special string __EMPTY__.
  • All submitted members will be added to the specified groups (in addition to any existing group memberships).
  • The relationType field is required and accepts: express-consent, active-clients, information-request, business-card, web-contacts, purchased-list, contest-participants, mixed-list, inactive-clients, association-members, employees, partners.
post/batches

Request body

OR
OR

Example request

{
  "batchType": "unsubscribe",
  "ids": [
    1,
    2,
    3,
    "test@example.org",
    "foo@bar.com"
  ]
}

Response

The newly created batch (status will be NEW until processed)

idinteger
batchTypestring
batchJsonobject
createdOnstring
statusstring

NEW, PROCESSING, or COMPLETED

Example response

{
  "id": 176,
  "batchType": "unsubscribe",
  "batchJson": {
    "batchType": "unsubscribe",
    "ids": [
      1,
      2,
      3
    ]
  },
  "createdOn": "2015-10-28 11:55:56.217",
  "status": "NEW"
}