openapi: 3.0.3
info:
title: ActiveCampaign SMS Broadcast Accounts Addresses 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: Addresses
paths:
/addresses:
post:
summary: ActiveCampaign Create an Address
description: ''
operationId: create-an-address
requestBody:
content:
application/json:
schema:
type: object
properties:
address:
properties:
groupid:
type: integer
format: int32
global:
type: string
company_name:
type: string
address_1:
type: string
address_2:
type: string
city:
type: string
state:
type: string
zip:
type: string
district:
type: string
description: (Optional for countries that use it)
country:
type: string
description: Accepts a (2) two character string - country code (eg 'US', 'CA', 'MX')
allgroup:
type: integer
format: int32
is_default:
type: boolean
description: Indicates default address
required:
- company_name
- address_1
- country
type: object
examples:
Request Example:
value:
address:
company_name: TEST NAME
address_1: TEST ADDRESS
country: US
responses:
'200':
description: '200'
content:
application/json:
examples:
Result:
value: "{\n \"address\": {\n \"companyName\": \"TEST NAME\",\n \"address1\": \"TEST ADDRESS\",\n \"country\": 3,\n \"links\": {\n \"addressGroup\": \"https://:account.api-us1.com/api/3/addresses/3/addressGroup\",\n \"addressList\": \"https://:account.api-us1.com/api/3/addresses/3/addressList\",\n \"forms\": \"https://:account.api-us1.com/api/3/addresses/3/forms\"\n },\n \"id\": \"3\"\n }\n}"
schema:
type: object
properties:
address:
type: object
properties:
companyName:
type: string
example: TEST NAME
address1:
type: string
example: TEST ADDRESS
country:
type: integer
example: 3
default: 0
links:
type: object
properties:
addressGroup:
type: string
example: https://:account.api-us1.com/api/3/addresses/3/addressGroup
addressList:
type: string
example: https://:account.api-us1.com/api/3/addresses/3/addressList
forms:
type: string
example: https://:account.api-us1.com/api/3/addresses/3/forms
id:
type: string
example: '3'
'400':
description: '400'
content:
application/json:
examples:
Result:
value: '{}'
schema:
type: object
properties: {}
deprecated: false
tags:
- Addresses
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
get:
summary: ActiveCampaign List All Addresses
description: ''
operationId: list-all-addresses
responses:
'200':
description: '200'
content:
application/json:
examples:
GET /addresses (Example RESPONSE):
value: "{\n \"addresses\": [\n {\n \"companyName\": \"Test Company Name\",\n \"address1\": \"Test Address\",\n \"address2\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"district\": \"\",\n \"zip\": \"\",\n \"country\": \"US\",\n \"allgroup\": \"0\",\n \"isDefault\": \"1\",\n \"links\": {\n \"addressGroup\": \"https://:account.api-us1.com/api/3/addresses/1/addressGroup\",\n \"addressList\": \"https://:account.api-us1.com/api/3/addresses/1/addressList\",\n \"forms\": \"https://:account.api-us1.com/api/3/addresses/1/forms\"\n },\n \"id\": \"1\"\n },\n {\n \"companyName\": \"TEST NAME\",\n \"address1\": \"TEST ADDRESS\",\n \"address2\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"district\": \"\",\n \"zip\": \"\",\n \"country\": \"US\",\n \"allgroup\": \"0\",\n \"isDefault\": \"0\",\n \"links\": {\n \"addressGroup\": \"https://:account.api-us1.com/api/3/addresses/2/addressGroup\",\n \"addressList\": \"https://:account.api-us1.com/api/3/addresses/2/addressList\",\n \"forms\": \"https://:account.api-us1.com/api/3/addresses/2/forms\"\n },\n \"id\": \"2\"\n }\n ],\n \"meta\": {\n \"total\": \"2\"\n }\n}"
schema:
type: object
properties:
addresses:
type: array
items:
type: object
properties:
companyName:
type: string
example: Test Company Name
address1:
type: string
example: Test Address
address2:
type: string
example: ''
city:
type: string
example: ''
state:
type: string
example: ''
district:
type: string
example: ''
zip:
type: string
example: ''
country:
type: string
example: US
allgroup:
type: string
example: '0'
isDefault:
type: string
example: '1'
links:
type: object
properties:
addressGroup:
type: string
example: https://:account.api-us1.com/api/3/addresses/1/addressGroup
addressList:
type: string
example: https://:account.api-us1.com/api/3/addresses/1/addressList
forms:
type: string
example: https://:account.api-us1.com/api/3/addresses/1/forms
id:
type: string
example: '1'
meta:
type: object
properties:
total:
type: string
example: '2'
'400':
description: '400'
content:
application/json:
examples:
Result:
value: '{}'
schema:
type: object
properties: {}
deprecated: false
tags:
- Addresses
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
/addresses/{id}:
get:
summary: ActiveCampaign Retrieve an Address
description: ''
operationId: retrieve-an-address
parameters:
- name: id
in: path
description: ID of the Address to retrieve
schema:
type: integer
format: int32
required: true
responses:
'200':
description: '200'
content:
application/json:
examples:
Result:
value: "{\n \"address\": {\n \"companyName\": \"Test Company Name\",\n \"address1\": \"Test Address\",\n \"address2\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"district\": \"\",\n \"zip\": \"\",\n \"country\": \"US\",\n \"allgroup\": \"0\",\n \"isDefault\": \"1\",\n \"links\": {\n \"addressGroup\": \"https://:account.api-us1.com/api/3/addresses/1/addressGroup\",\n \"addressList\": \"https://:account.api-us1.com/api/3/addresses/1/addressList\",\n \"forms\": \"https://:account.api-us1.com/api/3/addresses/1/forms\"\n },\n \"id\": \"1\"\n }\n}"
schema:
type: object
properties:
address:
type: object
properties:
companyName:
type: string
example: Test Company Name
address1:
type: string
example: Test Address
address2:
type: string
example: ''
city:
type: string
example: ''
state:
type: string
example: ''
district:
type: string
example: ''
zip:
type: string
example: ''
country:
type: string
example: US
allgroup:
type: string
example: '0'
isDefault:
type: string
example: '1'
links:
type: object
properties:
addressGroup:
type: string
example: https://:account.api-us1.com/api/3/addresses/1/addressGroup
addressList:
type: string
example: https://:account.api-us1.com/api/3/addresses/1/addressList
forms:
type: string
example: https://:account.api-us1.com/api/3/addresses/1/forms
id:
type: string
example: '1'
'400':
description: '400'
content:
application/json:
examples:
Result:
value: '{}'
schema:
type: object
properties: {}
deprecated: false
tags:
- Addresses
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
put:
summary: ActiveCampaign Update an Address
description: ''
operationId: update-an-address
parameters:
- name: id
in: path
description: ID of the Address being changed
schema:
type: integer
format: int32
required: true
requestBody:
content:
application/json:
schema:
type: object
properties:
address:
properties:
groupid:
type: integer
format: int32
global:
type: string
company_name:
type: string
address_1:
type: string
address_2:
type: string
city:
type: string
state:
type: string
zip:
type: string
district:
type: string
description: (Optional for countries that use it)
country:
type: string
description: Accepts a (2) two character string - country code (eg 'US', 'CA', 'MX')
allgroup:
type: integer
format: int32
is_default:
type: boolean
description: Indicates default address
required:
- company_name
- address_1
- country
type: object
examples:
Request Example:
value:
address:
companyName: New Test Company Name
address1: 111 New Test Address
address2: ''
city: New Test City
state: Florida
zip: '12345'
country: US
responses:
'200':
description: '200'
content:
application/json:
examples:
Result:
value: "{\n \"address\": {\n \"companyName\": \"New Test Company Name\",\n \"address1\": \"111 New Test Address\",\n \"address2\": \"\",\n \"city\": \"New Test City\",\n \"state\": \"Florida\",\n \"district\": \"\",\n \"zip\": \"12345\",\n \"country\": \"US\",\n \"allgroup\": \"0\",\n \"isDefault\": \"1\",\n \"links\": {\n \"addressGroup\": \"https://:account.api-us1.com/api/3/addresses/1/addressGroup\",\n \"addressList\": \"https://:account.api-us1.com/api/3/addresses/1/addressList\",\n \"forms\": \"https://:account.api-us1.com/api/3/addresses/1/forms\"\n },\n \"id\": \"1\"\n }\n}"
schema:
type: object
properties:
address:
type: object
properties:
companyName:
type: string
example: New Test Company Name
address1:
type: string
example: 111 New Test Address
address2:
type: string
example: ''
city:
type: string
example: New Test City
state:
type: string
example: Florida
district:
type: string
example: ''
zip:
type: string
example: '12345'
country:
type: string
example: US
allgroup:
type: string
example: '0'
isDefault:
type: string
example: '1'
links:
type: object
properties:
addressGroup:
type: string
example: https://:account.api-us1.com/api/3/addresses/1/addressGroup
addressList:
type: string
example: https://:account.api-us1.com/api/3/addresses/1/addressList
forms:
type: string
example: https://:account.api-us1.com/api/3/addresses/1/forms
id:
type: string
example: '1'
'404':
description: '404'
content:
application/json:
examples:
Result:
value: "{\n \"message\": \"No Result found for Address with id 3\"\n}"
schema:
type: object
properties:
message:
type: string
example: No Result found for Address with id 3
deprecated: false
tags:
- Addresses
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
delete:
summary: ActiveCampaign Delete an Address
description: ''
operationId: delete-an-address
parameters:
- name: id
in: path
description: ID of the Address to delete
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 Address with id 3\"\n}"
schema:
type: object
properties:
message:
type: string
example: No Result found for Address with id 3
deprecated: false
tags:
- Addresses
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
/addressGroups/{id}:
delete:
summary: ActiveCampaign Delete Address Associated with a Specific User Group
description: ''
operationId: delete-an-addressgroup
parameters:
- name: id
in: path
description: ID of the AddressGroup to delete
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 AddressGroup with id 19\"\n}"
schema:
type: object
properties:
message:
type: string
example: No Result found for AddressGroup with id 19
deprecated: false
tags:
- Addresses
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
/addressLists/{id}:
delete:
summary: ActiveCampaign Delete Address Associated with a Specific List
description: ''
operationId: delete-an-addresslist
parameters:
- name: id
in: path
description: ID of the AddressList to delete
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 AddressList with id 6\"\n}"
schema:
type: object
properties:
message:
type: string
example: No Result found for AddressList with id 6
deprecated: false
tags:
- Addresses
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
components:
securitySchemes:
ApiToken:
type: apiKey
name: Api-Token
in: header
description: Your ActiveCampaign API token