openapi: 3.0.3
info:
title: ActiveCampaign SMS Broadcast Accounts Branding 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: Branding
paths:
/brandings/{id}:
get:
summary: ActiveCampaign Retrieve a Branding
description: Retrieve an existing branding resource
operationId: get-branding
parameters:
- name: id
in: path
schema:
type: integer
format: int32
default: null
required: true
responses:
'200':
description: '200'
content:
application/json:
examples:
Result:
value: "{\n\t\"branding\": {\n\t\t\"groupid\": \"3\",\n\t\t\"siteName\": \"ActiveCampaign Email Marketing\",\n\t\t\"siteLogo\": \"http:\\/\\/mysite.com\\/logo.jpg\",\n\t\t\"siteLogoSmall\": \"http:\\/\\/mysite.com\\/logo_small.jpg\",\n\t\t\"headerTextValue\": \"my custom text header\",\n\t\t\"headerHtmlValue\": \"<p>my custom HTML header<\\/p>\",\n\t\t\"footerTextValue\": \"my custom text footer\",\n\t\t\"footerHtmlValue\": \"<p>my custom HTML footer<\\/p>\",\n\t\t\"copyright\": \"1\",\n\t\t\"version\": \"1\",\n\t\t\"license\": \"1\",\n\t\t\"links\": \"1\",\n\t\t\"help\": \"1\",\n\t\t\"adminTemplateHtm\": \"\",\n\t\t\"adminTemplateCss\": \"\",\n\t\t\"publicTemplateHtm\": \"\",\n\t\t\"publicTemplateCss\": \"\",\n\t\t\"favicon\": null,\n\t\t\"id\": \"1\"\n\t}\n}"
schema:
type: object
properties:
branding:
type: object
properties:
groupid:
type: string
example: '3'
siteName:
type: string
example: ActiveCampaign Email Marketing
siteLogo:
type: string
example: http://mysite.com/logo.jpg
siteLogoSmall:
type: string
example: http://mysite.com/logo_small.jpg
headerTextValue:
type: string
example: my custom text header
headerHtmlValue:
type: string
example: <p>my custom HTML header</p>
footerTextValue:
type: string
example: my custom text footer
footerHtmlValue:
type: string
example: <p>my custom HTML footer</p>
copyright:
type: string
example: '1'
version:
type: string
example: '1'
license:
type: string
example: '1'
links:
type: string
example: '1'
help:
type: string
example: '1'
adminTemplateHtm:
type: string
example: ''
adminTemplateCss:
type: string
example: ''
publicTemplateHtm:
type: string
example: ''
publicTemplateCss:
type: string
example: ''
favicon: {}
id:
type: string
example: '1'
'400':
description: '400'
content:
application/json:
examples:
Result:
value: '{}'
schema:
type: object
properties: {}
deprecated: false
tags:
- Branding
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
put:
summary: ActiveCampaign Update a Branding
description: Update an existing branding resource
operationId: update-branding
parameters:
- name: id
in: path
description: Branding ID
schema:
type: integer
format: int32
default: 1
required: true
requestBody:
content:
application/json:
schema:
type: object
properties:
branding:
properties:
groupid:
type: integer
description: The group ID. This value will always be 3.
default: 3
format: int32
siteName:
type: string
description: 'Title of software. Example: ''ActiveCampaign Email Marketing'''
siteLogo:
type: string
siteLogoSmall:
type: string
description: URL of small logo. Small logos appear in the header of the admin panel.
headerTextValue:
type: string
description: 'Content of non-removable header. Example: text header content'
headerHtmlValue:
type: string
description: 'Content of non-removable header. Example: <p>header content here</p>'
footerTextValue:
type: string
description: 'Content of non-removeable footer. Example: text footer content'
footerHtmlValue:
type: string
description: 'Content of non-removeable footer. Example: <p>footer content here</p>'
copyright:
type: boolean
description: unknown
version:
type: boolean
description: unknown
license:
type: boolean
description: unknown
links:
type: boolean
description: External links. To enable (which is the default) exclude this parameter entirely. To disable (remove our branding), just pass this parameter with any value.
help:
type: string
adminTemplateHtm:
type: string
description: The actual HTML template (ONLY AVAILABLE FOR CERTAIN PLANS)
adminTemplateCss:
type: string
description: 'The actual CSS. Example: test color: green; (ONLY AVAILABLE FOR CERTAIN PLANS)'
publicTemplateHtm:
type: string
description: The actual HTML template (ONLY AVAILABLE FOR CERTAIN PLANS)
publicTemplateCss:
type: string
description: 'The actual CSS. Example: test color: green; (ONLY AVAILABLE FOR CERTAIN PLANS)'
favicon:
type: string
description: URL of the favicon.
required: []
type: object
responses:
'200':
description: '200'
content:
application/json:
examples:
Result:
value: "{\n\t\"branding\": {\n\t\t\"groupid\": \"3\",\n\t\t\"siteName\": \"ActiveCampaign Email Marketing\",\n\t\t\"siteLogo\": \"http:\\/\\/mysite.com\\/logo.jpg\",\n\t\t\"siteLogoSmall\": \"http:\\/\\/mysite.com\\/logo_small.jpg\",\n\t\t\"headerTextValue\": \"my custom text header\",\n\t\t\"headerHtmlValue\": \"<p>my custom HTML header<\\/p>\",\n\t\t\"footerTextValue\": \"my custom text footer\",\n\t\t\"footerHtmlValue\": \"<p>my custom HTML footer<\\/p>\",\n\t\t\"copyright\": \"1\",\n\t\t\"version\": \"1\",\n\t\t\"license\": \"1\",\n\t\t\"links\": \"1\",\n\t\t\"help\": \"1\",\n\t\t\"adminTemplateHtm\": \"\",\n\t\t\"adminTemplateCss\": \"\",\n\t\t\"publicTemplateHtm\": \"\",\n\t\t\"publicTemplateCss\": \"\",\n\t\t\"favicon\": null,\n\t\t\"id\": \"1\"\n\t}\n}"
schema:
type: object
properties:
branding:
type: object
properties:
groupid:
type: string
example: '3'
siteName:
type: string
example: ActiveCampaign Email Marketing
siteLogo:
type: string
example: http://mysite.com/logo.jpg
siteLogoSmall:
type: string
example: http://mysite.com/logo_small.jpg
headerTextValue:
type: string
example: my custom text header
headerHtmlValue:
type: string
example: <p>my custom HTML header</p>
footerTextValue:
type: string
example: my custom text footer
footerHtmlValue:
type: string
example: <p>my custom HTML footer</p>
copyright:
type: string
example: '1'
version:
type: string
example: '1'
license:
type: string
example: '1'
links:
type: string
example: '1'
help:
type: string
example: '1'
adminTemplateHtm:
type: string
example: ''
adminTemplateCss:
type: string
example: ''
publicTemplateHtm:
type: string
example: ''
publicTemplateCss:
type: string
example: ''
favicon: {}
id:
type: string
example: '1'
'400':
description: '400'
content:
application/json:
examples:
Result:
value: '{}'
schema:
type: object
properties: {}
deprecated: false
tags:
- Branding
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
/brandings:
get:
summary: ActiveCampaign List All Brandings
description: List all existing branding resources
operationId: brandings
parameters:
- name: api_key
in: query
description: ActiveCampaign API key
schema:
type: string
responses:
'200':
description: '200'
content:
application/json:
examples:
Result:
value: "{\n \"brandings\": [\n {\n\t\t\"groupid\": \"3\",\n\t\t\"siteName\": \"ActiveCampaign Email Marketing\",\n\t\t\"siteLogo\": \"http:\\/\\/mysite.com\\/logo.jpg\",\n\t\t\"siteLogoSmall\": \"http:\\/\\/mysite.com\\/logo_small.jpg\",\n\t\t\"headerTextValue\": \"my custom text header\",\n\t\t\"headerHtmlValue\": \"<p>my custom HTML header<\\/p>\",\n\t\t\"footerTextValue\": \"my custom text footer\",\n\t\t\"footerHtmlValue\": \"<p>my custom HTML footer<\\/p>\",\n\t\t\"copyright\": \"1\",\n\t\t\"version\": \"1\",\n\t\t\"license\": \"1\",\n\t\t\"links\": \"1\",\n\t\t\"help\": \"1\",\n\t\t\"adminTemplateHtm\": \"\",\n\t\t\"adminTemplateCss\": \"\",\n\t\t\"publicTemplateHtm\": \"\",\n\t\t\"publicTemplateCss\": \"\",\n\t\t\"favicon\": null,\n\t\t\"id\": \"1\"\n }\n ],\n \"meta\": {\n \"total\": \"1\"\n }\n}"
schema:
type: object
properties:
brandings:
type: array
items:
type: object
properties:
groupid:
type: string
example: '3'
siteName:
type: string
example: ActiveCampaign Email Marketing
siteLogo:
type: string
example: http://mysite.com/logo.jpg
siteLogoSmall:
type: string
example: http://mysite.com/logo_small.jpg
headerTextValue:
type: string
example: my custom text header
headerHtmlValue:
type: string
example: <p>my custom HTML header</p>
footerTextValue:
type: string
example: my custom text footer
footerHtmlValue:
type: string
example: <p>my custom HTML footer</p>
copyright:
type: string
example: '1'
version:
type: string
example: '1'
license:
type: string
example: '1'
links:
type: string
example: '1'
help:
type: string
example: '1'
adminTemplateHtm:
type: string
example: ''
adminTemplateCss:
type: string
example: ''
publicTemplateHtm:
type: string
example: ''
publicTemplateCss:
type: string
example: ''
favicon: {}
id:
type: string
example: '1'
meta:
type: object
properties:
total:
type: string
example: '1'
'400':
description: '400'
content:
application/json:
examples:
Result:
value: '{}'
schema:
type: object
properties: {}
deprecated: false
tags:
- Branding
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
components:
securitySchemes:
ApiToken:
type: apiKey
name: Api-Token
in: header
description: Your ActiveCampaign API token