openapi: 3.0.3
info:
title: ActiveCampaign SMS Broadcast Accounts Tags 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: Tags
paths:
/tags:
post:
summary: ActiveCampaign Create a Tag
description: ''
operationId: create-a-new-tag
requestBody:
content:
application/json:
schema:
type: object
properties:
tag:
properties:
tag:
type: string
description: Name of the new tag
tagType:
type: string
description: 'Tag-type of the new tag. Possible Values: template, contact'
description:
type: string
description: Description of the new tag
required: []
type: object
examples:
Request Example:
value:
tag:
tag: My Tag
tagType: contact
description: Description
responses:
'201':
description: '201'
content:
application/json:
examples:
Result:
value: "{\n \"tag\": {\n \"tag\": \"My Tag\",\n \"description\": \"Description\",\n \"tagType\": \"contact\",\n \"cdate\": \"2018-09-29T19:21:25-05:00\",\n \"links\": {\n \"contactGoalTags\": \"https://:account.api-us1.com/api/:version/tags/16/contactGoalTags\"\n },\n \"id\": \"16\"\n }\n}"
schema:
type: object
properties:
tag:
type: object
properties:
tag:
type: string
example: My Tag
description:
type: string
example: Description
tagType:
type: string
example: contact
cdate:
type: string
example: '2018-09-29T19:21:25-05:00'
links:
type: object
properties:
contactGoalTags:
type: string
example: https://:account.api-us1.com/api/:version/tags/16/contactGoalTags
id:
type: string
example: '16'
deprecated: false
tags:
- Tags
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
get:
summary: ActiveCampaign List All Tags
description: ''
operationId: retrieve-all-tags
parameters:
- name: search
in: query
description: Filter by name of tag(s); "contains" operator is assumed.
schema:
type: string
- name: filters[search][<operator>]
in: query
description: 'Filters tags by tag name according to the operator specified. Operators currently supported: `eq`, `neq`, `lt`, `lte`, `gt`, `gte`, `contains`, `starts_with`'
schema:
type: string
- name: orders[search]
in: query
description: Orders filtered results by weight, ascending order, or descending order. If `weight` is used, exact matches are returned first, followed by matches starting with what was filtered by, followed by the rest of the results.
schema:
type: string
enum:
- weight
- asc
- desc
responses:
'200':
description: '200'
content:
application/json:
examples:
Result:
value: "{\n \"tags\": [\n {\n \"tagType\": \"contact\",\n \"tag\": \"one\",\n \"description\": \"\",\n \"cdate\": \"2018-08-17T09:43:15-05:00\",\n \"links\": {\n \"contactGoalTags\": \"https://:account.api-us1.com/api/:version/tags/1/contactGoalTags\"\n },\n \"id\": \"1\"\n },\n {\n \"tagType\": \"contact\",\n \"tag\": \"two\",\n \"description\": \"\",\n \"cdate\": \"2018-08-17T13:41:16-05:00\",\n \"links\": {\n \"contactGoalTags\": \"https://:account.api-us1.com/api/:version/tags/2/contactGoalTags\"\n },\n \"id\": \"2\"\n },\n {\n \"tagType\": \"contact\",\n \"tag\": \"three\",\n \"description\": \"\",\n \"cdate\": \"2018-08-17T13:41:18-05:00\",\n \"links\": {\n \"contactGoalTags\": \"https://:account.api-us1.com/api/:version/tags/3/contactGoalTags\"\n },\n \"id\": \"3\"\n },\n {\n \"tagType\": \"template\",\n \"tag\": \"test1\",\n \"description\": \"\",\n \"cdate\": \"2018-08-28T11:54:36-05:00\",\n \"links\": {\n \"contactGoalTags\": \"https://:account.api-us1.com/api/:version/tags/4/contactGoalTags\"\n },\n \"id\": \"4\"\n },\n {\n \"tagType\": \"template\",\n \"tag\": \"test2\",\n \"description\": \"\",\n \"cdate\": \"2018-08-28T11:54:38-05:00\",\n \"links\": {\n \"contactGoalTags\": \"https://:account.api-us1.com/api/:version/tags/5/contactGoalTags\"\n },\n \"id\": \"5\"\n }\n ],\n \"meta\": {\n \"total\": \"5\"\n }\n}"
schema:
type: object
properties:
tags:
type: array
items:
type: object
properties:
tagType:
type: string
example: contact
tag:
type: string
example: one
description:
type: string
example: ''
cdate:
type: string
example: '2018-08-17T09:43:15-05:00'
links:
type: object
properties:
contactGoalTags:
type: string
example: https://:account.api-us1.com/api/:version/tags/1/contactGoalTags
id:
type: string
example: '1'
meta:
type: object
properties:
total:
type: string
example: '5'
'400':
description: '400'
content:
application/json:
examples:
Result:
value: '{}'
schema:
type: object
properties: {}
deprecated: false
tags:
- Tags
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
/tags/{id}:
get:
summary: ActiveCampaign Retrieve a Tag
description: ''
operationId: retrieve-a-tag
parameters:
- name: id
in: path
description: ID of the tag to retrieve
schema:
type: integer
format: int32
required: true
responses:
'200':
description: '200'
content:
application/json:
examples:
Result:
value: "{\n \"tag\": {\n \"tagType\": \"contact\",\n \"tag\": \"My Tag\",\n \"description\": \"Description\",\n \"cdate\": \"2018-10-04T14:55:13-05:00\",\n \"subscriber_count\": \"0\",\n \"links\": {\n \"contactGoalTags\": \"https://:account.api-us1.com/api/3/tags/1/contactGoalTags\"\n },\n \"id\": \"1\"\n }\n}"
schema:
type: object
properties:
tag:
type: object
properties:
tagType:
type: string
example: contact
tag:
type: string
example: My Tag
description:
type: string
example: Description
cdate:
type: string
example: '2018-10-04T14:55:13-05:00'
subscriber_count:
type: string
example: '0'
links:
type: object
properties:
contactGoalTags:
type: string
example: https://:account.api-us1.com/api/3/tags/1/contactGoalTags
id:
type: string
example: '1'
'404':
description: '404'
content:
application/json:
examples:
Result:
value: "{\n \"message\": \"No Result found for Tag with id 1\"\n}"
schema:
type: object
properties:
message:
type: string
example: No Result found for Tag with id 1
deprecated: false
tags:
- Tags
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
put:
summary: ActiveCampaign Update a Tag
description: ''
operationId: update-a-tag
parameters:
- name: id
in: path
description: ID of the tag to update
schema:
type: integer
format: int32
required: true
requestBody:
content:
application/json:
schema:
type: object
properties:
tag:
properties:
tag:
type: string
description: Name of the tag being updated
tagType:
type: string
description: 'Tag-type of the tag being updated. Possible Values: template, contact'
description:
type: string
description: Description of the tag being updated
required: []
type: object
examples:
Request Example:
value:
tag:
tag: My Tag
tagType: contact
description: Description
responses:
'200':
description: '200'
content:
application/json:
examples:
Result:
value: "{\n \"tag\": {\n \"tagType\": \"contact\",\n \"tag\": \"My Tag\",\n \"description\": \"Description\",\n \"cdate\": \"2018-08-17T13:41:16-05:00\",\n \"links\": {\n \"contactGoalTags\": \"https://:account.api-us1.com/api/:version/tags/2/contactGoalTags\"\n },\n \"id\": \"2\"\n }\n}"
schema:
type: object
properties:
tag:
type: object
properties:
tagType:
type: string
example: contact
tag:
type: string
example: My Tag
description:
type: string
example: Description
cdate:
type: string
example: '2018-08-17T13:41:16-05:00'
links:
type: object
properties:
contactGoalTags:
type: string
example: https://:account.api-us1.com/api/:version/tags/2/contactGoalTags
id:
type: string
example: '2'
deprecated: false
tags:
- Tags
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
delete:
summary: ActiveCampaign Delete a Tag
description: ''
operationId: delete-a-tag
parameters:
- name: id
in: path
description: ID of the tag to remove
schema:
type: integer
format: int32
required: true
responses:
'200':
description: '200'
content:
application/json:
examples:
Result:
value: '{}'
schema:
type: object
properties: {}
'404':
description: '404'
content:
application/json:
examples:
Result:
value: "{\n \"message\": \"No Result found for Tag with id 1\"\n}"
schema:
type: object
properties:
message:
type: string
example: No Result found for Tag with id 1
deprecated: false
tags:
- Tags
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
components:
securitySchemes:
ApiToken:
type: apiKey
name: Api-Token
in: header
description: Your ActiveCampaign API token