Tag, untag, or delete many contacts

POST /v1/contacts/bulk

One action for up to 500 contact ids. Ids that do not exist are counted in missing; the rest are applied.

Send your API key as a bearer token: Authorization: Bearer ssms_sk_.... Test keys run this endpoint against the sandbox; see Authentication for key modes and scopes.

Request body

JSON (Content-Type: application/json).

Field	Type	Required	Description
`action`	`add_tags`, `remove_tags`, `delete`	Yes
`ids`	array of string	Yes	At most 500 items.
`tags`	array of string	No	Required for add_tags and remove_tags

Responses

Status	Meaning	Body
200	Result	JSON object
400	Invalid request	`Error`
401	Missing, malformed, or revoked API key	`Error`
402	Billable live calls only: the prepaid credit balance cannot cover the call (insufficient_credits); nothing was done or charged	`Error`
429	Rate limit or quota exceeded	`Error`

200: response fields

Field	Type	Description
`object`	`contact_bulk`
`action`	string
`updated`	integer
`deleted`	integer
`missing`	integer

Errors

Status	When
400	Invalid request
401	Missing, malformed, or revoked API key
402	Billable live calls only: the prepaid credit balance cannot cover the call (insufficient_credits); nothing was done or charged
429	Rate limit or quota exceeded

Every error has the same JSON shape, and request_id matches the X-Request-Id response header. Errors lists every code and what to do about it.

json

{
  "error": {
    "code": "invalid_request",
    "message": "What went wrong, in plain words.",
    "param": "the_field",
    "request_id": "req_a1B2c3D4e5F6g7H8"
  }
}

Examples

curl

bash

curl -X POST "https://api.joinsimplesms.com/v1/contacts/bulk" \
  -H "Authorization: Bearer $SIMPLESMS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "action": "add_tags",
  "ids": [
    "string"
  ]
}'

Node.js

javascript

import { SimpleSMS } from 'joinsimplesms'; // npm install joinsimplesms

const sms = new SimpleSMS(process.env.SIMPLESMS_API_KEY);

const result = await sms.contacts.bulk({
  action: 'add_tags',
  ids: ['ct_a1B2c3D4e5F6'],
  tags: ['vip'],
});

Python

python

import os
from joinsimplesms import SimpleSMS  # pip install joinsimplesms

client = SimpleSMS(os.environ["SIMPLESMS_API_KEY"])

result = client.contacts.bulk("add_tags", ["ct_a1B2c3D4e5F6"], tags=["vip"])