{ "opencollection": "1.0.0", "info": { "name": "ActiveCampaign SMS Broadcast Accounts API", "version": "3.0.0" }, "request": { "auth": { "type": "apikey", "key": "Api-Token", "value": "{{Api-Token}}", "placement": "header" } }, "items": [ { "info": { "name": "Accounts", "type": "folder" }, "items": [ { "info": { "name": "ActiveCampaign List All Accounts", "type": "http" }, "http": { "method": "GET", "url": "https://{yourAccountName}.api-us1.com/api/3/accounts", "params": [ { "name": "search", "value": "", "type": "query", "description": "Search by name" }, { "name": "count_deals", "value": "", "type": "query", "description": "Whether to compute the contactCount and dealCount counts for the number of contacts/deals associated with each account. Set it to true to include the right counts. If set to false or omitted from the call, then contactCount and dealCount will not be counted and be simply displayed as 0." } ] }, "docs": "Retrieve all existing account" }, { "info": { "name": "ActiveCampaign Create an Account", "type": "http" }, "http": { "method": "POST", "url": "https://{yourAccountName}.api-us1.com/api/3/accounts", "body": { "type": "json", "data": "{}" } }, "docs": "Create a new account" }, { "info": { "name": "ActiveCampaign Retrieve an Account", "type": "http" }, "http": { "method": "GET", "url": "https://{yourAccountName}.api-us1.com/api/3/accounts/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "Account's ID" } ] }, "docs": "Retrieve an existing account" }, { "info": { "name": "ActiveCampaign Update an Account", "type": "http" }, "http": { "method": "PUT", "url": "https://{yourAccountName}.api-us1.com/api/3/accounts/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "Account's id" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update an existing account" }, { "info": { "name": "ActiveCampaign Delete an Account", "type": "http" }, "http": { "method": "DELETE", "url": "https://{yourAccountName}.api-us1.com/api/3/accounts/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "Account's id" } ] }, "docs": "Delete an existing account" }, { "info": { "name": "ActiveCampaign Create an Account Note", "type": "http" }, "http": { "method": "POST", "url": "https://{yourAccountName}.api-us1.com/api/3/accounts/:id/notes", "params": [ { "name": "id", "value": "", "type": "path", "description": "Account's id to assign new note to" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create a new note for an account" }, { "info": { "name": "ActiveCampaign Update an Account Note", "type": "http" }, "http": { "method": "PUT", "url": "https://{yourAccountName}.api-us1.com/api/3/accounts/:id/notes/:noteid", "params": [ { "name": "id", "value": "", "type": "path", "description": "Account's id to assign new note to" }, { "name": "noteid", "value": "", "type": "path", "description": "Account note's id to update" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update an existing note for a account" }, { "info": { "name": "ActiveCampaign Bulk Delete Accounts", "type": "http" }, "http": { "method": "DELETE", "url": "https://{yourAccountName}.api-us1.com/api/3/accounts/bulk_delete", "params": [ { "name": "[]ids", "value": "", "type": "query", "description": "An integer id of the account to be deleted" } ] }, "docs": "Delete an existing account" }, { "info": { "name": "ActiveCampaign List All Associations", "type": "http" }, "http": { "method": "GET", "url": "https://{yourAccountName}.api-us1.com/api/3/accountContacts", "params": [ { "name": "filters[contact]", "value": "", "type": "query", "description": "Filter by Contact ID" }, { "name": "filters[account]", "value": "", "type": "query", "description": "Filter by Account ID" } ] }, "docs": "Retrieve all existing account association" }, { "info": { "name": "ActiveCampaign Create an Association", "type": "http" }, "http": { "method": "POST", "url": "https://{yourAccountName}.api-us1.com/api/3/accountContacts", "body": { "type": "json", "data": "{}" } }, "docs": "Create a new account association" }, { "info": { "name": "ActiveCampaign Retrieve an Association", "type": "http" }, "http": { "method": "GET", "url": "https://{yourAccountName}.api-us1.com/api/3/accountContacts/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "Association's ID" } ] }, "docs": "Retrieve an existing account association" }, { "info": { "name": "ActiveCampaign Update an Association", "type": "http" }, "http": { "method": "PUT", "url": "https://{yourAccountName}.api-us1.com/api/3/accountContacts/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "Association's ID" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update an existing account association" }, { "info": { "name": "ActiveCampaign Delete an Association", "type": "http" }, "http": { "method": "DELETE", "url": "https://{yourAccountName}.api-us1.com/api/3/accountContacts/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "Association's ID" } ] }, "docs": "Delete an existing account association" }, { "info": { "name": "ActiveCampaign List All Custom Fields", "type": "http" }, "http": { "method": "GET", "url": "https://{yourAccountName}.api-us1.com/api/3/accountCustomFieldMeta", "params": [ { "name": "limit", "value": "", "type": "query", "description": "The number of fields returned per request." } ] }, "docs": "ActiveCampaign List All Custom Fields" }, { "info": { "name": "ActiveCampaign Create a Custom Field", "type": "http" }, "http": { "method": "POST", "url": "https://{yourAccountName}.api-us1.com/api/3/accountCustomFieldMeta", "body": { "type": "json", "data": "{}" } }, "docs": "ActiveCampaign Create a Custom Field" }, { "info": { "name": "ActiveCampaign Retrieve a Custom Field", "type": "http" }, "http": { "method": "GET", "url": "https://{yourAccountName}.api-us1.com/api/3/accountCustomFieldMeta/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "ID of the field to retrieve" } ] }, "docs": "ActiveCampaign Retrieve a Custom Field" }, { "info": { "name": "ActiveCampaign Update a Custom Field", "type": "http" }, "http": { "method": "PUT", "url": "https://{yourAccountName}.api-us1.com/api/3/accountCustomFieldMeta/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "ID of the custom field to update" } ], "body": { "type": "json", "data": "{}" } }, "docs": "ActiveCampaign Update a Custom Field" }, { "info": { "name": "ActiveCampaign Delete a Custom Field", "type": "http" }, "http": { "method": "DELETE", "url": "https://{yourAccountName}.api-us1.com/api/3/accountCustomFieldMeta/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "ID of the field to delete" } ] }, "docs": "ActiveCampaign Delete a Custom Field" }, { "info": { "name": "ActiveCampaign List All Custom Field Values", "type": "http" }, "http": { "method": "GET", "url": "https://{yourAccountName}.api-us1.com/api/3/accountCustomFieldData", "params": [ { "name": "filters[customerAccountId]", "value": "", "type": "query", "description": "Filter results by a specific account (note that Id uses a capital I)" } ] }, "docs": "ActiveCampaign List All Custom Field Values" }, { "info": { "name": "ActiveCampaign Create a Custom Field Value", "type": "http" }, "http": { "method": "POST", "url": "https://{yourAccountName}.api-us1.com/api/3/accountCustomFieldData", "body": { "type": "json", "data": "{}" } }, "docs": "ActiveCampaign Create a Custom Field Value" }, { "info": { "name": "ActiveCampaign Bulk Create a Custom Account Field Value", "type": "http" }, "http": { "method": "POST", "url": "https://{yourAccountName}.api-us1.com/api/3/accountCustomFieldData/bulkCreate", "body": { "type": "json", "data": "{}" } }, "docs": "ActiveCampaign Bulk Create a Custom Account Field Value" }, { "info": { "name": "ActiveCampaign Retrieve a Custom Field Value", "type": "http" }, "http": { "method": "GET", "url": "https://{yourAccountName}.api-us1.com/api/3/accountCustomFieldData/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "ID of the dealCustomFieldData to retrieve" } ] }, "docs": "ActiveCampaign Retrieve a Custom Field Value" }, { "info": { "name": "ActiveCampaign Update a Custom Field Value", "type": "http" }, "http": { "method": "PUT", "url": "https://{yourAccountName}.api-us1.com/api/3/accountCustomFieldData/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "ID of the custom fields value to update" } ], "body": { "type": "json", "data": "{}" } }, "docs": "ActiveCampaign Update a Custom Field Value" }, { "info": { "name": "ActiveCampaign Delete a Custom Field Value", "type": "http" }, "http": { "method": "DELETE", "url": "https://{yourAccountName}.api-us1.com/api/3/accountCustomFieldData/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "ID of the dealCustomFieldData to retrieve" } ] }, "docs": "ActiveCampaign Delete a Custom Field Value" }, { "info": { "name": "ActiveCampaign Bulk Update a Custom Field Value", "type": "http" }, "http": { "method": "PATCH", "url": "https://{yourAccountName}.api-us1.com/api/3/accountCustomFieldData/bulkUpdate", "body": { "type": "json", "data": "{}" } }, "docs": "ActiveCampaign Bulk Update a Custom Field Value" } ] } ], "bundled": true }