Opt Out Offer

Opt-out Offer

post

Record when a customer declines an event ticket protection offer.

Authorizations

AuthorizationstringRequired

Composite Authentication Scheme (Client Key, Date, and Signature)

Requires three mandatory headers in every request:

1. X-Api-Key (Client Key)

• Purpose: Public identifier for the API consumer.

2. Date (Timestamp)

• Purpose: Timestamp used for generating the signature and preventing replay attacks.
• Format: RFC 7231 format (e.g., in GMT).

3. Authorization (Computed Signature)

• Purpose: Cryptographic signature that verifies the request's authenticity and integrity.
• Format: SIGNATURE [authHeader]

The authHeader value is derived from a cryptographic hash (e.g., HMAC-SHA256) of canonical request components (HTTP Method, Path, and the contents of the Date header), signed with the private Client Secret.

Path parameters

partner_codestringRequired

offer_idstringRequired

Responses

204

No Content - Opt-out recorded successfully

No content

403

Forbidden

application/json

404

Not Found

application/json

post/partners/{partner_code}/offers/{offer_id}/opt_out/

POST /x/partners/{partner_code}/offers/{offer_id}/opt_out/ HTTP/1.1
Host: api.xcover.com
Authorization: YOUR_API_KEY
Accept: */*

No content