Sign in
Customer Blacklist

Create a Blacklist entry

Create a new Customer Blacklist entry with the provided details

post/blacklist

Request body

emailstring email required

The blacklisted email. Stored lowercased.

reasonstring

Example request

{
  "email": "user@example.com"
}

Response

OK

createdAtstring date-time required

The date and time when the entity was created.

updatedAtstring date-time nullable required

The date and time when the entity was last updated.

metadataobject nullable

Metadata used by merchants to store additional information about the entity.

idstring required

The unique identifier of the customer blacklist entry

emailstring required

Email address of the blacklisted customer

reasonstring nullable required

Reason for blacklisting this customer

Example response

{
  "createdAt": "2024-02-18T12:00:00Z",
  "updatedAt": "2024-02-21T12:15:00Z",
  "metadata": {
    "key1": "value1",
    "key2": "value2"
  },
  "email": "user@example.com",
  "reason": "Fraudulent activity detected"
}

Changes

No recorded changes to this endpoint across all 1 revision of this API.