LogoLogo
  • Introduction
  • Authentication
  • Endpoints
    • Content
    • Quote
    • Status
    • Update
    • Purchase
    • Cancel
    • InstantBooking
    • Update Customer
    • Notifications/list
    • Notification/update
    • GetAllPurchasedPolicies
    • GetAllCancelledPolicies
    • CoverOptOut
    • Invoice
  • Webhook
    • HMAC Verification
    • Events
      • Cancellation Event
  • Testing
  • Errors
    • Quote Errors
    • Purchase Errors
    • Cancel Errors
  • Supported Currencies
  • Supported Languages
  • Supported Regions
  • Non-API Functions
Powered by GitBook
On this page
  1. Endpoints

CoverOptOut

The CoverOptOut endpoint allows the requestor to specify that a customer has opted in or out of RentalCover.

This endpoint must be called if a customer is opting out of RentalCover.

Endpoint: /insurances/coverOptOut

Method: POST

curl -i -X POST \
-H "X_API_KEY: [my-api-key]" \
-H "Content-Type: application/json" \
-d '{"AgentReference":"123123123"}' \
https://api-staging.rentalcover.com/insurances/coverOptOut/AB12-345C-INS
{
    "success"
}

Request Parameters

Reference string required

The RentalCover.com booking reference (passed in endpoint URL).

CoverOptIn boolean required

0 = customer opted out 1 = customer opted in.

PartnerReference string

Your internal booking reference.

PreviousGetAllCancelledPoliciesNextInvoice

Last updated 1 year ago