openapi: 3.0.3 info: title: ActiveCampaign SMS Broadcast Accounts Messages API description: API for managing SMS broadcasts, lists, metrics, and AI-powered content generation in ActiveCampaign version: 3.0.0 contact: name: ActiveCampaign Support url: https://www.activecampaign.com x-generated-from: documentation servers: - url: https://{yourAccountName}.api-us1.com/api/3 description: US-based Users variables: yourAccountName: default: yourAccountName security: - ApiToken: [] tags: - name: Messages paths: /messages: post: summary: ActiveCampaign Create a Message description: '' operationId: create-a-new-message requestBody: content: application/json: schema: type: object properties: message: properties: fromname: type: string description: Name of sender email: type: string description: Email of sender reply2: type: string description: Reply email for the recipient to reply to subject: type: string description: Subject of message preheader_text: type: string description: Preheader Text required: - fromname - email - reply2 type: object examples: Request Example: value: message: fromname: AC Admin fromemail: noreply@example.com reply2: hello@example.com subject: You are subscribing to %LISTNAME% preheader_text: Pre-header Text responses: '201': description: '201' content: application/json: examples: Result: value: "{\n \"message\": {\n \"fromname\": \"AC Admin\",\n \"fromemail\": \"noreply@example.com\",\n \"reply2\": \"hello@example.com\",\n \"subject\": \"You are subscribing to %LISTNAME%\",\n \"preheader_text\": \"Pre-header Text\",\n \"text\": \"hello\",\n \"html\": \"
hello
\",\n \"links\": {\n \"user\": \"https://yourAccountName.api-us1.com/api/3/messages/28/user\",\n \"hyperlinks\": \"https://yourAccountName.api-us1.com/api/3/messages/28/hyperlinks\"\n },\n \"id\": \"28\"\n }\n}" schema: type: object properties: message: type: object properties: fromname: type: string example: AC Admin fromemail: type: string example: noreply@example.com reply2: type: string example: hello@example.com subject: type: string example: You are subscribing to %LISTNAME% preheader_text: type: string example: Pre-header Text text: type: string example: hello html: type: string example:
hello
links: type: object properties: user: type: string example: https://yourAccountName.api-us1.com/api/3/messages/28/user hyperlinks: type: string example: https://yourAccountName.api-us1.com/api/3/messages/28/hyperlinks id: type: string example: '28' '400': description: '400' content: application/json: examples: Result: value: '{}' schema: type: object properties: {} deprecated: false tags: - Messages x-microcks-operation: delay: 0 dispatcher: FALLBACK get: summary: ActiveCampaign List All Messages description: '' operationId: list-all-messages responses: '200': description: '200' content: application/json: examples: Result: value: "{\n \"messages\": [\n {\n \"userid\": \"1\",\n \"ed_instanceid\": \"0\",\n \"ed_version\": \"1\",\n \"cdate\": \"2018-08-17T09:47:38-05:00\",\n \"mdate\": \"2018-08-17T09:47:38-05:00\",\n \"name\": \"\",\n \"fromname\": \"John Doe\",\n \"fromemail\": \"noreply@example.com\",\n \"reply2\": \"hello@example.com\",\n \"priority\": \"3\",\n \"charset\": \"utf-8\",\n \"encoding\": \"quoted-printable\",\n \"format\": \"mime\",\n \"subject\": \"Update your subscription to %LISTNAME%\",\n \"preheader_text\": \"\",\n \"text\": \" \\n\\n**Update your subscription details for %LISTNAME%** \\n\\n \\n\\nYou or someone entering your email has requested to update your\\nsubscription details for the address %EMAIL%.\\n\\n**To update your subscription details click the link below.**\\n\\nUpdate My Subscription <%LINK%> \\n\\n \\n\\n{\\\"If you believe that this is a mistake and you did not intend on\\nupdating your subscription to this list, you can ignore this message and\\nnothing else will happen.\\\"|alang\\n\\n \",\n \"html\": \"\\n\\n\\n \\n \\n \\n Preview\\n \\n \\n\\n\\n
\\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n
 
\\n \\n \\n \\n \\n
\\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n
\\n \\n \\n \\n \\n
\\n \\n \\n \\n \\n
Update your subscription details for %LISTNAME%\\n
\\n
\\n
 
\\n \\n \\n \\n \\n
\\n \\n \\n \\n \\n
You or someone entering your email has requested to update your subscription details for the address %EMAIL%.
\\n
\\n
\\n \\n \\n \\n \\n
\\n \\n \\n \\n \\n \\n \\n \\n
To update your subscription details click the link below.
\\n \\n
\\n \\n
\\n
 
\\n
\\n
\\n \\n \\n \\n \\n
\\n \\n \\n \\n \\n
{\\\"If you believe that this is a mistake and you did not intend on updating your subscription to this list, you can ignore this message and nothing else will happen.\\\"|alang
\\n
\\n
\\n
\\n
 
\\n
\\n\\n\\n\",\n \"htmlfetch\": \"now\",\n \"textfetch\": \"now\",\n \"hidden\": \"0\",\n \"preview_mime\": \"\",\n \"preview_data\": null,\n \"links\": {\n \"user\": \"https://:account.api-us1.com/api/3/messages/2/user\"\n },\n \"id\": \"2\",\n \"user\": \"1\"\n },\n {\n \"userid\": \"1\",\n \"ed_instanceid\": \"1\",\n \"ed_version\": \"2\",\n \"cdate\": \"2018-08-17T13:47:32-05:00\",\n \"mdate\": \"2018-08-17T13:47:32-05:00\",\n \"name\": \"Please confirm your subscription to %LISTNAME%\",\n \"fromname\": \"AC Admin\",\n \"fromemail\": \"ac_test@activecampaign.com\",\n \"reply2\": \"\",\n \"priority\": \"3\",\n \"charset\": \"utf-8\",\n \"encoding\": \"8bit\",\n \"format\": \"mime\",\n \"subject\": \"Please confirm your subscription to %LISTNAME%\",\n \"preheader_text\": \"\",\n \"text\": \" \\n\\nThank you for subscribing to %LISTNAME%!\\n\\nYou or someone has subscribed to this list on %SUBDATE% using the\\naddress %EMAIL%.\\n\\nTo confirm that you wish to be subscribed, please click the link below:\\n\\nConfirm My Subscription <%CONFIRMLINK%> \\n\\nIf you believe that this is a mistake and you did not intend on\\nsubscribing to this list,\\nyou can ignore this message and nothing else will happen.\",\n \"html\": \"\\nPreview

Thank you for subscribing to %LISTNAME%!

You or someone has subscribed to this list on %SUBDATE% using the address %EMAIL%.

To confirm that you wish to be subscribed, please click the link below:

\\n

If you believe that this is a mistake and you did not intend on subscribing to this list,
you can ignore this message and nothing else will happen.

\\n\",\n \"htmlfetch\": \"now\",\n \"textfetch\": \"now\",\n \"hidden\": \"0\",\n \"preview_mime\": \"\",\n \"preview_data\": \"\",\n \"links\": {\n \"user\": \"https://:account.api-us1.com/api/3/messages/3/user\"\n },\n \"id\": \"3\",\n \"user\": \"1\"\n },\n {\n \"userid\": \"1\",\n \"ed_instanceid\": \"0\",\n \"ed_version\": \"1\",\n \"cdate\": \"2018-08-17T13:48:45-05:00\",\n \"mdate\": \"2018-08-17T13:48:45-05:00\",\n \"name\": \"testing\",\n \"fromname\": \"John Doe\",\n \"fromemail\": \"noreply@example.com\",\n \"reply2\": \"\",\n \"priority\": \"3\",\n \"charset\": \"utf-8\",\n \"encoding\": \"8bit\",\n \"format\": \"mime\",\n \"subject\": \"testing\",\n \"preheader_text\": \"\",\n \"text\": \"testing testing testing\",\n \"html\": \"
\\ntesting testing testing\",\n \"htmlfetch\": \"now\",\n \"textfetch\": \"now\",\n \"hidden\": \"0\",\n \"preview_mime\": \"\",\n \"preview_data\": null,\n \"links\": {\n \"user\": \"https://:account.api-us1.com/api/3/messages/4/user\"\n },\n \"id\": \"4\",\n \"user\": \"1\"\n }\n ],\n \"meta\": {\n \"total\": \"3\"\n }\n}" schema: type: object properties: messages: type: array items: type: object properties: userid: type: string example: '1' ed_instanceid: type: string example: '0' ed_version: type: string example: '1' cdate: type: string example: '2018-08-17T09:47:38-05:00' mdate: type: string example: '2018-08-17T09:47:38-05:00' name: type: string example: '' fromname: type: string example: John Doe fromemail: type: string example: noreply@example.com reply2: type: string example: hello@example.com priority: type: string example: '3' charset: type: string example: utf-8 encoding: type: string example: quoted-printable format: type: string example: mime subject: type: string example: Update your subscription to %LISTNAME% preheader_text: type: string example: '' text: type: string example: " \n\n**Update your subscription details for %LISTNAME%** \n\n \n\nYou or someone entering your email has requested to update your\nsubscription details for the address %EMAIL%.\n\n**To update your subscription details click the link below.**\n\nUpdate My Subscription <%LINK%> \n\n \n\n{\"If you believe that this is a mistake and you did not intend on\nupdating your subscription to this list, you can ignore this message and\nnothing else will happen.\"|alang\n\n " html: type: string example: "\n\n\n \n \n \n Preview\n \n \n\n\n
\n \n \n \n \n \n \n \n \n \n \n
 
\n \n \n \n \n
\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
\n \n \n \n \n
\n \n \n \n \n
Update your subscription details for %LISTNAME%\n
\n
\n
 
\n \n \n \n \n
\n \n \n \n \n
You or someone entering your email has requested to update your subscription details for the address %EMAIL%.
\n
\n
\n \n \n \n \n
\n \n \n \n \n \n \n \n
To update your subscription details click the link below.
\n \n
\n \n
\n
 
\n
\n
\n \n \n \n \n
\n \n \n \n \n
{\"If you believe that this is a mistake and you did not intend on updating your subscription to this list, you can ignore this message and nothing else will happen.\"|alang
\n
\n
\n
\n
 
\n
\n\n\n" htmlfetch: type: string example: now textfetch: type: string example: now hidden: type: string example: '0' preview_mime: type: string example: '' preview_data: {} links: type: object properties: user: type: string example: https://:account.api-us1.com/api/3/messages/2/user id: type: string example: '2' user: type: string example: '1' meta: type: object properties: total: type: string example: '3' '400': description: '400' content: application/json: examples: Result: value: '{}' schema: type: object properties: {} deprecated: false tags: - Messages x-microcks-operation: delay: 0 dispatcher: FALLBACK /messages/{id}: get: summary: ActiveCampaign Retrieve a Message description: '' operationId: retrieve-a-message parameters: - name: id in: path description: ID of the message to retrieve schema: type: string required: true responses: '200': description: '200' content: application/json: examples: Result: value: "{\n \"message\": {\n \"userid\": \"1\",\n \"ed_instanceid\": \"1\",\n \"ed_version\": \"2\",\n \"cdate\": \"2018-08-17T13:47:32-05:00\",\n \"mdate\": \"2018-08-17T13:47:32-05:00\",\n \"name\": \"Please confirm your subscription to %LISTNAME%\",\n \"fromname\": \"John Doe\",\n \"fromemail\": \"noreply@example.com\",\n \"reply2\": \"\",\n \"priority\": \"3\",\n \"charset\": \"utf-8\",\n \"encoding\": \"8bit\",\n \"format\": \"mime\",\n \"subject\": \"Please confirm your subscription to %LISTNAME%\",\n \"preheader_text\": \"\",\n \"text\": \" \\n\\nThank you for subscribing to %LISTNAME%!\\n\\nYou or someone has subscribed to this list on %SUBDATE% using the\\naddress %EMAIL%.\\n\\nTo confirm that you wish to be subscribed, please click the link below:\\n\\nConfirm My Subscription <%CONFIRMLINK%> \\n\\nIf you believe that this is a mistake and you did not intend on\\nsubscribing to this list,\\nyou can ignore this message and nothing else will happen.\",\n \"html\": \"\\nPreview

Thank you for subscribing to %LISTNAME%!

You or someone has subscribed to this list on %SUBDATE% using the address %EMAIL%.

To confirm that you wish to be subscribed, please click the link below:

\\n

If you believe that this is a mistake and you did not intend on subscribing to this list,
you can ignore this message and nothing else will happen.

\\n\",\n \"htmlfetch\": \"now\",\n \"textfetch\": \"now\",\n \"hidden\": \"0\",\n \"preview_mime\": \"\",\n \"preview_data\": \"\",\n \"links\": {\n \"user\": \"https://:account.api-us1.com/api/3/messages/3/user\"\n },\n \"id\": \"3\",\n \"user\": \"1\"\n }\n}" schema: type: object properties: message: type: object properties: userid: type: string example: '1' ed_instanceid: type: string example: '1' ed_version: type: string example: '2' cdate: type: string example: '2018-08-17T13:47:32-05:00' mdate: type: string example: '2018-08-17T13:47:32-05:00' name: type: string example: Please confirm your subscription to %LISTNAME% fromname: type: string example: John Doe fromemail: type: string example: noreply@example.com reply2: type: string example: '' priority: type: string example: '3' charset: type: string example: utf-8 encoding: type: string example: 8bit format: type: string example: mime subject: type: string example: Please confirm your subscription to %LISTNAME% preheader_text: type: string example: '' text: type: string example: " \n\nThank you for subscribing to %LISTNAME%!\n\nYou or someone has subscribed to this list on %SUBDATE% using the\naddress %EMAIL%.\n\nTo confirm that you wish to be subscribed, please click the link below:\n\nConfirm My Subscription <%CONFIRMLINK%> \n\nIf you believe that this is a mistake and you did not intend on\nsubscribing to this list,\nyou can ignore this message and nothing else will happen." html: type: string example: "\nPreview

Thank you for subscribing to %LISTNAME%!

You or someone has subscribed to this list on %SUBDATE% using the address %EMAIL%.

To confirm that you wish to be subscribed, please click the link below:

\n

If you believe that this is a mistake and you did not intend on subscribing to this list,
you can ignore this message and nothing else will happen.

\n" htmlfetch: type: string example: now textfetch: type: string example: now hidden: type: string example: '0' preview_mime: type: string example: '' preview_data: type: string example: '' links: type: object properties: user: type: string example: https://:account.api-us1.com/api/3/messages/3/user id: type: string example: '3' user: type: string example: '1' '404': description: '404' content: application/json: examples: Result: value: "{\n \"message\": \"No Result found for Message with id 10\"\n}" schema: type: object properties: message: type: string example: No Result found for Message with id 10 deprecated: false tags: - Messages x-microcks-operation: delay: 0 dispatcher: FALLBACK put: summary: ActiveCampaign Update a Message description: '' operationId: update-a-message parameters: - name: id in: path description: ID of the message to update schema: type: string required: true requestBody: content: application/json: schema: type: object properties: message: properties: fromname: type: string description: Name of sender fromemail: type: string description: Email of sender reply2: type: string description: Reply email for the recipient to reply to subject: type: string description: Subject of message preheader_text: type: string description: Preheader Text name: type: string description: Name of the message text: type: string description: Text content html: type: string description: HTML Content required: [] type: object examples: Request Example: value: message: fromname: John Doe fromemail: noreply@example.com reply2: hello@example.com subject: You are subscribing to %LISTNAME% preheader_text: Pre-header Text responses: '200': description: '200' content: application/json: examples: Result: value: "{\n \"message\": {\n \"userid\": \"0\",\n \"ed_instanceid\": \"0\",\n \"ed_version\": \"1\",\n \"cdate\": \"2024-08-06T16:31:45-05:00\",\n \"mdate\": \"2024-08-06T16:33:23-05:00\",\n \"name\": \"\",\n \"fromname\": \"AC Admin\",\n \"fromemail\": \"noreply@example.com\",\n \"reply2\": \"hello@example.com\",\n \"priority\": \"3\",\n \"charset\": \"utf-8\",\n \"encoding\": \"8bit\",\n \"format\": \"mime\",\n \"subject\": \"You are subscribing to %LISTNAME%\",\n \"preheader_text\": \"Pre-header Text\",\n \"text\": \"hello\",\n \"html\": \"
hello
\",\n \"htmlfetch\": \"now\",\n \"textfetch\": \"now\",\n \"hidden\": \"0\",\n \"preview_mime\": \"\",\n \"preview_data\": null,\n \"has_predictive_content\": \"0\",\n \"links\": {\n \"user\": \"https://accountName.api-us1.com/api/3/messages/56/user\",\n \"hyperlinks\": \"https://accountName.api-us1.com/api/3/messages/56/hyperlinks\"\n },\n \"id\": \"56\",\n \"user\": null\n }\n}" schema: type: object properties: message: type: object properties: userid: type: string example: '0' ed_instanceid: type: string example: '0' ed_version: type: string example: '1' cdate: type: string example: '2024-08-06T16:31:45-05:00' mdate: type: string example: '2024-08-06T16:33:23-05:00' name: type: string example: '' fromname: type: string example: AC Admin fromemail: type: string example: noreply@example.com reply2: type: string example: hello@example.com priority: type: string example: '3' charset: type: string example: utf-8 encoding: type: string example: 8bit format: type: string example: mime subject: type: string example: You are subscribing to %LISTNAME% preheader_text: type: string example: Pre-header Text text: type: string example: hello html: type: string example:
hello
htmlfetch: type: string example: now textfetch: type: string example: now hidden: type: string example: '0' preview_mime: type: string example: '' preview_data: {} has_predictive_content: type: string example: '0' links: type: object properties: user: type: string example: https://accountName.api-us1.com/api/3/messages/56/user hyperlinks: type: string example: https://accountName.api-us1.com/api/3/messages/56/hyperlinks id: type: string example: '56' user: {} '404': description: '404' content: application/json: examples: Result: value: "{\n \"message\": \"No Result found for Message with id 543\"\n}" schema: type: object properties: message: type: string example: No Result found for Message with id 543 deprecated: false tags: - Messages x-microcks-operation: delay: 0 dispatcher: FALLBACK delete: summary: ActiveCampaign Delete a Message description: '' operationId: delete-a-message parameters: - name: id in: path description: ID of the message to delete schema: type: string required: true responses: '200': description: '200' content: application/json: examples: Result: value: '{}' schema: type: object properties: {} '400': description: '400' content: application/json: examples: Result: value: '{}' schema: type: object properties: {} deprecated: false tags: - Messages x-microcks-operation: delay: 0 dispatcher: FALLBACK components: securitySchemes: ApiToken: type: apiKey name: Api-Token in: header description: Your ActiveCampaign API token