# Opt-out Offer

The Offer opt-out workflow describes the API call that must be made when an Offer is offered but not selected by the customer.

The purpose of utilising the opt-out workflow is so Cover Genius can demonstrate conversion rate to the regulators ensuring the product and pricing is fit for purpose. It also enables XCover machine learning platform Brightwrite to deliver the optimal products at the optimal prices.

<figure><picture><source srcset="/files/RWspiQHeXhmBiTql66Hs" media="(prefers-color-scheme: dark)"><img src="/files/di4aNd3aWj2G4Efl1lYj" alt=""></picture><figcaption><p>Opt-Out Workflow</p></figcaption></figure>

### Purpose

Utilizing the opt-out workflow serves two critical functions:

1. **Regulatory Compliance** - Enables Cover Genius to demonstrate conversion rates to regulators, ensuring the product and pricing is fit for purpose
2. **Platform Optimization** - Powers XCover's machine learning platform BrightWrite to deliver optimal products at optimal prices through data-driven insights

### When to Use Opt-out

Call this endpoint when:

* An Offer has been presented to the customer (via Create Offer endpoint)
* The customer has chosen NOT to purchase the Offer
* You need to record the customer's decision to decline coverage

### Making an Opt-out Request

#### Path Parameters

* `partner_code` - Your partner identifier
* `offer_id` - The Offer ID from the Create Offer response that was declined

#### Request Body

The request body is optional and can include:

* `partner_metadata` - Additional metadata about the opt-out decision
* Custom fields as defined by your integration

### Response

* **HTTP 204 No Content** - Opt-out successfully recorded
* **HTTP 403 Forbidden** - Authentication or authorization error
* **HTTP 404 Not Found** - Offer not found

### Important Notes

> **Regulatory Requirement:** Recording opt-outs is essential for demonstrating that insurance offerings are presented fairly and that pricing is appropriate for the market.

> **Data Analytics:** Opt-out data feeds into BrightWrite's machine learning algorithms to continuously improve product offerings and pricing strategies.

> **No Impact on Customer:** Calling this endpoint does not affect the customer in any way - it simply records their decision for analytics and compliance purposes.

### Best Practices

* Call this endpoint as soon as the customer declines the Offer
* Include relevant metadata to help understand opt-out patterns
* Ensure opt-out is called for every Offer that is presented but not purchased


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://partner-docs.covergenius.com/offers/guides/purchase-workflow-overview/opt-out-offer.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
