Ingest recall contacts

Accepts a batch of customers affected by a product recall and asynchronously triggers the
configured recall Journey for each accepted recipient.

Recipients are validated synchronously against known customers under the given brand. Valid
recipients are accepted and queued for asynchronous Journey triggering; invalid recipients are
reported in rejected_recipients.

Required fields:

  • recall_id
  • journey_id
  • brand
  • reason_for_recall
  • recipients

Up to 200 recipients are accepted per request; larger lists must be split across multiple
calls.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

Scope

erc-ecommerce-recall:write

Body Params

Recall Contacts Request.

The recall contacts request body.

string
required
length ≥ 1

The unique identifier of the recall.

string
required
length ≥ 1

The identifier of the published Journey to trigger for each recipient.

string
required
length ≥ 1

The brand associated with the recall.

string
required
length ≥ 1

A short, customer-facing description of why the product is being recalled.

recipients
array of objects
required
length between 1 and 200

The list of customers affected by the recall.

recipients*

A single recipient and the recalled orders associated with them.

contact
object
required

The recipient's contact information.

orders
array of objects
required
length ≥ 1

The recalled orders associated with this recipient.

orders*

A recalled order line associated with a recipient.

string
required
length between 1 and 255

The SKU of the recalled product.

string
length between 1 and 255

The unique identifier of the order.

string
length between 1 and 255

The unique identifier of the product.

string
length between 1 and 255

The name of the recalled product.

string
length between 1 and 255

The customer-facing order number.

date-time
length between 1 and 50

The date and time the order was placed.

Responses

Language
Credentials
OAuth2
Missing 1 required scope
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json