contacts

Discard or restore people, in bulk

Changed on

Remove people from the list in one call with update.lifecycleStage "rejected", or bring them back with "contact"; the write lands on this conversation's own list, so never name one. Asked to remove people by a RULE rather than by name, call filter_contacts first and write only the ids it returned: that way you are removing real rows rather than a guess, and you can say exactly who went and why, which you must. Never invent an id.

patch/contacts/bulk

Request

  • Base URL: https://api.bereach.ai
  • URL: https://api.bereach.ai/contacts/bulk
  • Auth: HTTP bearer

Query parameters

campaignIdstring

The list a list change (lifecycleStage) lands on: take it from the person's campaigns in a contacts result. Inside a conversation that has its own list, that list is used when this is left out.

Request body

contactIdsstring[] required

Contact IDs to update

Response

Bulk update results

successtrue required
updatedinteger required
skippedinteger required
errorsstring[] required
creditsUsedinteger required

Credits this call spent, net of anything given back. 0 when nothing was charged: a free read, a cached answer, nothing delivered.

retryAfterinteger required

Seconds to wait before another call of the same type. 0 means no wait is needed.

Changes

  • bdaed6984b20Revision changes
    • warning

      removed the optional property from the response with the status

  • 71b5dd686f80Revision changes
    • breaking

      removed the enum value qualified of the request property /

    • warning

      removed the request property /

    • warning

      removed the request property /

    • warning

      removed the request property /