API Reference

Cancel pending outgoing webhook events matching the supplied criteria.

post
https://platform.routy.app/api/v1/conversions/outgoing/webhooks/events/cancel

Bulk-cancels webhook events selected by affiliate/account/traffic-source ids, webhook setting ids
(bound from the JSON property webHookSettingId), click/conversion ids and a date range.
When too many rows match, the request must include confirmationCode set to today's UTC
timestamp; otherwise the operation may be rejected (HTTP 429). Requires an account-admin token plus
the DeleteTrafficSource policy.

🔐 Required permissions: traffic-source.read, traffic-source.update, traffic-source.delete

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params

The criteria selecting which events to cancel.

Criteria selecting which pending outgoing webhook events to bulk-cancel.

affiliateId
array of int32s | null

Optional list of affiliate ids to scope the cancellation.

affiliateId
trafficSourceId
array of int32s | null

Optional list of traffic source ids to scope the cancellation.

trafficSourceId
webHookSettingId
array of int32s | null

Optional list of webhook setting ids. Serialized/bound as the JSON property webHookSettingId.

webHookSettingId
accountId
array of int32s | null

Optional list of account ids to scope the cancellation.

accountId
clickId
array of uuids | null

Optional list of originating click ids.

clickId
conversionId
array of int64s | null

Optional list of conversion ids.

conversionId
date-time | null

Optional start of the date range to cancel (inclusive).

date-time | null

Optional end of the date range to cancel (inclusive).

string | null

in cases when there are too many rows to cancel, we can use this field to confirm the cancellation
the field should hold a time stamp of today (UTC)

Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
string
enum
Defaults to application/json

Generated from available request content types

Allowed:
Responses

confirmationCode.

Updated 2 months ago

Did this page help you?
Language
Credentials
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
text/plain
application/json
text/json

Updated 2 months ago

Did this page help you?