openapi: 3.0.3
info:
title: ActiveCampaign SMS Broadcast Accounts Groups 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: Groups
paths:
/groupMembers:
post:
summary: ActiveCampaign Add Custom Field to Field Group
description: ''
operationId: add-custom-field-to-field-group
requestBody:
content:
application/json:
schema:
type: object
properties:
groupMember:
properties:
rel_id:
type: integer
description: Custom field ID
format: int32
ordernum:
type: integer
description: Order within the field group, use null to append
format: int32
group_id:
type: integer
default: null
format: int32
required: []
type: object
examples:
POST:
value:
groupMember:
rel_id: '10'
ordernum: null
group_id: '1'
responses:
'200':
description: '200'
content:
application/json:
examples:
Result:
value: "{\n \"groupMember\": {\n \"id\": 87,\n \"group_id\": 1,\n \"rel_id\": 10,\n \"ordernum\": 18,\n \"created_by\": 1,\n \"updated_by\": 1,\n \"links\": {\n \"groupDefinition\": \"https://yourAccounut.api-us1.com/api/3/groupDefinitions/1\"\n }\n }\n}"
schema:
type: object
properties:
groupMember:
type: object
properties:
id:
type: integer
example: 87
default: 0
group_id:
type: integer
example: 1
default: 0
rel_id:
type: integer
example: 10
default: 0
ordernum:
type: integer
example: 18
default: 0
created_by:
type: integer
example: 1
default: 0
updated_by:
type: integer
example: 1
default: 0
links:
type: object
properties:
groupDefinition:
type: string
example: https://yourAccounut.api-us1.com/api/3/groupDefinitions/1
'403':
description: '403'
content:
application/json:
examples:
rel_id left blank:
value: "{\n \"message\": \"Client error: `POST https://escape-velocity-grouper.cluster-private.app-us1.com/member` resulted in a `400 Bad Request` response:\\n{\\\"message\\\": {\\\"rel_id\\\": \\\"rel_id is required\\\"}}\\n\\n\"\n}"
schema:
type: object
properties:
message:
type: string
example: 'Client error: `POST https://escape-velocity-grouper.cluster-private.app-us1.com/member` resulted in a `400 Bad Request` response:
{"message": {"rel_id": "rel_id is required"}}
'
'404':
description: '404'
content:
application/json:
examples:
Result:
value: "{\n \"message\": \"No Result found for GroupDefinition with id 94\"\n}"
schema:
type: object
properties:
message:
type: string
example: No Result found for GroupDefinition with id 94
'422':
description: '422'
content:
application/json:
examples:
Result:
value: "{\n \"errors\": [\n {\n \"title\": \"The field title was not provided.\",\n \"detail\": \"\",\n \"code\": \"field_missing\"\n }\n ]\n}"
schema:
type: object
properties:
errors:
type: array
items:
type: object
properties:
title:
type: string
example: The field title was not provided.
detail:
type: string
example: ''
code:
type: string
example: field_missing
deprecated: false
tags:
- Groups
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
get:
summary: ActiveCampaign Get All Custom Field Groups
description: ''
operationId: get-all-custom-field-groups
responses:
'200':
description: '200'
content:
application/json:
examples:
Result:
value: "{\n \"groupDefinitions\": [\n {\n \"id\": 1,\n \"type_id\": 1,\n \"label\": \"{**DEFAULT**}\",\n \"ordernum\": 1,\n \"links\": {\n \"groupMembers\": \"https://account.api-us1.com/api/3/groupMembers?group_id=1\",\n \"groupType\": \"https://account.api-us1.com/api/3/groupTypes/1\"\n }\n },\n {\n \"id\": 2,\n \"type_id\": 2,\n \"label\": \"{**DEAL_DEFAULT**}\",\n \"ordernum\": 2,\n \"links\": {\n \"groupMembers\": \"https://account.api-us1.com/api/3/groupMembers?group_id=2\",\n \"groupType\": \"https://account.api-us1.com/api/3/groupTypes/2\"\n }\n },\n {\n \"id\": 3,\n \"type_id\": 3,\n \"label\": \"{**ACCOUNT_DEFAULT**}\",\n \"ordernum\": 3,\n \"links\": {\n \"groupMembers\": \"https://account.api-us1.com/api/3/groupMembers?group_id=3\",\n \"groupType\": \"https://account.api-us1.com/api/3/groupTypes/3\"\n }\n },\n {\n \"id\": 21,\n \"type_id\": 1,\n \"label\": \"CustomName\",\n \"ordernum\": 3,\n \"links\": {\n \"groupMembers\": \"https://account.api-us1.com/api/3/groupMembers?group_id=21\",\n \"groupType\": \"https://account.api-us1.com/api/3/groupTypes/1\"\n }\n }\n ]\n}"
schema:
type: object
properties:
groupDefinitions:
type: array
items:
type: object
properties:
id:
type: integer
example: 1
default: 0
type_id:
type: integer
example: 1
default: 0
label:
type: string
example: '{**DEFAULT**}'
ordernum:
type: integer
example: 1
default: 0
links:
type: object
properties:
groupMembers:
type: string
example: https://account.api-us1.com/api/3/groupMembers?group_id=1
groupType:
type: string
example: https://account.api-us1.com/api/3/groupTypes/1
'400':
description: '400'
content:
application/json:
examples:
Result:
value: '{}'
schema:
type: object
properties: {}
deprecated: false
tags:
- Groups
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
/groupMembers/{groupID}:
delete:
summary: ActiveCampaign Delete Custom Field Field Group
description: ''
operationId: delete-custom-field-field-group
parameters:
- name: groupID
in: path
description: Group ID
schema:
type: string
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 \"errors\": [\n {\n \"status\": 404,\n \"title\": \"Not Found\"\n }\n ]\n}"
schema:
type: object
properties:
errors:
type: array
items:
type: object
properties:
status:
type: integer
example: 404
default: 0
title:
type: string
example: Not Found
deprecated: false
requestBody:
content:
application/json:
schema: {}
examples:
POST:
value:
groupMember:
rel_id: '10'
ordernum: null
group_id: '1'
tags:
- Groups
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
get:
summary: ActiveCampaign Get Custom Field Group by ID
description: ''
operationId: get-custom-field-to-field-group
parameters:
- name: groupID
in: path
description: Group ID
schema:
type: string
required: true
responses:
'200':
description: '200'
content:
application/json:
examples:
Result:
value: "{\n \"groupMember\": {\n \"id\": 89,\n \"group_id\": 1,\n \"rel_id\": 5,\n \"ordernum\": 20,\n \"links\": {\n \"groupDefinition\": \"https://:account.api-us1.com/api/3/groupDefinitions/1\"\n }\n }\n}"
schema:
type: object
properties:
groupMember:
type: object
properties:
id:
type: integer
example: 89
default: 0
group_id:
type: integer
example: 1
default: 0
rel_id:
type: integer
example: 5
default: 0
ordernum:
type: integer
example: 20
default: 0
links:
type: object
properties:
groupDefinition:
type: string
example: https://:account.api-us1.com/api/3/groupDefinitions/1
'404':
description: '404'
content:
application/json:
examples:
Result:
value: "{\n \"errors\": [\n {\n \"status\": 404,\n \"title\": \"Not Found\"\n }\n ]\n}"
schema:
type: object
properties:
errors:
type: array
items:
type: object
properties:
status:
type: integer
example: 404
default: 0
title:
type: string
example: Not Found
deprecated: false
requestBody:
content:
application/json:
schema: {}
examples:
POST:
value:
groupMember:
rel_id: '10'
ordernum: null
group_id: '1'
tags:
- Groups
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
/groupDefinitions:
post:
summary: ActiveCampaign Create a Custom Field Group
description: Create a Custom Field Group
operationId: create-a-custom-field-group
parameters:
- name: groupDefinition.label
in: query
description: Field Group Name
schema:
type: string
- name: groupDefinition.ordernum
in: query
description: The order the custom field group will be shown
schema:
type: integer
format: int32
- name: groupDefinition.groupType
in: query
description: The group type (see note)
schema:
type: integer
format: int32
requestBody:
content:
application/json:
schema:
type: object
properties:
groupDefinition:
type: string
responses:
'200':
description: '200'
content:
application/json:
examples:
Result:
value: "{\n \"groupDefinition\": {\n \"id\": 22,\n \"type_id\": 1,\n \"label\": \"Group Name Here\",\n \"ordernum\": 4,\n \"created_by\": 1,\n \"updated_by\": 1,\n \"links\": {\n \"groupMembers\": \"https://account.api-us1.com/api/3/groupMembers?group_id=22\",\n \"groupType\": \"https://account.api-us1.com/api/3/groupTypes/1\"\n }\n }\n}"
schema:
type: object
properties:
groupDefinition:
type: object
properties:
id:
type: integer
example: 22
default: 0
type_id:
type: integer
example: 1
default: 0
label:
type: string
example: Group Name Here
ordernum:
type: integer
example: 4
default: 0
created_by:
type: integer
example: 1
default: 0
updated_by:
type: integer
example: 1
default: 0
links:
type: object
properties:
groupMembers:
type: string
example: https://account.api-us1.com/api/3/groupMembers?group_id=22
groupType:
type: string
example: https://account.api-us1.com/api/3/groupTypes/1
'400':
description: '400'
content:
application/json:
examples:
Result:
value: '{}'
schema:
type: object
properties: {}
deprecated: false
tags:
- Groups
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
/groupMembers/{groupId}:
put:
summary: ActiveCampaign Update Custom Field Field Group
description: ''
operationId: update-custom-field-field-group
parameters:
- name: groupId
in: path
description: Field group ID (see notes)
schema:
type: string
required: true
requestBody:
content:
application/json:
schema:
type: object
properties:
rel_id:
type: integer
description: Custom field ID
format: int32
ordernum:
type: integer
description: Order within the field group, use null to append
format: int32
group_id:
type: integer
default: null
format: int32
examples:
POST:
value:
groupMember:
rel_id: '10'
ordernum: null
group_id: '1'
responses:
'200':
description: '200'
content:
application/json:
examples:
Result:
value: "{\n \"groupMember\": {\n \"id\": 87,\n \"group_id\": 1,\n \"rel_id\": 10,\n \"ordernum\": 18,\n \"created_by\": 1,\n \"updated_by\": 1,\n \"links\": {\n \"groupDefinition\": \"https://yourAccounut.api-us1.com/api/3/groupDefinitions/1\"\n }\n }\n}"
schema:
type: object
properties:
groupMember:
type: object
properties:
id:
type: integer
example: 87
default: 0
group_id:
type: integer
example: 1
default: 0
rel_id:
type: integer
example: 10
default: 0
ordernum:
type: integer
example: 18
default: 0
created_by:
type: integer
example: 1
default: 0
updated_by:
type: integer
example: 1
default: 0
links:
type: object
properties:
groupDefinition:
type: string
example: https://yourAccounut.api-us1.com/api/3/groupDefinitions/1
'403':
description: '403'
content:
application/json:
examples:
rel_id left blank:
value: "{\n \"message\": \"Client error: `POST https://escape-velocity-grouper.cluster-private.app-us1.com/member` resulted in a `400 Bad Request` response:\\n{\\\"message\\\": {\\\"rel_id\\\": \\\"rel_id is required\\\"}}\\n\\n\"\n}"
schema:
type: object
properties:
message:
type: string
example: 'Client error: `POST https://escape-velocity-grouper.cluster-private.app-us1.com/member` resulted in a `400 Bad Request` response:
{"message": {"rel_id": "rel_id is required"}}
'
'404':
description: '404'
content:
application/json:
examples:
Result:
value: "{\n \"message\": \"No Result found for GroupDefinition with id 94\"\n}"
schema:
type: object
properties:
message:
type: string
example: No Result found for GroupDefinition with id 94
'422':
description: '422'
content:
application/json:
examples:
Result:
value: "{\n \"errors\": [\n {\n \"title\": \"The field title was not provided.\",\n \"detail\": \"\",\n \"code\": \"field_missing\"\n }\n ]\n}"
schema:
type: object
properties:
errors:
type: array
items:
type: object
properties:
title:
type: string
example: The field title was not provided.
detail:
type: string
example: ''
code:
type: string
example: field_missing
deprecated: false
tags:
- Groups
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
/groups:
post:
summary: ActiveCampaign Create a Group
description: ''
operationId: create-a-new-group
requestBody:
content:
application/json:
schema:
type: object
properties:
group:
properties:
title:
type: string
description: Title of the group to be created
descript:
type: string
description: Group description
pgMessageAdd:
type: boolean
description: Permission for adding messages
default: false
unsubscribelink:
type: boolean
description: Whether or not to force unsubscribe links
default: false
optinconfirm:
type: boolean
description: Whether or not to force optin confirm for this group
default: false
pgListAdd:
type: boolean
description: Permission for adding lists
default: false
pgListEdit:
type: boolean
description: Permission for editing lists
default: false
pgListDelete:
type: boolean
description: Permission for deleting lists
default: false
pgListHeaders:
type: boolean
description: Permission for managing custom email headers
default: false
pgListEmailaccount:
type: boolean
description: Permission for managing Unsubscribe By Email
default: false
pgListBounce:
type: boolean
description: Permission for accessing list bounce settings
default: false
pgMessageEdit:
type: boolean
description: Permission for editing messages
default: false
pgMessageDelete:
type: boolean
description: Permission for deleting messages
default: false
pgMessageSend:
type: boolean
description: Permission for sending messages
default: false
pgContactAdd:
type: boolean
description: Permission for adding contacts
default: false
pgContactEdit:
type: boolean
description: Permission for editing contacts
default: false
pgContactDelete:
type: boolean
description: Permission for deleting contacts
default: false
pgContactMerge:
type: boolean
description: Permission for merging contacts
default: false
pgContactImport:
type: boolean
description: Permission for importing contacts
default: false
pgContactApprove:
type: boolean
description: Permission for approving contacts
default: false
pgContactExport:
type: boolean
description: Permission for exporting contacts
default: false
pgContactSync:
type: boolean
description: Permission for syncing contacts
default: false
pgContactFilters:
type: boolean
description: Permission for managing contact list segments
default: false
pgContactActions:
type: boolean
description: Permission for managing contact actions
default: false
pgContactFields:
type: boolean
description: Permission for managing contact custom fields
default: false
pg_user_add:
type: boolean
description: Permission for adding users
default: false
pg_user_edit:
type: boolean
description: Permission for editing users
default: false
pg_user_delete:
type: boolean
description: Permission for deleting users
default: false
pgGroupAdd:
type: boolean
description: Permission for adding groups
default: false
pgGroupEdit:
type: boolean
description: Permission for editing groups
default: false
pgGroupDelete:
type: boolean
description: Permission for deleting groups
default: false
pgTemplateAdd:
type: boolean
description: Permission for adding templates
default: false
pgTemplateEdit:
type: boolean
description: Permission for editing templates
default: false
pgTemplateDelete:
type: boolean
description: Permission for deleting templates
default: false
pgPersonalizationAdd:
type: boolean
description: Permission for adding personalization tags
default: false
pgPersonalizationEdit:
type: boolean
description: Permission for editing personalization tags
default: false
pgPersonalizationDelete:
type: boolean
description: Permission for deleting personalization tags
default: false
pgAutomationManage:
type: boolean
default: false
pgFormEdit:
type: boolean
description: Permission for editing subscription forms
default: false
pgReportsCampaign:
type: boolean
description: Permission for viewing campaign reports
default: false
pgReportsList:
type: boolean
description: Permission for viewing list reports
default: false
pgReportsUser:
type: boolean
description: Permission for viewing user reports
default: false
pgStartupReports:
type: boolean
description: Campaign ID of last campaign report viewed to decide whether to show link on startup
default: false
pgReportsTrend:
type: boolean
description: Permission for viewing trend reports
default: false
pgStartupGettingstarted:
type: boolean
description: Whether or not to show the "getting started" tutorial on overview page
default: false
pgDeal:
type: boolean
description: Permission for viewing deals
default: false
pgDealDelete:
type: boolean
description: Permission for deleting deals
default: false
pgDealReassign:
type: boolean
description: Permission for reassigning deals
default: false
pgDealGroupAdd:
type: boolean
description: Permission for adding deal groups
default: false
pgDealGroupEdit:
type: boolean
description: Permission for editing deal groups
default: false
pgDealGroupDelete:
type: boolean
description: Permission for deleting deals groups
default: false
pgSavedResponsesManage:
type: boolean
description: Permission for managing saved responses
default: false
pgTagManage:
type: boolean
description: Permission for managing tags
default: false
reqApproval:
type: boolean
description: Whether or not this group requires all campaigns to be approved
default: false
reqApproval1st:
type: boolean
description: Whether or not this group requires first campaign to be approved
default: false
reqApprovalNotify:
type: string
# --- truncated at 32 KB (103 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/activecampaign/refs/heads/main/openapi/activecampaign-groups-api-openapi.yml