Update or alert customers

Use this endpoint to send an update to or to alert customers about topics that they have subscribed to.

Try it out

  1. Add the User API key as the Username and leave the Password field blank.
  2. Click the Base URL dropdown and select the API endpoint URL for your Blueshift region.
  3. Click Try It.

You can also try the API using Blueshift's API collection in Postman.

ℹ️

Note

Use the metadata parameter to add custom attributes to provide more information about the update. For example, city, discount, coupon code, and so on.

Body Params

Update customers about a topic that they have subscribed to.

string
required

Specify the name of the event for which the alert is being sent.

string
required

Specify the topic that the alert is for.

string
required

Specify the email address for the author of the alert.

metadata
object
required

Specify the metadata attribute name and value for the topic.

Responses

422

Unprocessable Entity - Some/all of the products have invalid data, please check the response for more information on.

429

Rate limit exceeded - Too many requests

500

Internal Server Error - Please contact blueshift for more information

502

Service unavailable, please retry - Bad Gateway, re-try with exponential backoff

503

Service unavailable, please retry - Service Unavailable, re-try with exponential backoff

504

Service unavailable, please retry - Gateway Timeout, please re-try with exponential backoff

Language
Credentials
:
URL
Click Try It! to start a request and see the response here! Or choose an example:
application/json