Processed Campaign Customers

Time	Status	User Agent
Retrieving recent requests…

Rate Limit

This endpoint is subject to the general API rate limit of 50 requests per 10 seconds. Learn more about handling rate limits.

Query Parameters

Parameter	Type	Required	Default	Max	Description
CampaignID	int32	Yes	—	—	The action serial of a specific scheduled campaign occurrence. Obtained from the Optimove campaign scheduling system in the Webhook payload
CustomerAttribute	string	No	—	—	Comma- (or delimiter-) separated list of customer attribute names to include in the response. Attribute values are returned in the `Attributes` field. Invalid attribute names are silently ignored; if none of the requested attributes are valid, `Attributes` is `null`
CustomerAttributeDelimiter	string	No	`;`	—	The delimiter used to separate attribute names in the `CustomerAttribute` parameter
top	int32	No	10,000	200,000	Maximum number of customers to return per page
skip	int32	No	0	—	Number of customers to skip (offset for pagination)

Response Fields

Field	Type	Nullable	Description
CustomerID	string	No	The identifier of a customer in your customer database
PromoCode	string	No	The promotion code assigned to this customer for this campaign. Empty string if none assigned
ActionId	int32	No	The action ID associated with this customer in the campaign
ChannelIds	array of int32	Yes	The execution channel identifiers configured for this campaign. `null` if no channels are configured
Attributes	object	Yes	Key-value map of customer attribute values requested via the `CustomerAttribute` parameter. `null` if no attributes were requested or none are valid. Campaign Execution 2.0: values preserve their original types (strings, integers, floats, booleans, etc.). Legacy: all values are returned as strings regardless of the underlying type

Error Responses

Status Code	Condition	Retryable
400 Bad Request	The campaign occurrence does not have Conditional Execution enabled	No
400 Bad Request	The Conditional Execution window has expired	No — the window is permanently closed
400 Bad Request	All requested attributes are invalid	No
404 Not Found	The campaign occurrence was not found	No
500 Internal Server Error	Unexpected server-side failure	Yes

Sample Request

GET /current/customers/GetProcessedCampaignCustomers
? CampaignID = 6577
& CustomerAttribute = Name,Email,Age
& CustomerAttributeDelimiter = ,
& skip = 0
& top = 100

Sample Response (200 OK)

[
  {
    "CustomerID": "tester1",
    "PromoCode": "promotion1",
    "ActionId": 123,
    "ChannelIds": [
      22,
      15
    ],
    "Attributes": {
      "Name": "John Doe",
      "Email": "[email protected]",
      "Age": 34
    }
  },
  {
    "CustomerID": "tester2",
    "PromoCode": "promotion1",
    "ActionId": 123,
    "ChannelIds": [
      22,
      15
    ],
    "Attributes": {
      "Name": "Jane Doe",
      "Email": "[email protected]",
      "Age": 28
    }
  }
]

Sample Response (400 Bad Request) — expired campaign window

Campaign execution window has expired.