Update Customer Promotion Status

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.

Notes

A maximum of 10,000 customer IDs may be included in one call.
This function may be called as many times as required.
The campaign will only be sent to customer IDs with Status set to true; if this function never receives a customer ID, it is the same as if it was sent with Status set to false.
Once the campaign's specified ClearanceRequiredBy time arrives, Optimove will schedule the campaign for execution only to those customer IDs for which PromosUpdated was specified as true using this API call by that time. For more information about this process, click here.

Request Fields

Field	Type	Required	Description
TimeStamp	string or null	No	Timestamp of the update (ISO 8601 format). Can be null
CampaignID	int32	Yes	The campaign occurrence identifier — must match a `CampaignID` returned by `GetProcessedCampaignCustomers`
PromosUpdated	array of objects	Yes	List of customer approval decisions. Maximum 10,000 items per request
PromosUpdated[].CustomerID	string	Yes	The customer identifier — must match a `CustomerID` returned by `GetProcessedCampaignCustomers`
PromosUpdated[].Status	boolean	Yes	`true` = customer is approved for campaign execution; `false` = customer is rejected

Error Responses

Status Code	Condition	Retryable
400 Bad Request	`PromosUpdated` contains more than 10,000 items	No
400 Bad Request	The campaign execution window has expired	No — the window is permanently closed
400 Bad Request	Request body is invalid	No

Sample Request

{
  "TimeStamp": "2018-10-27 09:33:00",
  "CampaignID": 1359,
  "PromosUpdated": [
    {"CustomerID": "C234638", "Status": true},
    {"CustomerID": "C984571", "Status": true}
  ]
}

Sample Response (200 OK)

(empty body)

Sample Response (400 Bad Request) — expired campaign window

Campaign execution window has expired.