Using ActiveCampaign?

Accounts

• GET

  Add account note

  Add note in existing account

  Parameters:

  • Account Id, String
  • Note, String
  • Login, String

  Returns:

  • accounts, Array [Object]
  • note, Object
• GET

  Bulk create custom field values

  Bulk create custom field values

  Parameters:

  • Login, String
  • customFieldValues, Array [Object]

  Returns:

  • message, String
• GET

  Bulk create custom field values

  Bulk create custom field values

  Parameters:

  • No parameter

  Returns:

  • message, String
• GET

  Bulk delete accounts

  Delete an existing accounts

  Parameters:

  • Login, String
  • ids, Array [Integer]

  Returns:

  • isSuccess, Boolean
• GET

  Create account

  Create a new account

  Parameters:

  • Login, String
  • Name, String
  • Account Url, String

  Returns:

  • account, Object
• GET

  Create an association

  Create a new account-contact association

  Parameters:

  • Login, String
  • Contact Id, Integer
  • Account Id, Integer
  • Job title, String

  Returns:

  • accountContact, Object
• GET

  Create custom field

  Create custom field

  Parameters:

  • Login, String
  • Field label, String
  • Field label, Integer
  • Field label, Array [String]
  • Field label, String
  • Field label, String
  • Is form visible, Boolean
  • Is form visible, Boolean
  • Is form visible, Integer

  Returns:

  • accountCustomFieldMetum, Object
• GET

  Delete account

  Delete an existing account

  Parameters:

  • Login, String
  • Account Id, String

  Returns:

  • isSuccess, Boolean
• GET

  Delete account association

  Delete an existing account association

  Parameters:

  • Login, String
  • Account Id, Integer

  Returns:

  • isSuccess, Boolean
• GET

  Delete custom field

  Delete custom field by identity

  Parameters:

  • Login, String
  • CustomField Id, String

  Returns:

  • isSuccess, Boolean
• GET

  Get account

  Get account by identity

  Parameters:

  • Login, String
  • Account Id, String

  Returns:

  • account, Object
• GET

  Get account association

  Get account-contact association by identity

  Parameters:

  • Login, String
  • Account Id, String

  Returns:

  • accountContact, Object
• GET

  Get custom field

  Get custom field by identity

  Parameters:

  • Login, String
  • CustomField Id, String

  Returns:

  • accountCustomFieldMetum, Object
• GET

  Get list of accounts

  Retrieve all existing account of result of a search in parameter is set

  Parameters:

  • Login, String
  • Search, String

  Returns:

  • accounts, Array [Object]
• GET

  Get list of accounts association

  Retrieve all existing account association

  Parameters:

  • Login, String
  • Account Id, String
  • Contact Id, String

  Returns:

  • accountContacts, Array [Object]
  • meta, Object
• GET

  List all custom fields

  List all custom fields

  Parameters:

  • Login, String

  Returns:

  • accountCustomFieldMeta, Array [Object]
• GET

  List all custom fields

  List all custom fields

  Parameters:

  • Login, String
  • Account Id, String

  Returns:

  • accountCustomFieldData, Array [Object]
• GET

  Update account

  Update an existing account

  Parameters:

  • Id, String
  • Login, String
  • Name, String
  • Account Url, String

  Returns:

  • account, Object
• GET

  Update account custom field

  Update account custom field

  Parameters:

  • Id, String
  • Login, String
  • Field label, String
  • Field label, Integer
  • Field label, Array [String]
  • Field label, String
  • Field label, String
  • Is form visible, Boolean
  • Is form visible, Boolean
  • Is form visible, Integer

  Returns:

  • accountCustomFieldMetum, Object
• GET

  Update account note

  Update existing note in existing account

  Parameters:

  • Note Id, String
  • Account Id, String
  • Note, String
  • Login, String

  Returns:

  • accounts, Array [Object]
  • note, Object
• GET

  Update an association

  Update a existing account-contact association

  Parameters:

  • Id, String
  • Login, String
  • Contact Id, Integer
  • Account Id, Integer
  • Job title, String

  Returns:

  • accountContact, Object

Addresses

• GET

  Create an address

  Create a new address

  Parameters:

  • Login, String
  • Company name, String
  • Address, String
  • Country, String
  • Group Id, String
  • Address 2, String
  • City, String
  • State, String
  • Zip, String
  • District, String
  • Is default address, Boolean

  Returns:

  • address, Object
• GET

  Delete address associated with a specific list

  Delete address associated with a specific list

  Parameters:

  • Login, String
  • Address Id, String

  Returns:

  • isSuccess, Boolean
• GET

  Delete address associated with a specific user group

  Delete address associated with a specific user group

  Parameters:

  • Login, String
  • Address Id, String

  Returns:

  • isSuccess, Boolean
• GET

  Delete an address

  Delete an existing address

  Parameters:

  • Login, String
  • Address Id, String

  Returns:

  • isSuccess, Boolean
• GET

  List all addresses

  Retrieve all existing addresses

  Parameters:

  • Login, String

  Returns:

  • addresses, Array [Object]
  • meta, Object
• GET

  Retrieve an address

  Retrieve an existing address

  Parameters:

  • Login, String
  • Address Id, String

  Returns:

  • address, Object
• GET

  Update an address

  Update an existing address

  Parameters:

  • Id, String
  • Login, String
  • Company name, String
  • Address, String
  • Country, String
  • Group Id, String
  • Address 2, String
  • City, String
  • State, String
  • Zip, String
  • District, String
  • Is default address, Boolean

  Returns:

  • address, Object

Automations

• GET

  List of all automations

  Get list of all automations

  Parameters:

  • Login, String

  Returns:

  • automations, Array [Object]
  • meta, Object

Branding

• GET

  Retrieve a branding

  Retrieve a branding

  Parameters:

  • Login, String
  • Branding Id, String

  Returns:

  • branding, Object
• GET

  Update a branding

  Update an existing branding resource

  Parameters:

  • Id, String
  • Login, String
  • Site name, String
  • Site logo, String
  • Small site logo, String
  • Header text value, String
  • Header Html value, String
  • Footer text value, String
  • Footer Html value, String
  • Copyright, Boolean
  • Version, Boolean
  • License, Boolean
  • Disable branding, Boolean
  • Help, String
  • Admin template Html, String
  • Admin template css, String
  • Public template Html, String
  • Public template css, String
  • Favicon, String

  Returns:

  • branding, Object

Brandings

• GET

  List all brandings

  List all existing branding resources

  Parameters:

  • Login, String

  Returns:

  • brandings, Array [Object]
  • meta, Object

Campaigns

• GET

  List all campaigns

  Retrieve all existing campaigns

  Parameters:

  • Login, String

  Returns:

  • campaigns, Array [Object]
  • meta, Object
• GET

  Retrieve a campaign

  Retrieve a campaign

  Parameters:

  • Login, String
  • Campaign Id, String

  Returns:

  • campaign, Object
• GET

  Retrieve links associated to campaign

  Retrieve links associated to campaign

  Parameters:

  • Login, String
  • Campaign Id, String

  Returns:

  • links, Array [Object]

Contact Automations

• GET

  Create contact automation

  Get an existing contact automation

  Parameters:

  • Login, String
  • Contact id, String
  • Automation id, String

  Returns:

  • contacts, Array [Object]
  • contactAutomation, Object
• GET

  Delete contact automation

  Delete an existing contact automation

  Parameters:

  • Login, String
  • Contact automation Id, String

  Returns:

  • isSuccess, Boolean
• GET

  Get contact automation

  Get an existing contact automation

  Parameters:

  • Login, String
  • Contact automation Id, String

  Returns:

  • contactAutomation, Object

Contacts

• GET

  Add tag to contact

  Add tag to contact

  Parameters:

  • Login, String
  • Contact id, String
  • Tag's id, String

  Returns:

  • contactTag, Object
• GET

  Create or update contact

  Create or update contact

  Parameters:

  • Login, String
  • Email, String
  • First name, String
  • Last name, String
  • Phone, String

  Returns:

  • contact, Object
• GET

  Delete contact

  Delete an existing contact

  Parameters:

  • Login, String
  • Contact id, String

  Returns:

  • isSuccess, Boolean
• GET

  Get a contacts score value

  Retrieve a contacts score value

  Parameters:

  • Login, String
  • Contact id, String

  Returns:

  • scoreValues, Array [Object]
• GET

  List all contacts

  View many (or all) contacts by including their ID's or various filters

  Parameters:

  • Login, String
  • Ids, String
  • Create Date, Integer
  • Email, String
  • Email like, String
  • Excelude id, String
  • Form id, String
  • Id greater, String
  • Id less, String
  • List id, String
  • Search, String
  • Segment id, String
  • Series id, String
  • Status, Integer
  • Tag id, String
  • Created before, Integer
  • Created after, Integer
  • Updated before, Integer
  • Updated after, Integer
  • Wait id, String
  • In group lists, Boolean
  • Order by create date, String
  • Order by email, String
  • Order by first name, String
  • Order by last name, String
  • Order by full name, String
  • Order by score, String

  Returns:

  • contacts, Array [Object]
  • meta, Object
• GET

  Remove tag from contact

  Remove tag from contact

  Parameters:

  • Login, String
  • Contact tag id, String

  Returns:

  • isSuccess, Boolean
• GET

  Retrieve a contact

  Retrieve an existing contact

  Parameters:

  • Login, String
  • Contact id, String

  Returns:

  • contactAutomations, Array [Object]
• GET

  Retrieve a contact

  Retrieve an existing contact

  Parameters:

  • Login, String
  • Contact id, String

  Returns:

  • contactAutomations, Array [Object]
  • contactLists, Array [Object]
  • deals, Array [Object]
  • fieldValues, Array [Object]
  • geoAddresses, Array [Object]
  • geoIps, Array [Object]
  • contact, Object
• GET

  Update contact

  Update contact

  Parameters:

  • Id, String
  • Login, String
  • Email, String
  • First name, String
  • Last name, String
  • Phone, String

  Returns:

  • contactAutomations, Array [Object]
  • contactLists, Array [Object]
  • deals, Array [Object]
  • fieldValues, Array [Object]
  • geoAddresses, Array [Object]
  • geoIps, Array [Object]
  • contact, Object

Deals

• GET

  Create a deal

  Create a new deal

  Parameters:

  • Login, String
  • Title, String
  • Contact id, String
  • Deal value, Integer
  • Currency, String
  • Group, String
  • Stage, String
  • Owner id, String
  • Description, String
  • Percent, Integer
  • Status, Integer

  Returns:

  • contacts, Array [Object]
  • deal, Object
  • dealStages, Array [Object]
• GET

  Create a deal note

  Create a new note for a deal

  Parameters:

  • Login, String
  • DealId, String
  • Note, String

  Returns:

  • deals, Array [Object]
  • note, Object
• GET

  Create a pipeline

  Create a new pipeline

  Parameters:

  • Login, String
  • Title, String
  • Currency, String
  • All groups, Integer
  • All users, Integer
  • Deal auto-assign option, Integer
  • Users, Array [String]
  • Users ids, Array [String]

  Returns:

  • dealGroup, Object
  • dealGroupGroups, Array [Object]
  • dealGroupUsers, Array [Object]
  • dealStages, Array [Object]
• GET

  Create a secondary contact

  Create a new secondary contact for a deal

  Parameters:

  • Login, String
  • Contact Id, Integer
  • Deal Id, Integer

  Returns:

  • deals, Array [Object]
  • contactDeal, Object
• GET

  Delete a secondary contact

  Delete an existing secondary contact

  Parameters:

  • Login, String
  • Secondary contact id, String

  Returns:

  • isSuccess, Boolean
• GET

  Delete deal

  Delete an existing deal

  Parameters:

  • Login, String
  • Deal Id, String

  Returns:

  • isSuccess, Boolean
• GET

  Delete pipeiline

  Delete an existing pipeline

  Parameters:

  • Login, String
  • Pipeline Id, String

  Returns:

  • isSuccess, Boolean
• GET

  Get a deal

  Get an existing deal

  Parameters:

  • Login, String
  • Deal Id, String

  Returns:

  • deal, Object
• GET

  Get a deal

  Get an existing deal

  Parameters:

  • Login, String
  • Search, String
  • Search field, String
  • Title, String
  • Stage, Integer
  • Group, Integer
  • Status, Integer
  • Owner id, Integer
  • Search, Integer
  • Search, String
  • Task type, String
  • Created before, Integer
  • Created after, Integer
  • Updated before, Integer
  • Updated after, Integer
  • Organization Id, Integer
  • Minimum value, Integer
  • Maximum value, Integer
  • Score greater than, String
  • Score less than, String
  • Score, String
  • Order title, String
  • Order by Value, String

  Returns:

  • deals, Array [Object]
  • meta, Object
• GET

  List all secondary contacts

  Retrieve all secondary contacts

  Parameters:

  • Login, String

  Returns:

  • contactDeals, Array [Object]
  • meta, Object
• GET

  Retrieve a pipeline

  Retrieve an existing pipeline

  Parameters:

  • Login, String
  • Pipeline Id, String

  Returns:

  • dealGroup, Object
  • dealStages, Array [Object]
• GET

  Retrieve a secondary contact

  Retrieve an existing secondary contact

  Parameters:

  • Login, String
  • Secondary contact id, String

  Returns:

  • contactDeal, Object
• GET

  Update a deal note

  Update a existing note for a deal

  Parameters:

  • Id, String
  • Login, String
  • DealId, String
  • Note, String

  Returns:

  • deals, Array [Object]
  • note, Object
• GET

  Update a pipeline

  Update an existing pipeline

  Parameters:

  • Id, String
  • Login, String
  • Title, String
  • Currency, String
  • All groups, Integer
  • All users, Integer
  • Deal auto-assign option, Integer
  • Users, Array [String]
  • Users ids, Array [String]

  Returns:

  • dealGroup, Object
  • dealGroupGroups, Array [Object]
  • dealGroupUsers, Array [Object]
  • dealStages, Array [Object]
• GET

  Update a secondary contact

  Update an existing secondary contact

  Parameters:

  • Id, String
  • Login, String
  • Contact Id, Integer
  • Deal Id, Integer

  Returns:

  • deals, Array [Object]
  • contactDeal, Object
• GET

  Update deal

  Update an existing deal

  Parameters:

  • Id, String
  • Login, String
  • Title, String
  • Contact id, String
  • Deal value, Integer
  • Currency, String
  • Group, String
  • Stage, String
  • Owner id, String
  • Description, String
  • Percent, Integer
  • Status, Integer

  Returns:

  • contacts, Array [Object]
  • deal, Object
  • dealStages, Array [Object]

Deals stages

• GET

  Create a stage

  Create a new stage for a pipeline

  Parameters:

  • Login, String
  • Title, String
  • Pipline (group) id, String
  • Order, Integer
  • Deal order, String
  • Card region 1, Integer
  • Card region 2, Integer
  • Show avatar, Boolean
  • Card region 4, Integer
  • Card region 5, Integer
  • Color, String
  • Width, Integer

  Returns:

  • dealStage, Object
• GET

  Delete a stage

  Delete an existing stage

  Parameters:

  • Login, String
  • Stage Id, String

  Returns:

  • isSuccess, Boolean
• GET

  List all stages

  Retrieve all existing stages

  Parameters:

  • Login, String , Active campaign user login connected with Onlizer Connect
  • Deal Id, String , Deal stage's id whose deals are to be moved to another deal stage
  • Stage Id, String , Target deal stage's id to move deals to

  Returns:

  • deal, Object
• GET

  List all stages

  Retrieve all existing stages

  Parameters:

  • Login, String
  • Title, String
  • Pipeline id (Group id), String
  • Title, Boolean

  Returns:

  • dealStages, Array [Object]
  • meta, Object
• GET

  Retrieve a stage

  Retrieve an existing stage

  Parameters:

  • Login, String
  • Stage Id, String

  Returns:

  • dealStage, Object
• GET

  Update a stage

  Update an existing stage

  Parameters:

  • Id, String
  • Login, String
  • Title, String
  • Pipline (group) id, String
  • Order, Integer
  • Deal order, String
  • Card region 1, Integer
  • Card region 2, Integer
  • Show avatar, Boolean
  • Card region 4, Integer
  • Card region 5, Integer
  • Color, String
  • Width, Integer

  Returns:

  • dealStage, Object

DeepData Integrations

• GET

  Create a connection

  Create a new connection resource

  Parameters:

  • Login, String
  • Service name, String
  • External Id, String
  • Name, String
  • Logo Url, String
  • Link url, String

  Returns:

  • connection, Object
• GET

  Create an ECustomer

  Create a new e-commerce customer resource

  Parameters:

  • Login, String
  • Connection Id, String
  • External Id, String
  • Customer Email, String
  • Accepts marketing, Boolean

  Returns:

  • ecomCustomer, Object
• GET

  Create an order

  Create a new e-commerce order resource

  Parameters:

  • Login, String
  • Source, String
  • Email, String
  • Order products, Array [Object]
  • Currency, String
  • Connection Id, String
  • Customer Id, String
  • External created date, Integer
  • Total price, Integer
  • External Id, String
  • External checkout Id, String
  • Order url, String
  • Abandoned date, Integer
  • External updated date, Integer
  • Shipping method, String
  • Shipping amount, Integer
  • Tax amount, Integer
  • Discount amount, Integer
  • Order number, String

  Returns:

  • connections, Array [Object]
  • ecomOrderProducts, Array [Object]
  • ecomOrder, Object
• GET

  Delete a connection

  Delete an existing connection resource

  Parameters:

  • Login, String
  • Connection Id, String

  Returns:

  • isSuccess, Boolean
• GET

  Delete an ECustomer

  Delete an existing e-commerce customer resource

  Parameters:

  • Login, String
  • Customer Id, String

  Returns:

  • isSuccess, Boolean
• GET

  Delete an order

  Delete an existing e-commerce order resource

  Parameters:

  • Login, String
  • Order Id, String

  Returns:

  • isSuccess, Boolean
• GET

  Get e-commerece order products

  Retrieve an existing e-commerce order products list resource

  Parameters:

  • Login, String
  • Order id, String

  Returns:

  • ecomOrderProducts, Array [Object]
• GET

  List all orders

  List all existing e-commerce order resources

  Parameters:

  • Login, String
  • Connection Id, String
  • External Id, String
  • External checkout Id, String
  • Customer email, String
  • State, String
  • Customer Id, String
  • External created date, Integer
  • Sort field, String
  • Order by ascending, Boolean

  Returns:

  • ecomOrders, Array [Object]
  • meta, Object
• GET

  List EcomOrderProducts

  Retrieve an existing e-commerce products

  Parameters:

  • Login, String

  Returns:

  • ecomOrderProducts, Array [Object]
• GET

  Retrieve a connection

  Retrieve an existing connection resource

  Parameters:

  • Login, String
  • Connection Id, String

  Returns:

  • connection, Object
• GET

  Retrieve an EcomOrderProduct

  Retrieve an existing e-commerce order product resource

  Parameters:

  • Login, String
  • Product id, String

  Returns:

  • ecomOrderProduct, Object
• GET

  Retrieve an ECustomer

  Retrieve an existing e-commerce customer resource

  Parameters:

  • Login, String
  • Customer Id, String

  Returns:

  • ecomCustomer, Object
• GET

  Retrieve an ECustomer

  Retrieve an existing e-commerce customer resource

  Parameters:

  • Login, String
  • Customer email, String
  • External Id, String
  • Connection Id, String

  Returns:

  • ecomCustomers, Array [Object]
  • meta, Object
• GET

  Retrieve an order

  Retrieve an existing e-commerce order resource

  Parameters:

  • Login, String
  • Order Id, String

  Returns:

  • ecomOrder, Object
• GET

  Update a connection

  Update an existing connection resource

  Parameters:

  • Id, String
  • Login, String
  • Service name, String
  • External Id, String
  • Name, String
  • Logo Url, String
  • Link url, String
  • Status, Boolean
  • Sync status, Boolean

  Returns:

  • connection, Object
• GET

  Update an ECustomer

  Update an existing e-commerce customer resource

  Parameters:

  • Id, String
  • Login, String
  • Connection Id, String
  • External Id, String
  • Customer Email, String
  • Accepts marketing, Boolean

  Returns:

  • ecomCustomer, Object
• GET

  Update an order

  Update an existing ecommerce order/cart resource

  Parameters:

  • Id, String
  • Login, String
  • Source, String
  • Email, String
  • Order products, Array [Object]
  • Currency, String
  • Connection Id, String
  • Customer Id, String
  • External created date, Integer
  • Total price, Integer
  • External Id, String
  • External checkout Id, String
  • Order url, String
  • Abandoned date, Integer
  • External updated date, Integer
  • Shipping method, String
  • Shipping amount, Integer
  • Tax amount, Integer
  • Discount amount, Integer
  • Order number, String

  Returns:

  • connections, Array [Object]
  • ecomOrderProducts, Array [Object]
  • ecomOrder, Object

Events tracking

• GET

  Create a new event (name only)

  Create a new event tracking event (name only)

  Parameters:

  • Login, String
  • Event name, String

  Returns:

  • trackingEventName, String
• GET

  Delete event (name only)

  Remove an existing event tracking event (name only)

  Parameters:

  • Login, String
  • Event name, String

  Returns:

  • isSuccess, Boolean
• GET

  List all events (names only)

  List the names of tracked events

  Parameters:

  • Login, String

  Returns:

  • eventTrackingEvents, Array [Object]
  • meta, Object
• GET

  List all events (names only)

  List the names of tracked events

  Parameters:

  • Login, String

  Returns:

  • eventTracking, Object
• GET

  Manage events tracking status

  Enable or disable events tracking status

  Parameters:

  • Enable Tracking, Boolean
  • Login, String

  Returns:

  • eventTracking, Object
• GET

  Track event

  Track an event using event tracking. Event Tracking must be toggled on in your ActiveCampaign account on Settings > Tracking > Event Tracking in order for this call to work

  Parameters:

  • Login, String
  • Event key, String
  • Event name, String
  • Actid, String
  • Email, String
  • Event data, String

  Returns:

  • success, Integer
  • message, String

Forms

• GET

  List all forms

  List all forms

  Parameters:

  • Login, String

  Returns:

  • meta, Object
  • forms, Array [Object]
• GET

  Retrieve a form

  Retrieve a form

  Parameters:

  • Login, String
  • Form Id, String

  Returns:

  • form, Object

Groups

• GET

  Create a new group

  Create a new group

  Parameters:

  • Login, String
  • Group title, String
  • Description, String
  • Add message permission, Boolean
  • Force unsubscribe link, Boolean
  • Optin confirm, Boolean
  • Add list permission, Boolean
  • Edit list permission, Boolean
  • Delete list permission, Boolean
  • Manage email headers permission, Boolean
  • Manage unsubscribe permission, Boolean
  • Bounce settings permission, Boolean
  • Edit messages permission, Boolean
  • Delete messages permission, Boolean
  • Sending message permission, Boolean
  • Add contact permission, Boolean
  • Edit contact permission, Boolean
  • Delete contact permission, Boolean
  • Merging contacts permission, Boolean
  • Import contact permission, Boolean
  • Approve contact permission, Boolean
  • Export contact permission, Boolean
  • Sync contact permission, Boolean
  • Managing contact list segment permission, Boolean
  • Managing contact actions, Boolean
  • Manage contact custom fields, Boolean
  • Adding users, Boolean
  • Editing users, Boolean
  • Delete user, Boolean
  • Adding groups, Boolean
  • Editing groups, Boolean
  • Deleting groups, Boolean
  • Adding templates, Boolean
  • Editing templates, Boolean
  • Deleting templates, Boolean
  • Adding tags, Boolean
  • Editing tags, Boolean
  • Deleting tags, Boolean
  • Manage automations, Boolean
  • Edit subscription form, Boolean
  • View campaign reports, Boolean
  • View reports list, Boolean
  • Users report list, Boolean
  • pgStartupReports, Boolean
  • Trend reports view, Boolean
  • Show gettings started tutorial, Boolean
  • View deals, Boolean
  • Delete deals, Boolean
  • Reassign deals, Boolean
  • Add deal groups, Boolean
  • Edit deal groups, Boolean
  • Delete deal groups, Boolean
  • Manage saved responses, Boolean
  • Approve all campaigns, Boolean
  • Approve first campaign, Boolean
  • Email of approval, String
  • Show social links in campaign, Boolean

  Returns:

  • group, Object
• GET

  Delete a group

  Delete an existing group

  Parameters:

  • Login, String
  • Group Id, String

  Returns:

  • isSuccess, Boolean
• GET

  List all groups

  List all existing groups

  Parameters:

  • Login, String

  Returns:

  • groups, Array [Object]
  • meta, Object
• GET

  Retrieve a group

  Retrieve an existing group

  Parameters:

  • Login, String
  • Group Id, String

  Returns:

  • group, Object
• GET

  Update a group

  Update an existing group

  Parameters:

  • Id, String
  • Login, String
  • Group title, String
  • Description, String
  • Add message permission, Boolean
  • Force unsubscribe link, Boolean
  • Optin confirm, Boolean
  • Add list permission, Boolean
  • Edit list permission, Boolean
  • Delete list permission, Boolean
  • Manage email headers permission, Boolean
  • Manage unsubscribe permission, Boolean
  • Bounce settings permission, Boolean
  • Edit messages permission, Boolean
  • Delete messages permission, Boolean
  • Sending message permission, Boolean
  • Add contact permission, Boolean
  • Edit contact permission, Boolean
  • Delete contact permission, Boolean
  • Merging contacts permission, Boolean
  • Import contact permission, Boolean
  • Approve contact permission, Boolean
  • Export contact permission, Boolean
  • Sync contact permission, Boolean
  • Managing contact list segment permission, Boolean
  • Managing contact actions, Boolean
  • Manage contact custom fields, Boolean
  • Adding users, Boolean
  • Editing users, Boolean
  • Delete user, Boolean
  • Adding groups, Boolean
  • Editing groups, Boolean
  • Deleting groups, Boolean
  • Adding templates, Boolean
  • Editing templates, Boolean
  • Deleting templates, Boolean
  • Adding tags, Boolean
  • Editing tags, Boolean
  • Deleting tags, Boolean
  • Manage automations, Boolean
  • Edit subscription form, Boolean
  • View campaign reports, Boolean
  • View reports list, Boolean
  • Users report list, Boolean
  • pgStartupReports, Boolean
  • Trend reports view, Boolean
  • Show gettings started tutorial, Boolean
  • View deals, Boolean
  • Delete deals, Boolean
  • Reassign deals, Boolean
  • Add deal groups, Boolean
  • Edit deal groups, Boolean
  • Delete deal groups, Boolean
  • Manage saved responses, Boolean
  • Approve all campaigns, Boolean
  • Approve first campaign, Boolean
  • Email of approval, String
  • Show social links in campaign, Boolean

  Returns:

  • group, Object

Lists

• GET

  Create a list

  Create an new list

  Parameters:

  • Login, String
  • Name, String
  • Id, String
  • Sender url, String
  • Sender reminder, String
  • Send last broadcast, Boolean
  • Carbon copy, String
  • Subscription notify, String
  • Unsubscription notify, String
  • Owner id (User id), Integer

  Returns:

  • list, Object
• GET

  Create a list group permission

  Create a new list group permission

  Parameters:

  • Id, String
  • Login, String
  • List Id, Integer
  • Group Id, Integer

  Returns:

  • listGroup, Object
• GET

  Delete a list

  Delete an existing list

  Parameters:

  • Login, String
  • List id, String

  Returns:

  • isSuccess, Boolean
• GET

  Retrieve a list

  Retrieve an existing list

  Parameters:

  • Login, String
  • List id, String

  Returns:

  • list, Object
• GET

  Retrieve a list

  Retrieve an existing list

  Parameters:

  • Login, String
  • List name, String

  Returns:

  • lists, Array [Object]
  • meta, Object

Messages

• GET

  Delete a message

  Delete an existing message

  Parameters:

  • Login, String
  • Message Id, String

  Returns:

  • isSuccess, Boolean
• GET

  List all messages

  Retrieve all existing messages

  Parameters:

  • Login, String

  Returns:

  • messages, Array [Object]
  • meta, Object
• GET

  Retrieve a message

  Retrieve a message

  Parameters:

  • Login, String
  • Message Id, String

  Returns:

  • message, Object

Notes

• GET

  Delete a note

  Delete an existing note

  Parameters:

  • Login, String
  • Note id, String

  Returns:

  • isSuccess, Boolean
• GET

  Retrieve a note

  Retrieve an existing note

  Parameters:

  • Login, String
  • Note id, String

  Returns:

  • note, Object

Saved responses

• GET

  Create saved response

  Create a saved response

  Parameters:

  • Login, String
  • Title, String
  • Subject, String
  • Body, String

  Returns:

  • savedResponse, Object
• GET

  Delete saved response

  Delete a saved response by identity

  Parameters:

  • Login, String
  • Saved response Id, String

  Returns:

  • isSuccess, Boolean
• GET

  Get saved response

  Retrieve a saved response by identity

  Parameters:

  • Login, String
  • Saved response Id, String

  Returns:

  • savedResponse, Object
• GET

  List saved responses

  Retrieve an all saved responses that available for account

  Parameters:

  • Login, String

  Returns:

  • savedResponses, Array [Object]
  • meta, Object
• GET

  Update saved response

  Update an existing saved response

  Parameters:

  • Id, String
  • Login, String
  • Title, String
  • Subject, String
  • Body, String

  Returns:

  • savedResponse, Object

Scores

• GET

  Get score

  Retrieve a score by identity

  Parameters:

  • Login, String
  • Score id, String

  Returns:

  • score, Object
• GET

  List all scores

  List all scores that available for account

  Parameters:

  • Login, String

  Returns:

  • scores, Array [Object]
  • meta, Object

Segments

• GET

  Get segment

  Retrieve a segment by identity

  Parameters:

  • Login, String
  • Segment id, String

  Returns:

  • segment, Object
• GET

  List all segments

  Return all segments that available for account

  Parameters:

  • Login, String

  Returns:

  • segments, Array [Object]
  • meta, Object

Settings

• GET

  Update settings

  Update existing settings by id

  Parameters:

  • Settings Id, String
  • Login, String

  Returns:

Site tracking

• GET

  Add domain to whitelist

  Add a domain to the site tracking whitelist

  Parameters:

  • Domain name, String
  • Login, String

  Returns:

  • siteTrackingDomain, Array [Object]
• GET

  List all whitelisted domains

  List of all whitelisted site tracking domains

  Parameters:

  • Login, String

  Returns:

  • trackingCode, String
• GET

  Manage site tracking status

  Enable or disable site tracking status

  Parameters:

  • Enable status, Boolean
  • Login, String

  Returns:

  • siteTracking, Object
• GET

  Remove domain from whitelist

  Remove a domain from the site tracking whitelist

  Parameters:

  • Login, String
  • Domain name, String

  Returns:

  • isSuccess, Boolean
• GET

  Retrieve site tracking code

  Get site tracking code

  Parameters:

  • Login, String

  Returns:

  • trackingCode, String
• GET

  Retrieve status

  Get site tracking status (enabled or disabled)

  Parameters:

  • Login, String

  Returns:

  • siteTracking, Object

Tags

• GET

  Create a new tag

  Create a new tag

  Parameters:

  • Login, String
  • Tag name, String
  • Tag type, String
  • Description, String

  Returns:

  • tag, Object
• GET

  Delete a tag

  Delete an existing tag

  Parameters:

  • Login, String
  • Tag Id, String

  Returns:

  • isSuccess, Boolean
• GET

  List all tags

  Retrieve an all tags that available for account

  Parameters:

  • Login, String
  • Search, String

  Returns:

  • tags, Array [Object]
  • meta, Object
• GET

  Retrieve a tag

  Retrieve an existing tag

  Parameters:

  • Login, String
  • Tag Id, String

  Returns:

  • tag, Object
• GET

  Update tag

  Update an existing tag

  Parameters:

  • Id, String
  • Login, String
  • Tag name, String
  • Tag type, String
  • Description, String

  Returns:

  • tag, Object

Task types

• GET

  Create a task type

  Create a new task type

  Parameters:

  • Login, String
  • Title, String

  Returns:

  • dealTasktype, Object
• GET

  Delete a task type

  Delete an existing task type. If the deal task type has existing deal tasks, the request will be rejected with a HTTP response code 409. Before this deal task type can be deleted, all deal tasks under this deal task type must be either moved to another deal task type or deleted

  Parameters:

  • Login, String
  • Task type Id, String

  Returns:

  • isSuccess, Boolean
• GET

  List all task types

  Retrieve all existing task types

  Parameters:

  • Login, String

  Returns:

  • dealTasktypes, Array [Object]
  • meta, Object
• GET

  Move task

  Move tasks to a different task type

  Parameters:

  • Login, String
  • Old task type id, String
  • New task type id, String

  Returns:

  • dealTasks, Array [Object]
  • deals, Array [Object]
• GET

  Retrieve a task type

  Retrieve an existing task type

  Parameters:

  • Login, String
  • Task type Id, String

  Returns:

  • dealTasktype, Object
• GET

  Update a task type

  Update an existing task type

  Parameters:

  • Id, String
  • Login, String
  • Title, String

  Returns:

  • dealTasktype, Object

Tasks

• GET

  Create a task

  Create a new task

  Parameters:

  • Login, String
  • Object id, String
  • Due date, Integer
  • Task type, String
  • Title, String
  • Owner type, String
  • Status, Integer
  • Description, String
  • Assignee id, Integer

  Returns:

  • dealTask, Object
• GET

  Delete a task

  Delete an existing task

  Parameters:

  • Login, String
  • Task Id, String

  Returns:

  • isSuccess, Boolean
• GET

  Retrieve a task

  Retrieve an existing task

  Parameters:

  • Login, String
  • Task Id, String

  Returns:

  • dealTask, Object
• GET

  Retrieve a task

  Retrieve an existing task

  Parameters:

  • Login, String
  • Title, String
  • Relative type, String
  • Object id, String
  • Status, Integer
  • Note, String
  • Due date, Integer
  • Task type Id, Integer
  • User Id, Integer

  Returns:

  • dealTasks, Array [Object]
  • meta, Object
• GET

  Update a task

  Update an existing task

  Parameters:

  • Id, String
  • Login, String
  • Object id, String
  • Due date, Integer
  • Task type, String
  • Title, String
  • Owner type, String
  • Status, Integer
  • Description, String
  • Assignee id, Integer

  Returns:

  • dealTask, Object

Templates

• GET

  Retrieve a template

  Retrieve an existing template

  Parameters:

  • Login, String
  • Template Id, String

  Returns:

  • template, Object

Users

• GET

  Create a new user

  Create a new user

  Parameters:

  • Login, String
  • User name, String
  • Password, String
  • User email, String
  • First name, String
  • Last name, String
  • Group id, String

  Returns:

  • user, Object
• GET

  Delete user

  Delete an existing user

  Parameters:

  • Login, String
  • User Id, String

  Returns:

  • isSuccess, Boolean
• GET

  List all users

  List all existing users

  Parameters:

  • Login, String

  Returns:

  • users, Array [Object]
  • meta, Object
• GET

  Retrieve a user

  Retrieve an existing user by id

  Parameters:

  • Login, String
  • User Id, String

  Returns:

  • user, Object
• GET

  Retrieve a user by email

  Retrieve an existing user by email

  Parameters:

  • Login, String
  • User email, String

  Returns:

  • user, Object
• GET

  Retrieve a user by username

  Retrieve an existing user by username

  Parameters:

  • Login, String
  • Username, String

  Returns:

  • user, Object
• GET

  Retrieve logged-in user

  Retrieve the logged-in user (me)

  Parameters:

  • Login, String

  Returns:

  • user, Object
• GET

  Update user

  Update an existing user

  Parameters:

  • Id, String
  • Login, String
  • User name, String
  • Password, String
  • User email, String
  • First name, String
  • Last name, String
  • Group id, String

  Returns:

  • user, Object