> For the complete documentation index, see [llms.txt](https://partner-docs.covergenius.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://partner-docs.covergenius.com/rentalcover/endpoints/coveroptout.md).

# CoverOptOut

**What it does:** Records whether a customer has opted in or out of RentalCover coverage.

**When to call it:** Immediately after the customer makes their decision, regardless of whether they accept or decline.

{% hint style="info" %}
**Required call**

This endpoint is mandatory for every customer shown the insurance offer. Failing to call it when a customer declines may result in compliance issues.
{% endhint %}

```
POST /insurances/coverOptOut/<reference>
```

## Example requests

### Customer opts out

```shellscript
curl -i -X POST \
  -H "X_API_KEY: your_api_key" \
  -H "Content-Type: application/json" \
  -d '{"CoverOptIn": 0, "PartnerReference": "PARTNER-REF-001"}' \
  https://api-staging.rentalcover.com/insurances/coverOptOut/AB12-345C-INS
```

### Customer opts in

```shellscript
curl -i -X POST \
  -H "X_API_KEY: your_api_key" \
  -H "Content-Type: application/json" \
  -d '{"CoverOptIn": 1, "PartnerReference": "PARTNER-REF-001"}' \
  https://api-staging.rentalcover.com/insurances/coverOptOut/AB12-345C-INS
```

## Request parameters

<table data-header-hidden="false" data-header-sticky><thead><tr><th width="205.1732177734375">Parameter</th><th width="163.205078125">Required?</th><th>Description</th></tr></thead><tbody><tr><td><code>reference</code> (URL)</td><td>Required</td><td>The RentalCover booking reference from the Quote response.</td></tr><tr><td><code>CoverOptIn</code></td><td>Required</td><td><code>1</code> = customer accepted cover. <code>0</code> = customer declined cover.</td></tr><tr><td><code>PartnerReference</code></td><td>Optional</td><td>Your internal booking reference.</td></tr></tbody></table>

## Response

Returns a [Booking Response](https://docs.google.com/document/d/1ivu-Eknbpw9WESHc0Q0s-kUylfRtrV0s-G9S89I8wEg/edit#booking-response). Status is returned on `success`.

```graphql
{
    "Status":"success"
}
```


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## 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, and the optional `goal` query parameter:

```
GET https://partner-docs.covergenius.com/rentalcover/endpoints/coveroptout.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

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.