Create a lead and send it to the policyholder

Warning

Depending on the transport selected some mandatory fields are required.

  • transport = "EMAIL" Requires the policyholder's email to be valid and completed

Request

POST https://sbx-api.qover.me/{country}/motor/gap/drafts/{draftId}/leads

Path parameters

Parameter name Value Description Additional
country string

The country ISO code case insensitive Country code in ISO 3166-1 alpha-2 The currently countries for which a line of business is available are:

  • BE
Required
draftId string

The Draft unique Id

Required

Request headers

Parameter name Value Description Additional
Qover-Api-Version string

The version of the api. Currently only '1.0' is available.

Required

Request body

The request body takes a complete Create Lead Body resource, containing the following writable properties:

{
    "partnerReference": [
        {
            "key": "string",
            "value": "string"
        }
    ],
    "transport": "string"
}

Properties

Name Type Description Additional
partnerReference[] array Optional
partnerReference[].key string

The item key (No unicity is checked)

partnerReference[].value string

The item value

transport string

How the lead should be sent

Possible values are:

  • EMAIL
Optional

Response

The following HTTP status codes may be returned, optionally with a response resource.

Status code Description Resource
200 OK

Ok: Operation Successful

400 Bad Request

Bad Request: The requested operation cannot be perfomed as the request is badly formatted or failed validation.

ValidationError
401 Unauthorized

Unauthorized: The authentication failed or is missing

402 Payment Required

Failed Request: The request is correclty formatted and valid but cannot be processed as it does not comply with one or several business rule.

FunctionalError
403 Forbidden

Forbidden: You do not have the right to perform this operation

404 Not Found

Not Found: The requested ressource cannot be found

500 Internal Server Error

Internal Server error: The request could not processed due to a server error

General Error

Explore this API

country

The country ISO code case insensitive Country code in ISO 3166-1 alpha-2 The currently countries for which a line of business is available are:

  • BE
draftId

The Draft unique Id

body
Request Content-Type
Qover-Api-Version

The version of the api. Currently only '1.0' is available.

Response Content-Type
Try it out!