Contacts

Delete contacts by filter

Deletes contacts matching the supplied filter under the authenticated account. The filter body is required; an empty JSON object matches every contact. An optional limit deletes the lowest contact IDs first and is bounded to 1,000,000. Pass the limit only as the ?limit= query parameter; a top-level limit key in the JSON body is rejected with 400 at body.limit instead of being forwarded as filter data. Requires a user-scope token; tenant-admin tokens are rejected with 403.

post/contacts/delete

Request

  • Base URL
    https://api.textla.com/v1
  • Auth
    HTTP bearer

Query parameters

limitinteger

Maximum number of contacts to delete in this call.

Request body

object required

Response

OK

$schemastring uri

A URL to the JSON Schema for this object.

deletedinteger required

Example response

{
  "$schema": "/v1/schemas/BulkDeleteReport.json"
}

Changes

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