PUT /blocklists/{id}

Creates a blocklist with a specified ID.

Servers

Request headers

Name Type Required Description
Content-Type String Yes The media type of the request body.

Default value: "application/json"

Request body fields

Name Type Required Description
id String No

ID of the blocklist.

source String No

Source that triggered the creation of the blocklist.

Valid values:

  • "manual-blocklists"
  • "automated-blocklists"
  • "risk-score-rules"
_links[] Array No

Related links.

_links[].href String No

Link URL.

_links[].rel String No

Type of link.

Valid values:

  • "self"
updatedTime String No

Date and time when the resource is updated. This value is set automatically when the resource is updated.

createdTime String No

Date and time when the resource is created. This value is set automatically when the resource is created.

entityId String No

ID of the user, transaction or dispute that triggered the creation of the blocklist.

type String Yes

Type of blocklist.

Valid values:

  • "email-domain"
  • "bin"
  • "address"
  • "email"
  • "country"
  • "customer-id"
  • "fingerprint"
  • "ip-address"
  • "payment-card"
  • "bank-account"
value String Yes

Value of the blocklist.

expirationTime String No

Date and time when the blocklist expires.

How to start integrating

  1. Add HTTP Task to your workflow definition.
  2. Search for the API you want to integrate with and click on the name.
    • This loads the API reference documentation and prepares the Http request settings.
  3. Click Test request to test run your request to the API and see the API's response.