idstringrequired
>= 1 characters
Example:D2IOuPcAq9s3sZ1pt3jW7
Update a subscription
Update API key and status of a subscription.
put
Path Parameters
Body
application/json
Body
application/json
webhookSubscriptionUpdateRequest
apiKeystring
The API key for authenticating webhook requests.
Example:12345-abcd-67890-xyz
statusstring
The status of the subscription.
Allowed values:ACTIVEINACTIVE
Response
application/json
Response
application/json
Subscription updated successfully
webhookSubscriptionResponse
subscriptionIdstringrequired
>= 1 characters
Example:D2IOuPcAq9s3sZ1pt3jW7
urlstring(url)required
The URL to send new lead notifications to.
Example:https://example.com/webhook
statusstringrequired
The status of the subscription.
Allowed values:ACTIVEINACTIVE
createdAtstring(date-time)required
Example:2025-01-01T10:00:00Z
updatedAtstring(date-time)required
Example:2025-01-01T10:00:00Z
put/webhook/subscriptions/{id}
Authentication
Path Parameters
Body
{}
application/json
Delete a subscription
Delete the subscription with the specified subscription ID.
delete
Path Parameters
idstringrequired
>= 1 characters
Example:D2IOuPcAq9s3sZ1pt3jW7
Response
application/json
Response
application/json
Subscription deleted successfully
webhookSubscriptionDeleteResponse
subscriptionIdstringrequired
>= 1 characters
Example:D2IOuPcAq9s3sZ1pt3jW7
urlstring(url)required
The URL to send new lead notifications to.
Example:https://example.com/webhook
statusstringrequired
The status of the subscription.
Allowed values:ACTIVEINACTIVE
createdAtstring(date-time)required
Example:2025-01-01T10:00:00Z
updatedAtstring(date-time)required
Example:2025-01-01T10:00:00Z
messagestringrequired
Example:Subscription deleted successfully
delete/webhook/subscriptions/{id}
Authentication
Path Parameters
application/json
Get subscription audit information
Retrieves audit information for the specified subscription.
get
Query Parameters
limitinteger
Maximum recent webhook notifications to be returned.
Max value is 100 notifications and default value is 10.
Default:10
>= 1<= 100
Path Parameters
idstringrequired
>= 1 characters
Example:D2IOuPcAq9s3sZ1pt3jW7
Response
application/json
Response
application/json
Subscription audit information retrieved successfully
webhookAuditResponse
subscriptionIdstringrequired
Example:D2IOuPcAq9s3sZ1pt3jW7
urlstring(url)required
The client endpoint used to receive new lead notifications.
Example:https://example.com/webhook
statusstringrequired
The status of the subscription.
Allowed values:ACTIVEINACTIVE
createdAtstring(date-time)required
Example:2025-01-01T10:00:00Z
updatedAtstring(date-time)required
Example:2025-01-01T10:00:00Z
lastSuccessTimestampstring | null(date-time)
Timestamp of the last successful webhook notification, empty if never succeeded.
Example:2025-01-01T12:00:00Z
recentEventsarray[object]required
List of recent webhook notification events, ordered from most recent to oldest.
Show Child Parameters
get/webhook/subscriptions/{id}/audit
Authentication
Path Parameters
Query Parameters
application/json
createLeadRequest
objectfirstNamestring
Maximum length is 100 characters
>= 1 characters<= 100 characters
Example:Jane
lastNamestringrequired
Maximum length is 100 characters
>= 1 characters<= 100 characters
Example:Doe
genderstring
Allowed values:MALEFEMALEOTHERPREFER_NOT_TO_DISCLOSE
Example:FEMALE
emailstring(email)required
Example:test@example.com
languagestring
Allowed values:DEENESFRHEITNLPTRU
Default:FR
Example:FR
phoneNumbersarray[object]required
>= 1 characters
Show Child Parameters
messagestringrequired
classifiedIdstringrequired
Classified identifier in the format ^([0-9]{2})([1-9A-NP-Z]{10})$
Match pattern:^([0-9]{2})([1-9A-NP-Z]{10})$
submittedDatestring(date-time)required
The date and time when the lead was submitted in ISO 8601 format
Example
errorResponse
objectError response with 4xx or 5xx status code
* Additional properties are allowed.
typestringrequired
The URI reference that identifies the problem type
>= 1 characters
titlestringrequired
An human-readable summary of the problem type
>= 1 characters
detailstringrequired
A human-readable explanation specific to
this occurrence of the problem
>= 1 characters
instancestringrequired
A URI reference that identifies the specific occurrence of the problem
>= 1 characters
Example:00-0af7651916cd43dd8448eb211c80319c-b9c7c989f97918e1-01
statusnumberrequired
The HTTP status code generated for this occurrence of the problem
>= 1 characters
Example:400
Example