Unsubscribing a contact using API

Stores that are implementing a custom integration with Remarkety and would like to unsubscribe a contact using an API request, you can use the following method.

Make an HTTP POST request to the following URL:

https://app.remarkety.com/api/v1/stores/{store_id}/contacts/unsubscribe

The {store_id} parameter is found on your Settings -> API Keys page in Remarkety:

Required headers

Header name value
Content-Type application/json
x-token Get an API Key from the API Keys section on your account

 

Request body should have the following fields:

Field name Field type Required
email   Yes (one of email or sms_phone_number_e164 should be used)
sms_phone_number_e164   Yes (one of email or sms_phone_number_e164 should be used)
reason string No - provide more info on the reason of unsubscribe

 

Examples:

Example for unsubscribing an email address:

{
      "email": "example@example.com",
      "reason": "asked support agent to unsubscribe"
}

Example for unsubscribing an SMS phone number:

{
      "sms_phone_number_e164": "+12021234567",
      "reason": "asked support agent to unsubscribe"
}

Example for unsubscribing both an email address and an SMS phone number at the same time: 

{
"email": "example@example.com",
      "sms_phone_number_e164": "+12021234567",
      "reason": "asked support agent to unsubscribe"
}

 

Was this article helpful?
0 out of 0 found this helpful

Comments

0 comments

Article is closed for comments.