Skip to main content
POST
Unsubscribe a Recipient

Description

Unsubscribe a recipient by its url hash where unsubscribeUrlHash value in url is the unsubscribeUrlHash for the campaign recipient that wants to unsubscribe.

Validations

  • If unsubscribeUrlHash is not present an error with 400 status code will be returned.
  • If the captchaValue is not present in request body it will return an error with 400 status code.
  • If campaign recipient is not found it will return an error with 404 status code.

Response

No response with a 204 status.

Body

The body for the request is an object that contains the properties captchaValue that is the token generated by google recaptcha.

Authorizations

Authorization
string
header
required

Access token obtained from the m2m-token endpoint.

Headers

Authorization
string
required

Body

application/json

The body is of type object.

Response

Successful response