Automations - Trigger

Trigger an active API automation for a list of contacts. Only the first 50 contacts of a request are processed. Contacts that don’t exist yet in Simio are created, and their variables are saved for message personalization. Automation sends bypass delivery-hours and opt-out checks. The send is queued and processed in the background. Rate limit: 20 requests per second.

POST /api/automations/send

Automations - Trigger

cURL

curl --request POST \
  --url https://getsimio.app/api/automations/send \
  --header 'Content-Type: application/json' \
  --header 'simio-api-key: <api-key>' \
  --data '
{
  "automation_id": 123,
  "contacts": [
    {
      "phone": "33612345678",
      "first_name": "Firstname",
      "image_url": "https://example.com/offer.png",
      "last_name": "Lastname",
      "variables": {
        "discount_code": "SUMMER10"
      },
      "video_url": "https://example.com/offer.mp4"
    }
  ],
  "image_url": "https://example.com/offer.png",
  "url": "https://example.com/track/abc123",
  "url2": "https://example.com/track/def456",
  "video_url": "https://example.com/offer.mp4"
}
'

202

{
  "batch_id": "1759842000000",
  "contacts": 2,
  "status": "accepted"
}

Authorizations

simio-api-key · string · header · required

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

Body

application/json

automation_id · integer · required

ID of the 'api'-type automation to trigger.

Example:

123

contacts · AutomationTriggerContact · object[] · required

Contacts to send to. Up to 1000 are accepted, but only the first 50 per request are processed - split larger batches across multiple calls.

Show child attributes

image_url · string | null

Image URL applied to all contacts unless overridden per-contact.

Maximum string length: 2048

Pattern: ^https?://\S+$

Example:

"https://example.com/offer.png"

url · string | null

Override for the template's first URL button destination.

Maximum string length: 2048

Pattern: ^https?://\S+$

Example:

"https://example.com/track/abc123"

url2 · string | null

Override for the template's second URL button destination.

Maximum string length: 2048

Pattern: ^https?://\S+$

Example:

"https://example.com/track/def456"

video_url · string | null

Video URL applied to all contacts unless overridden per-contact.

Maximum string length: 2048

Pattern: ^https?://\S+$

Example:

"https://example.com/offer.mp4"

Response

202

application/json

Successful Response

batch_id · string · required

Identifier of this send batch.

Example:

"1759842000000"

contacts · integer · required

Number of contacts the send was queued for.

Example:

2

status · string · required

Always accepted: the send is queued and processed in the background.

Allowed value: "accepted"

Example:

"accepted"