Samva
DashboardAPI
ChannelsPlatformMailboxesDevelopersEmail templatesIntegrationsAPI Reference
Contacts

Bulk update contact status

Sets the status on multiple contacts in one request, returning counts of updated and failed records.

POST
/v1/contacts/bulk-update-status

Sets the status on multiple contacts in one request, returning counts of updated and failed records.

Authorization

apiKey
x-api-key<token>

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

ids*array<>
Items1 <= items
status*string

Value in

  • "active"
  • "paused"
  • "blocked"
  • "archived"

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X POST "https://example.com/v1/contacts/bulk-update-status" \  -H "Content-Type: application/json" \  -d '{    "ids": [      "string"    ],    "status": "active"  }'
{  "updated": 0,  "failed": 0}

Related documentation

Bulk import contacts

Creates contacts in bulk from a list of entries shaped like a create request, returning per-entry results with created, updated, skipped, and error counts.

Bulk update contact tags

Adds, removes, or replaces tags on multiple contacts in one request, returning counts of updated and failed records.