Segments - Manage contacts

Add contacts to a segment, or remove them from it. Contacts are matched by phone number (or SHA-256 hash of the phone number) against contacts that already exist in Simio; unknown numbers are counted as not found. Up to 1000 contacts per request. Rate limit: 1 request per minute.

POST /api/segments/{segment_id}/contacts

Segments - Manage contacts

cURL

curl --request POST \
  --url https://getsimio.app/api/segments/{segment_id}/contacts \
  --header 'Content-Type: application/json' \
  --header 'simio-api-key: <api-key>' \
  --data '
{
  "contacts": [
    "33612345678"
  ],
  "mode": "add",
  "use_hashed_phone": false
}
'

200

{
  "contacts_found": 2,
  "contacts_not_found": 1,
  "contacts_processed": 2,
  "contacts_provided": 3,
  "mode": "add",
  "segment_id": 42
}

Authorizations

simio-api-key · string · header · required

Company API key, created in Settings > Integrations & developers > Credentials.

Path Parameters

segment_id · integer · required

ID of the segment, as returned by Create.

Example:

42

Body

application/json

contacts · string[] · required

Phone numbers to add or remove (up to 1000 per request). When use_hashed_phone is true, these must be SHA-256 hex digests of the phone numbers instead of raw phone numbers.

Maximum string length: 64

Example:

["33612345678"]

mode · enum<string> · required

Whether to add or delete the given contacts from the segment.

Available options: add, delete

Example:

"add"

use_hashed_phone · boolean · default: false

If true, contacts contains SHA-256 hex digests of phone numbers rather than raw phone numbers.

Example:

false

Response

200

application/json

Successful Response

contacts_found · integer · required

Number of those contacts that exist in Simio.

Example:

2

contacts_not_found · integer · required

Number of those contacts that don't exist in Simio.

Example:

1

contacts_processed · integer · required

Number of contacts added to or removed from the segment.

Example:

2

contacts_provided · integer · required

Number of distinct contacts in the request.

Example:

3

mode · enum<string> · required

Operation that was applied.

Available options: add, delete

Example:

"add"

segment_id · integer · required

ID of the segment.

Example:

42