Mailchimp Sms Campaigns API
The sms-campaigns API from Mailchimp — 6 operation(s) for sms-campaigns.
Work with this as data
Every API here is available over the APIs.io API and to AI agents over MCP.
MCP server
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
Tools for apis
7 MCP tools reach this
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.
Call it yourself
curl for this page
This API
curl "https://apis.io/api/v1/apis/mailchimp-sms-campaigns-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"Discovery needs no key. Ratings and market analysis are Pro.
OpenAPI Specification
openapi: 3.2.0
info:
version: 3.0.91
title: Mailchimp Marketing Sms Campaigns API
contact:
name: Mailchimp API Support
email: apihelp@mailchimp.com
x-permalink: https://github.com/mailchimp/mailchimp-client-lib-codegen/blob/main/spec/marketing.json
servers:
- url: https://server.api.mailchimp.com/3.0
security:
- basicAuth: []
tags:
- name: sms-campaigns
paths:
/sms-campaigns:
get:
summary: List SMS campaigns
description: Get all SMS campaigns in an account.
operationId: getSmsCampaigns
parameters:
- name: fields
x-title: Fields
in: query
description: A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.
required: false
style: form
explode: false
schema:
type: array
items:
type: string
- name: exclude_fields
x-title: Exclude Fields
in: query
description: A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.
required: false
style: form
explode: false
schema:
type: array
items:
type: string
- name: count
x-title: Count
in: query
description: The number of records to return. Default value is 10. Maximum value is 1000
required: false
schema:
type: integer
default: 10
maximum: 1000
- name: offset
x-title: Offset
in: query
description: Used for [pagination](https://mailchimp.com/developer/marketing/docs/methods-parameters/#pagination), this is the number of records from a collection to skip. Default value is 0.
required: false
schema:
type: integer
default: 0
responses:
'200':
description: ''
content:
application/json:
schema:
type: object
title: SMS Campaigns
description: A collection of SMS campaigns.
properties:
sms_campaigns:
type: array
title: SMS Campaigns
description: An array of SMS campaigns.
items:
type: object
title: SMS Campaign
description: A single SMS campaign.
properties:
id:
type: string
title: Campaign ID
description: A string that uniquely identifies this campaign.
readOnly: true
web_id:
type: string
title: Campaign Web ID
description: The ID used in the Mailchimp web application.
readOnly: true
name:
type: string
title: Campaign Name
description: The name of the campaign.
status:
type: string
title: Campaign Status
description: The current status of the campaign.
readOnly: true
channel:
type: string
title: Campaign Channel
description: The channel for this campaign (sms or whatsapp).
readOnly: true
list_id:
type: integer
title: List ID
description: The numeric ID of the list associated with this campaign.
readOnly: true
recipient_count:
type: integer
title: Recipient Count
description: The number of recipients for this campaign.
readOnly: true
create_time:
type: string
format: date-time
title: Create Time
description: The date and time the campaign was created in ISO 8601 format.
readOnly: true
send_time:
type: string
format: date-time
title: Send Time
description: The date and time the campaign is scheduled to send.
readOnly: true
updated_at:
type: string
format: date-time
title: Updated At
description: The date and time the campaign was last updated.
readOnly: true
expire_time:
type: string
format: date-time
title: Expire Time
description: The date and time the campaign will stop sending in ISO 8601 format.
readOnly: true
is_send_now:
type: boolean
title: Is Send Now
description: Whether the campaign is configured to send immediately.
readOnly: true
folder_id:
type: string
title: Folder ID
description: The ID of the folder this campaign is in.
segments:
type: array
title: Segments
description: The segment IDs used to target recipients for this campaign.
items:
type: integer
excluded_segments:
type: array
title: Excluded Segments
description: The segment IDs excluded from receiving this campaign.
items:
type: integer
_links:
title: Links
description: A list of link types and descriptions for the API schema documents.
type: array
items:
type: object
title: Resource Link
description: This object represents a link from the resource where it is found to another resource or action that may be performed.
properties:
rel:
type: string
title: Rel
description: As with an HTML 'rel' attribute, this describes the type of link.
readOnly: true
href:
type: string
title: Href
description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action.
readOnly: true
method:
type: string
title: Method
description: The HTTP method that should be used when accessing the URL defined in 'href'.
enum:
- GET
- POST
- PUT
- PATCH
- DELETE
- OPTIONS
- HEAD
readOnly: true
targetSchema:
type: string
title: Target Schema
description: For GETs, this is a URL representing the schema that the response should conform to.
readOnly: true
schema:
type: string
title: Schema
description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to.
readOnly: true
readOnly: true
total_items:
type: integer
title: Item Count
description: The total number of items matching the query regardless of pagination.
readOnly: true
_links:
title: Links
description: A list of link types and descriptions for the API schema documents.
type: array
items:
type: object
title: Resource Link
description: This object represents a link from the resource where it is found to another resource or action that may be performed.
properties:
rel:
type: string
title: Rel
description: As with an HTML 'rel' attribute, this describes the type of link.
readOnly: true
href:
type: string
title: Href
description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action.
readOnly: true
method:
type: string
title: Method
description: The HTTP method that should be used when accessing the URL defined in 'href'.
enum:
- GET
- POST
- PUT
- PATCH
- DELETE
- OPTIONS
- HEAD
readOnly: true
targetSchema:
type: string
title: Target Schema
description: For GETs, this is a URL representing the schema that the response should conform to.
readOnly: true
schema:
type: string
title: Schema
description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to.
readOnly: true
readOnly: true
application/problem+json:
schema:
type: object
title: SMS Campaigns
description: A collection of SMS campaigns.
properties:
sms_campaigns:
type: array
title: SMS Campaigns
description: An array of SMS campaigns.
items:
type: object
title: SMS Campaign
description: A single SMS campaign.
properties:
id:
type: string
title: Campaign ID
description: A string that uniquely identifies this campaign.
readOnly: true
web_id:
type: string
title: Campaign Web ID
description: The ID used in the Mailchimp web application.
readOnly: true
name:
type: string
title: Campaign Name
description: The name of the campaign.
status:
type: string
title: Campaign Status
description: The current status of the campaign.
readOnly: true
channel:
type: string
title: Campaign Channel
description: The channel for this campaign (sms or whatsapp).
readOnly: true
list_id:
type: integer
title: List ID
description: The numeric ID of the list associated with this campaign.
readOnly: true
recipient_count:
type: integer
title: Recipient Count
description: The number of recipients for this campaign.
readOnly: true
create_time:
type: string
format: date-time
title: Create Time
description: The date and time the campaign was created in ISO 8601 format.
readOnly: true
send_time:
type: string
format: date-time
title: Send Time
description: The date and time the campaign is scheduled to send.
readOnly: true
updated_at:
type: string
format: date-time
title: Updated At
description: The date and time the campaign was last updated.
readOnly: true
expire_time:
type: string
format: date-time
title: Expire Time
description: The date and time the campaign will stop sending in ISO 8601 format.
readOnly: true
is_send_now:
type: boolean
title: Is Send Now
description: Whether the campaign is configured to send immediately.
readOnly: true
folder_id:
type: string
title: Folder ID
description: The ID of the folder this campaign is in.
segments:
type: array
title: Segments
description: The segment IDs used to target recipients for this campaign.
items:
type: integer
excluded_segments:
type: array
title: Excluded Segments
description: The segment IDs excluded from receiving this campaign.
items:
type: integer
_links:
title: Links
description: A list of link types and descriptions for the API schema documents.
type: array
items:
type: object
title: Resource Link
description: This object represents a link from the resource where it is found to another resource or action that may be performed.
properties:
rel:
type: string
title: Rel
description: As with an HTML 'rel' attribute, this describes the type of link.
readOnly: true
href:
type: string
title: Href
description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action.
readOnly: true
method:
type: string
title: Method
description: The HTTP method that should be used when accessing the URL defined in 'href'.
enum:
- GET
- POST
- PUT
- PATCH
- DELETE
- OPTIONS
- HEAD
readOnly: true
targetSchema:
type: string
title: Target Schema
description: For GETs, this is a URL representing the schema that the response should conform to.
readOnly: true
schema:
type: string
title: Schema
description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to.
readOnly: true
readOnly: true
total_items:
type: integer
title: Item Count
description: The total number of items matching the query regardless of pagination.
readOnly: true
_links:
title: Links
description: A list of link types and descriptions for the API schema documents.
type: array
items:
type: object
title: Resource Link
description: This object represents a link from the resource where it is found to another resource or action that may be performed.
properties:
rel:
type: string
title: Rel
description: As with an HTML 'rel' attribute, this describes the type of link.
readOnly: true
href:
type: string
title: Href
description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action.
readOnly: true
method:
type: string
title: Method
description: The HTTP method that should be used when accessing the URL defined in 'href'.
enum:
- GET
- POST
- PUT
- PATCH
- DELETE
- OPTIONS
- HEAD
readOnly: true
targetSchema:
type: string
title: Target Schema
description: For GETs, this is a URL representing the schema that the response should conform to.
readOnly: true
schema:
type: string
title: Schema
description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to.
readOnly: true
readOnly: true
default:
description: An error generated by the Mailchimp API.
content:
application/json:
schema:
type: object
title: Problem Detail Document
description: An error generated by the Mailchimp API. Conforms to IETF draft 'draft-nottingham-http-problem-06'.
required:
- type
- title
- status
- detail
- instance
properties:
type:
type: string
title: Problem Type
description: An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type.
example: https://mailchimp.com/developer/marketing/docs/errors/
title:
type: string
title: Error Title
description: A short, human-readable summary of the problem type. It shouldn't change based on the occurrence of the problem, except for purposes of localization.
example: Resource Not Found
status:
type: integer
title: HTTP Status Code
description: The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem.
example: 404
detail:
type: string
title: Error Message
description: A human-readable explanation specific to this occurrence of the problem. [Learn more about errors](/developer/guides/get-started-with-mailchimp-api-3/#Errors).
example: The requested resource could not be found.
instance:
type: string
title: Instance ID
description: A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support.
example: 995c5cb0-3280-4a6e-808b-3b096d0bb219
application/problem+json:
schema:
type: object
title: Problem Detail Document
description: An error generated by the Mailchimp API. Conforms to IETF draft 'draft-nottingham-http-problem-06'.
required:
- type
- title
- status
- detail
- instance
properties:
type:
type: string
title: Problem Type
description: An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type.
example: https://mailchimp.com/developer/marketing/docs/errors/
title:
type: string
title: Error Title
description: A short, human-readable summary of the problem type. It shouldn't change based on the occurrence of the problem, except for purposes of localization.
example: Resource Not Found
status:
type: integer
title: HTTP Status Code
description: The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem.
example: 404
detail:
type: string
title: Error Message
description: A human-readable explanation specific to this occurrence of the problem. [Learn more about errors](/developer/guides/get-started-with-mailchimp-api-3/#Errors).
example: The requested resource could not be found.
instance:
type: string
title: Instance ID
description: A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support.
example: 995c5cb0-3280-4a6e-808b-3b096d0bb219
deprecated: false
tags:
- sms-campaigns
x-custom-config:
methodNameSnake: list
methodNameCamel: list
post:
summary: Add SMS campaign
description: Create a new SMS campaign.
operationId: postSmsCampaigns
responses:
'200':
description: ''
content:
application/json:
schema:
type: object
title: SMS Campaign
description: A single SMS campaign.
properties:
id:
type: string
title: Campaign ID
description: A string that uniquely identifies this campaign.
readOnly: true
web_id:
type: string
title: Campaign Web ID
description: The ID used in the Mailchimp web application.
readOnly: true
name:
type: string
title: Campaign Name
description: The name of the campaign.
status:
type: string
title: Campaign Status
description: The current status of the campaign.
readOnly: true
channel:
type: string
title: Campaign Channel
description: The channel for this campaign (sms or whatsapp).
readOnly: true
list_id:
type: integer
title: List ID
description: The numeric ID of the list associated with this campaign.
readOnly: true
recipient_count:
type: integer
title: Recipient Count
description: The number of recipients for this campaign.
readOnly: true
create_time:
type: string
format: date-time
title: Create Time
description: The date and time the campaign was created in ISO 8601 format.
readOnly: true
send_time:
type: string
format: date-time
title: Send Time
description: The date and time the campaign is scheduled to send.
readOnly: true
updated_at:
type: string
format: date-time
title: Updated At
description: The date and time the campaign was last updated.
readOnly: true
expire_time:
type: string
format: date-time
title: Expire Time
description: The date and time the campaign will stop sending in ISO 8601 format.
readOnly: true
is_send_now:
type: boolean
title: Is Send Now
description: Whether the campaign is configured to send immediately.
readOnly: true
folder_id:
type: string
title: Folder ID
description: The ID of the folder this campaign is in.
segments:
type: array
title: Segments
description: The segment IDs used to target recipients for this campaign.
items:
type: integer
excluded_segments:
type: array
title: Excluded Segments
description: The segment IDs excluded from receiving this campaign.
items:
type: integer
_links:
title: Links
description: A list of link types and descriptions for the API schema documents.
type: array
items:
type: object
title: Resource Link
description: This object represents a link from the resource where it is found to another resource or action that may be performed.
properties:
rel:
type: string
title: Rel
description: As with an HTML 'rel' attribute, this describes the type of link.
readOnly: true
href:
type: string
title: Href
description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action.
readOnly: true
method:
type: string
title: Method
description: The HTTP method that should be used when accessing the URL defined in 'href'.
enum:
- GET
- POST
- PUT
- PATCH
- DELETE
- OPTIONS
- HEAD
readOnly: true
targetSchema:
type: string
title: Target Schema
description: For GETs, this is a URL representing the schema that the response should conform to.
readOnly: true
schema:
type: string
title: Schema
description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to.
readOnly: true
readOnly: true
application/problem+json:
schema:
type: object
title: SMS Campaign
description: A single SMS campaign.
properties:
id:
type: string
title: Campaign ID
description: A string that uniquely identifies this campaign.
readOnly: true
web_id:
type: string
title: Campaign Web ID
description: The ID used in the Mailchimp web application.
readOnly: true
name:
type: string
title: Campaign Name
description: The name of the campaign.
status:
type: string
title: Campaign Status
description: The current status of the campaign.
readOnly: true
channel:
type: string
title: Campaign Channel
description: The channel for this campaign (sms or whatsapp).
readOnly: true
list_id:
type: integer
title: List ID
description: The numeric ID of the list associated with this campaign.
readOnly: true
recipient_count:
type: inte
# --- truncated at 32 KB (155 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/mailchimp/refs/heads/main/openapi/mailchimp-sms-campaigns-api-openapi.yml