Send SMS campaign

POST https://{account}/api/v1/sms/campaigns/{id}/send_all

Authentication

Requires an API key sent in the X-AUTH-TOKEN header.

This method is used to send a SMS campaign to groups or a text_list. It will return some attributes, including the ID of the SMS sent campaign which can be used to check the progress and results of the SMS campaign.

If you specify a callback URL, we will send a POST request right after the SMS sent campaign is processed. It will contain a JSON with the type of the callback and the ID of the SMS sent campaign.

You can use the following command to simulate a callback request:

curl --request POST \
  --url https://your-callback-domain.com/callback-url \
  --header 'content-type: application/json' \
  --data '{"type":"sms_sent_campaign_finished","id":1}'

Parameters

Responses

Response fields

• Send emails
  • POST /send_emails — Send email to one or more recipients
• A/B tests
  • GET /ab_tests — Lists A/B tests
  • POST /ab_tests — Add a new A/B test
  • GET /ab_tests/{id} — Get an A/B test by id
  • DELETE /ab_tests/{id} — Remove an A/B test
  • PATCH /ab_tests/{id}/cancel — Cancel A/B test
  • POST /ab_tests/{id}/choose_winning_combination — Choose which A/B test combination should be sent to the remaining subscribers
  • PATCH /ab_tests/{id}/set_as_manual — Set A/B test as manual
• Campaigns
  • GET /campaigns — Lists campaigns
  • POST /campaigns — Add a new campaign
  • GET /campaigns/{id} — Get a campaign by id
  • DELETE /campaigns/{id} — Remove a campaign
  • PATCH /campaigns/{id} — Update a campaign
  • POST /campaigns/{id}/send_all — Send a campaign
  • POST /campaigns/{id}/send_test — Send a campaign to test emails
• Campaign folders
  • GET /campaign_folders — Lists campaign folders
  • POST /campaign_folders — Add a new campaign folder
  • GET /campaign_folders/{id} — Get a campaign folder by id
  • DELETE /campaign_folders/{id} — Remove a campaign folder
  • PATCH /campaign_folders/{id} — Update a campaign folder
• Custom fields
  • GET /custom_fields — Lists custom fields
  • POST /custom_fields — Add a new custom field
  • GET /custom_fields/{id} — Get a custom field by id
  • DELETE /custom_fields/{id} — Remove a custom field
  • PATCH /custom_fields/{id} — Update a custom field
• Imports
  • GET /imports — Lists imports
  • POST /imports — Import a new file
  • GET /imports/{id} — Get an import by id
  • PATCH /imports/{id}/cancel — Cancel an import that is in progress
  • GET /imports/{id}/data — Get line by line data of an import
• Groups
  • GET /groups — Lists groups
  • POST /groups — Add a new group
  • GET /groups/{id} — Get a group by id
  • DELETE /groups/{id} — Remove a group
  • PATCH /groups/{id} — Update a group
• Media files
  • GET /media_files — Lists media files
  • POST /media_files — Add a new media file
  • GET /media_files/trashed — List media files in trash
  • GET /media_files/{id} — Get a single media file
  • DELETE /media_files/{id} — Hard delete a media file
  • PATCH /media_files/{id}/move_to_trash — Move media file to trash
  • PATCH /media_files/{id}/restore — Restore a file that is in trash
• Media folders
  • GET /media_folders — Lists media folders
  • POST /media_folders — Add a new media folder
  • GET /media_folders/{id} — Get a media folder by id
  • DELETE /media_folders/{id} — Remove a media folder
  • PATCH /media_folders/{id} — Update a media folder
• RSS Campaigns
  • GET /rss_campaigns — Lists RSS campaigns
  • POST /rss_campaigns — Add a new RSS campaign
  • GET /rss_campaigns/{id} — Get a RSS campaign by id
  • DELETE /rss_campaigns/{id} — Remove a RSS campaign
  • PATCH /rss_campaigns/{id} — Update a RSS campaign
  • GET /rss_campaigns/{id}/processed_entries — Get RSS campaign's processed entries
• Senders
  • GET /senders — Lists senders
  • POST /senders — Add a new sender
  • GET /senders/{id} — Get a sender by id
  • DELETE /senders/{id} — Remove a sender
  • PATCH /senders/{id} — Update a sender
  • POST /senders/{id}/send_confirmation_email — Send confirmation email
• Sent campaigns
  • GET /sent_campaigns — Lists sent campaigns
  • GET /sent_campaigns/{id} — Get a single sent campaign
  • GET /sent_campaigns/{id}/clicks — Get sent campaign's clicks
  • GET /sent_campaigns/{id}/impressions — Get sent campaign's impressions
  • GET /sent_campaigns/{id}/sent_emails — Get sent campaign's sent emails
  • GET /sent_campaigns/{id}/unsubscribe_events — Get sent campaign's unsubscribe events
  • PATCH /sent_campaigns/{id}/pause — Pause a campaign that is being sent
  • PATCH /sent_campaigns/{id}/resume — Resume a campaign that is paused
  • PATCH /sent_campaigns/{id}/cancel — Cancel a campaign
• SignupForms
  • GET /signup_forms — Lists signup forms
• SMTP emails
  • GET /smtp_emails — Get SMTP emails
  • GET /smtp_emails/{id} — Get an SMTP email by id
• SMTP tags
  • GET /smtp_tags — Lists SMTP tags
• Subscribers
  • GET /subscribers — Get subscribers
  • POST /subscribers — Add a new subscriber
  • GET /subscribers/{id} — Get a subscriber by id
  • DELETE /subscribers/{id} — Remove a subscriber
  • PATCH /subscribers/{id} — Update a subscriber
  • POST /subscribers/{id}/resend_confirmation_email — Resend confirmation email to an inactive subscriber
  • PATCH /subscribers/{id}/ban — Ban a subscriber
  • PATCH /subscribers/{id}/unban — Unban a subscriber
  • GET /subscribers/deleted — Get deleted subscribers
  • PATCH /subscribers/{id}/restore — Restore a deleted subscriber
  • POST /subscribers/sync — Create or update a subscriber
  • PATCH /subscribers/bulk_update — Bulk update subscribers
  • GET /subscribers/{subscriber_id}/tags — Lists a subscriber's tags
  • PUT /subscribers/{subscriber_id}/tags — Replace a subscriber's tags
  • POST /subscribers/{subscriber_id}/tags — Add tags to a subscriber
  • DELETE /subscribers/{subscriber_id}/tags — Remove tags from a subscriber
• Tags
  • GET /tags — Lists tags
  • POST /tags — Add a new tag
  • GET /tags/{id} — Get a tag by id
  • DELETE /tags/{id} — Remove a tag
  • PATCH /tags/{id} — Update a tag
• Unsubscribe events
  • GET /unsubscribe_events — Lists unsubscribe events
  • POST /unsubscribe_events — Add a new unsubscribe event
  • GET /unsubscribe_events/{id} — Get an unsubscribe event by id
  • DELETE /unsubscribe_events/{id} — Remove an unsubscribe event
• Bounces
  • DELETE /bounces — Delete bounces
• General
  • GET /stats — Get stats summary
  • GET /package — Get account package info
  • GET /ping — Ping the API
• API batches
  • GET /api_batches — Lists API batches
  • POST /api_batches — Add a new API batch
  • GET /api_batches/{id} — Get an API batch by id
• Event Subscriptions
  • GET /event_subscriptions — Lists event subscriptions
  • POST /event_subscriptions — Add a new event subscription
  • GET /event_subscriptions/{id} — Get an event subscription by id
  • DELETE /event_subscriptions/{id} — Remove an event subscription
  • PATCH /event_subscriptions/{id} — Update an event subscription
• Send transactional SMS
  • POST /sms/send — Send SMS to one or more recipients
• SMS campaigns
  • GET /sms/campaigns — Lists SMS campaigns
  • POST /sms/campaigns — Add a new SMS campaign
  • GET /sms/campaigns/{id} — Get SMS campaign by id
  • DELETE /sms/campaigns/{id} — Remove SMS campaign
  • PATCH /sms/campaigns/{id} — Update SMS campaign
  • POST /sms/campaigns/{id}/send_all — Send SMS campaign
• SMS sent campaigns
  • GET /sms/sent_campaigns — Lists SMS sent campaigns
  • GET /sms/sent_campaigns/{id} — Get a single SMS sent campaign
  • GET /sms/sent_campaigns/{id}/sent_messages — Get SMS sent campaign's sent messages
  • GET /sms/sent_campaigns/{id}/unsubscribe_events — Get SMS sent campaign's unsubscribe events
  • PATCH /sms/sent_campaigns/{id}/pause — Pause a SMS campaign that is being processed
  • PATCH /sms/sent_campaigns/{id}/resume — Resume a SMS campaign that is paused
  • PATCH /sms/sent_campaigns/{id}/cancel — Cancel a SMS campaign
• SMS sent messages
  • GET /sms/sent_messages — Lists SMS sent messages
  • GET /sms/sent_messages/{id} — Get a single SMS sent message
• Ecommerce Stores
  • GET /ecommerce/stores — Lists ecommerce stores
  • POST /ecommerce/stores — Add a new ecommerce store
  • GET /ecommerce/stores/{id} — Get an ecommerce store by id
  • DELETE /ecommerce/stores/{id} — Remove an ecommerce store
  • PATCH /ecommerce/stores/{id} — Update an ecommerce store
• Ecommerce Product Categories
  • GET /ecommerce/stores/{store_id}/product_categories — Lists product categories
  • POST /ecommerce/stores/{store_id}/product_categories — Add a new product category
  • GET /ecommerce/stores/{store_id}/product_categories/{id} — Get a product category by id
  • DELETE /ecommerce/stores/{store_id}/product_categories/{id} — Remove a product category from a store
  • PATCH /ecommerce/stores/{store_id}/product_categories/{id} — Update a product category
  • POST /ecommerce/stores/{store_id}/product_categories/sync — Create or update a product category
• Ecommerce Products
  • GET /ecommerce/stores/{store_id}/products — Lists products
  • POST /ecommerce/stores/{store_id}/products — Add a new product
  • GET /ecommerce/stores/{store_id}/products/{id} — Get a product by id
  • DELETE /ecommerce/stores/{store_id}/products/{id} — Remove a product
  • PATCH /ecommerce/stores/{store_id}/products/{id} — Update a product
  • POST /ecommerce/stores/{store_id}/products/sync — Create or update a product
• Ecommerce Carts
  • GET /ecommerce/stores/{store_id}/carts — Lists carts
  • POST /ecommerce/stores/{store_id}/carts — Add a new cart
  • GET /ecommerce/stores/{store_id}/carts/{id} — Get a cart by id
  • DELETE /ecommerce/stores/{store_id}/carts/{id} — Remove a cart
  • PATCH /ecommerce/stores/{store_id}/carts/{id} — Update a cart
  • POST /ecommerce/stores/{store_id}/carts/sync — Create or update a cart
• Send transactional WhatsApp messages
  • POST /whatsapp/send — Send WhatsApp messages to one or more recipients
• WhatsApp Phone Numbers
  • GET /whatsapp/phone_numbers — Lists WhatsApp phone numbers
  • GET /whatsapp/phone_numbers/{id} — Get a WhatsApp phone number by id
  • DELETE /whatsapp/phone_numbers/{id} — Remove a WhatsApp phone number
• WhatsApp Templates
  • GET /whatsapp/templates — Lists WhatsApp templates
  • POST /whatsapp/templates — Create a new WhatsApp template
  • GET /whatsapp/templates/{id} — Get a WhatsApp template by id
  • DELETE /whatsapp/templates/{id} — Delete a WhatsApp template
  • PATCH /whatsapp/templates/{id} — Update a WhatsApp template
  • POST /whatsapp/templates/{id}/submit_for_approval — Submit template for approval
• WhatsApp campaigns
  • GET /whatsapp/campaigns — Lists WhatsApp campaigns
  • POST /whatsapp/campaigns — Add a new WhatsApp campaign
  • GET /whatsapp/campaigns/{id} — Get WhatsApp campaign by id
  • DELETE /whatsapp/campaigns/{id} — Remove WhatsApp campaign
  • PATCH /whatsapp/campaigns/{id} — Update WhatsApp campaign
  • POST /whatsapp/campaigns/{id}/send_all — Send WhatsApp campaign
• WhatsApp sent campaigns
  • GET /whatsapp/sent_campaigns — Lists WhatsApp sent campaigns
  • GET /whatsapp/sent_campaigns/{id} — Get a single WhatsApp sent campaign
  • GET /whatsapp/sent_campaigns/{id}/sent_messages — Get WhatsApp sent campaign's sent messages
  • PATCH /whatsapp/sent_campaigns/{id}/pause — Pause a WhatsApp campaign that is being sent
  • PATCH /whatsapp/sent_campaigns/{id}/resume — Resume a WhatsApp campaign that is paused
  • PATCH /whatsapp/sent_campaigns/{id}/cancel — Cancel a WhatsApp campaign
• WhatsApp sent messages
  • GET /whatsapp/sent_messages — Lists WhatsApp sent messages
  • GET /whatsapp/sent_messages/{id} — Get a single WhatsApp sent message
• Connect an assistant
• Permissions & tools
• What you can ask
• Troubleshooting & FAQ