Add to Blacklist - timepay.ai

curl --request POST \
  --url https://api.agents.timepay.ai/api/v1/blacklist/bulk/add \
  --header 'Authorization: Bearer <your_token>' \
  --header 'Content-Type: application/json' \
  --data '[
  {
    "number": "8249752556",
    "name": "Bob Smith"
  },
  {
    "number": "9920967932"
  }
]'

{
  "success": true,
  "message": "Numbers has been added to blacklist"
}

{
  "success": false,
  "message": "Request body must be a non-empty array of objects."
}

{
  "success": false,
  "message": "Each item must contain a 'number' field."
}

{
  "success": false,
  "message": "An unexpected server error occurred."
}

curl --request POST \
  --url https://api.agents.timepay.ai/api/v1/blacklist/bulk/add \
  --header 'Authorization: Bearer <your_token>' \
  --header 'Content-Type: application/json' \
  --data '[
  {
    "number": "8249752556",
    "name": "Bob Smith"
  },
  {
    "number": "9920967932"
  }
]'

{
  "success": true,
  "message": "Numbers has been added to blacklist"
}

{
  "success": false,
  "message": "Request body must be a non-empty array of objects."
}

{
  "success": false,
  "message": "Each item must contain a 'number' field."
}

{
  "success": false,
  "message": "An unexpected server error occurred."
}

Headers

string

required

Bearer token for authentication (e.g., Bearer <your_token>).

Body Parameters

The request body should be a non-empty array of objects.

Automatic Name Resolution: If you omit the name field or provide an empty string, the system will automatically search your organization’s latest logs for the most recent name associated with that phone number and use it for the blacklist entry.

array[]

required

List of numbers to blacklist.

Show item properties

string

required

The phone number to be blacklisted.

string

The name of the customer (optional). If not provided, the system will attempt to fetch the name from recent interaction logs.

curl --request POST \
  --url https://api.agents.timepay.ai/api/v1/blacklist/bulk/add \
  --header 'Authorization: Bearer <your_token>' \
  --header 'Content-Type: application/json' \
  --data '[
  {
    "number": "8249752556",
    "name": "Bob Smith"
  },
  {
    "number": "9920967932"
  }
]'

Response

boolean

Indicates whether the request was successful.

string

A descriptive message about the result.

{
  "success": true,
  "message": "Numbers has been added to blacklist"
}

{
  "success": false,
  "message": "Request body must be a non-empty array of objects."
}

{
  "success": false,
  "message": "Each item must contain a 'number' field."
}

{
  "success": false,
  "message": "An unexpected server error occurred."
}

​Headers

​Body Parameters

​Response

Headers

Body Parameters

Response