Using Convertr APIs? Subscribe here to receive email notifications for development changes that may impact your implementation.
Overview
Convertr has the ability to retrospectively invalidate or validate a lead after it has been delivered to an endpoint.
You can send as many status changes against a lead as required and change between valid and invalid as required.
If the lead is flagged as Invalid, then it is no longer billable to either the publisher or the client.
If the lead is flagged as Valid, then it's billable status will be recalculated based on the current state of the publisher and campaign contract a status.
Property | Type | Required | Description |
leadHash | String | Yes | The Convertr lead hash is created with every lead and is how the request links back to a specific lead within Convertr. |
reason | String | Yes | Description as to why the lead was invalidated or validated |
user | String | Yes | Name of the user to log with the request |
Invalidate
Example curl request:
curl --location 'https://{client}.cvtr.io/api/webhook/invalidate/{leadHash}' \
--form 'reason="Unable to Contact"' \
--form 'user="John Smith"'
Validate
Example curl request:
curl --location 'https://{client}.cvtr.io/api/webhook/validate/{leadHash}' \
--form 'reason="Details verified"' \
--form 'user="John Smith"'
Response
Both endpoints will produce a 201 response on success with an empty response body.
400 error will be returned for any missing required fields.