openapi: 3.0.3 info: title: ActiveCampaign SMS Broadcast Accounts Deals 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: Deals paths: /deals: post: summary: ActiveCampaign Create a Deal description: Create a new deal operationId: create-a-deal-new requestBody: content: application/json: schema: type: object properties: deal: properties: title: type: string description: Deal's title. description: type: string description: Deal's description account: type: string description: Deal’s account id. Required if `deal.contact` is not provided. contact: type: string description: Deal's primary contact's id. Required if `deal.account` is not provided. value: type: integer description: Deal's value in cents. (i.e. $456.78 => 45678). Must be greater than or equal to zero. format: int32 currency: type: string description: Deal's currency in 3-digit ISO format, lowercased. group: type: string description: Deal's pipeline id. Required if `deal.stage` is not provided. If `deal.group` is not provided, the stage's pipeline will be assigned to the deal automatically. stage: type: string description: Deal's stage id. Required if `deal.group` is not provided. If `deal.stage` is not provided, the deal will be assigned with the first stage in the pipeline provided in `deal.group`. owner: type: string description: Deal's owner id. Required if pipeline's auto-assign option is disabled. percent: type: integer description: Deal's percentage. format: int32 status: type: integer description: Deal's status. See [available values](ref:deal). default: 0 format: int32 fields: type: array description: 'Deal''s custom field values `{customFieldId: string, fieldValue: string, fieldCurrency?:string}[]`' items: properties: customFieldId: type: integer description: Field ID, ID of the Custom Field Meta Data format: int32 fieldValue: type: string description: Updated field value. For `currency` field, this needs to be in cents not dollars (or 100 x Base Unit). fieldCurrency: type: string description: Required only for the `currency` field type. The three letter currency code for the currency value required: - customFieldId - fieldValue type: object required: - title - account - contact - value - currency - group - stage - owner type: object required: - deal examples: POST /deals (Example REQUEST): value: deal: contact: '51' account: '45' description: This deal is an important deal currency: usd group: '1' owner: '1' percent: null stage: '1' status: 0 title: AC Deal value: 45600 fields: - customFieldId: 1 fieldValue: First field value - customFieldId: 2 fieldValue: '2008-01-20' - customFieldId: 3 fieldValue: 5500 fieldCurrency: EUR responses: '201': description: '201' content: application/json: examples: Result: value: contacts: - adate: '2017-02-06 15:50:11' bounced_date: '0000-00-00' bounced_hard: '0' bounced_soft: '0' cdate: '2017-02-03T11:26:41-06:00' deleted: '0' edate: '0000-00-00 00:00:00' email: johndoe@example.com email_domain: '' email_local: '' firstName: '' gravatar: '1' hash: e1705a92f24edf5313ed21df44d6ff5f id: '51' ip: '0' lastName: '' links: bounceLogs: /api/3/contacts/51/bounceLogs contactAutomations: /api/3/contacts/51/contactAutomations contactData: /api/3/contacts/51/contactData contactDeals: /api/3/contacts/51/contactDeals contactGoals: /api/3/contacts/51/contactGoals contactLists: /api/3/contacts/51/contactLists contactLogs: /api/3/contacts/51/contactLogs contactTags: /api/3/contacts/51/contactTags deals: /api/3/contacts/51/deals fieldValues: /api/3/contacts/51/fieldValues geoIps: /api/3/contacts/51/geoIps notes: /api/3/contacts/51/notes organization: /api/3/contacts/51/organization plusAppend: /api/3/contacts/51/plusAppend scoreValues: /api/3/contacts/51/scoreValues trackingLogs: /api/3/contacts/51/trackingLogs organization: null orgid: '0' phone: '' rating_tstamp: '0000-00-00' segmentio_id: '' sentcnt: '0' socialdata_lastcheck: '0000-00-00 00:00:00' ua: '' udate: '2017-02-03T11:26:41-06:00' deal: description: This deal is an important deal currency: usd percent: null status: 0 title: AC Deal value: 45600 organization: 45 contact: 1 group: '1' owner: '1' stage: '1' cdate: '2019-12-09T12:29:33-06:00' mdate: '2019-12-09T12:29:33-06:00' nextdate: null hash: c3a5497c winProbability: null winProbabilityMdate: null links: dealActivities: /api/3/deals/51/dealActivities contact: /api/3/deals/51/contact contactDeals: /api/3/deals/51/contactDeals group: /api/3/deals/51/group nextTask: /api/3/deals/51/nextTask notes: /api/3/deals/51/notes account: /api/3/deals/51/account customerAccount: /api/3/deals/51/customerAccount organization: /api/3/deals/51/organization owner: /api/3/deals/51/owner scoreValues: /api/3/deals/51/scoreValues stage: /api/3/deals/51/stage tasks: /api/3/deals/51/tasks dealCustomFieldData: /api/3/deals/51/dealCustomFieldData fields: - customFieldId: 1 fieldValue: First field value dealId: '51' - customFieldId: 2 fieldValue: '2008-01-20' dealId: '51' - customFieldId: 3 fieldValue: 5500 fieldCurrency: EUR dealId: '51' id: '51' isDisabled: false account: 45 customerAccount: 45 dealStages: - cardRegion1: title cardRegion2: next-action cardRegion3: show-avatar cardRegion4: contact-fullname-orgname cardRegion5: value cdate: '2017-01-20T09:27:32-06:00' color: C481DF dealOrder: next-action DESC group: '1' id: '1' links: group: /api/3/dealStages/1/group order: '1' title: To Contact udate: '2017-01-20T09:27:32-06:00' width: '280' '400': description: '400' content: application/json: examples: Result: value: '{}' schema: type: object properties: {} deprecated: false tags: - Deals x-microcks-operation: delay: 0 dispatcher: FALLBACK get: summary: ActiveCampaign List All Deals description: Retrieve all existing deals operationId: list-all-deals parameters: - name: filters[search] in: query description: Search text to use with `search_field` parameter. schema: type: string - name: filters[search_field] in: query description: Field to search for. See [available values](https://developers.activecampaign.com/reference/deal#deals-parameters-available-values). schema: type: string - name: filters[title] in: query description: Filter by deal's title schema: type: string - name: filters[stage] in: query description: Filter by deal's stage schema: type: integer format: int32 - name: filters[group] in: query description: Filter by deal's pipeline schema: type: integer format: int32 - name: filters[status] in: query description: Filter by deal's status. See [available values](https://developers.activecampaign.com/reference/deal#deals-parameters-available-values) schema: type: integer format: int32 - name: filters[owner] in: query description: Filter by deal's owner schema: type: integer format: int32 - name: filters[nextdate_range] in: query description: Filter by deal's tasks due dates. See [available values](https://developers.activecampaign.com/reference/deal#deals-parameters-available-values) schema: type: string - name: filters[tag] in: query description: Filter by tag names associated with deal's primary contact. See [available values](https://developers.activecampaign.com/reference/deal#deals-parameters-available-values). schema: type: string - name: filters[tasktype] in: query description: Filter by deals that have tasks with given type schema: type: string - name: filters[created_before] in: query description: Returns deals that are created less than given date schema: type: string format: date - name: filters[created_after] in: query description: Returns deals that are created greater than or equal to given date schema: type: string format: date - name: filters[updated_before] in: query description: Returns deals that are updated less than given date schema: type: string format: date - name: filters[updated_after] in: query description: Returns deals that are updated greater than or equal to given date schema: type: string format: date - name: filters[organization] in: query description: Filter by deal's primary contact's organization's id schema: type: integer format: int32 - name: filters[minimum_value] in: query description: In USD with dollar portion. Returns deals whose values are greater than or equal to given value schema: type: integer format: int32 - name: filters[maximum_value] in: query description: In USD with dollar portion. Returns deals whose values are less than or equal to given value schema: type: integer format: int32 - name: filters[score_greater_than] in: query description: In a format of `:`. Returns deals whose score value is greater than given value schema: type: string - name: filters[score_less_than] in: query description: In a format of `:`. Returns deals whose score value is less than given value schema: type: string - name: filters[score] in: query description: In a format of `:`. Returns deals whose score value is equal to given value schema: type: string - name: orders[title] in: query description: Order by deal's title. schema: type: string default: ASC - name: orders[value] in: query description: Order by deal's value. schema: type: string default: ASC - name: orders[cdate] in: query description: Order by deal's created date. schema: type: string default: ASC - name: orders[contact_name] in: query description: Order by deal's primary contact's first name. schema: type: string default: ASC - name: orders[contact_orgname] in: query description: Order by deal's primary contact's organization name. schema: type: string default: ASC - name: orders[next-action] in: query description: Order by deal's next task's due date first. Then append deals with no next task. Lastly append deals with overdue tasks. If dates are the same, order by deal's id. schema: type: string default: ASC responses: '200': description: '200' content: application/json: examples: Result: value: "{\n \"deals\": [\n {\n \"owner\": \"1\",\n \"contact\": \"39\",\n \"organization\": \"20\",\n \"group\": \"1\",\n \"stage\": \"2\",\n \"title\": \"Able Hyena\",\n \"description\": \"Article do skill hope.\",\n \"percent\": \"0\",\n \"cdate\": \"2019-09-06T11:29:48-05:00\",\n \"mdate\": \"2019-09-06T11:29:48-05:00\",\n \"nextdate\": null,\n \"nexttaskid\": null,\n \"value\": \"1872151\",\n \"currency\": \"usd\",\n \"winProbability\": 44,\n \"winProbabilityMdate\": \"2019-10-05T12:27:22-05:00\",\n \"status\": \"0\",\n \"activitycount\": \"1\",\n \"nextdealid\": \"46\",\n \"edate\": \"2019-11-22 14:15:37\",\n \"links\": {\n \"dealActivities\": \"/api/3/deals/46/dealActivities\",\n \"contact\":\"/api/3/deals/46/contact\",\n \"contactDeals\": \"/api/3/deals/46/contactDeals\",\n \"group\": \"/api/3/deals/46/group\",\n \"nextTask\": \"/api/3/deals/46/nextTask\",\n \"notes\": \"/api/3/deals/46/notes\",\n \"account\": \"/api/3/deals/46/account\",\n \"customerAccount\": \"/api/3/deals/46/customerAccount\",\n \"organization\": \"/api/3/deals/46/organization\",\n \"owner\": \"/api/3/deals/46/owner\",\n \"scoreValues\": \"/api/3/deals/46/scoreValues\",\n \"stage\": \"/api/3/deals/46/stage\",\n \"tasks\": \"api/3/deals/46/tasks\",\n \"dealCustomFieldData\": \"/api/3/deals/46/dealCustomFieldData\"\n\t\t},\n \"id\": \"46\",\n \"isDisabled\": false,\n \"account\": \"20\",\n \"customerAccount\": \"20\"\n\t\t},\n {\n \"activitycount\": \"62\",\n \"cdate\": \"2017-01-20T09:28:02-06:00\",\n \"contact\": \"44\",\n \"currency\": \"usd\",\n \"edate\": \"0000-00-00 00:00:00\",\n \"group\": \"2\",\n \"hash\": \"d6ca7d0b\",\n \"id\": \"1\",\n \"links\": {\n \"dealActivities\": \"/api/3/deals/1/dealActivities\",\n \"contact\": \"/api/3/deals/1/contact\",\n \"contactDeals\": \"/api/3/deals/1/contactDeals\",\n \"group\": \"/api/3/deals/1/group\",\n \"nextTask\": \"/api/3/deals/1/nextTask\",\n \"notes\": \"/api/3/deals/1/notes\",\n \"organization\": \"/api/3/deals/1/organization\",\n \"owner\": \"/api/3/deals/1/owner\",\n \"scoreValues\": \"/api/3/deals/1/scoreValues\",\n \"stage\": \"/api/3/deals/1/stage\",\n \"tasks\": \"/api/3/deals/1/tasks\"\n },\n \"mdate\": \"2017-02-06T12:21:12-06:00\",\n \"nextTask\": \"2\",\n \"nextdate\": \"2017-02-06T12:00:00-06:00\",\n \"nextdealid\": \"1\",\n \"nexttaskid\": \"2\",\n \"organization\": null,\n \"owner\": \"1\",\n \"percent\": \"0\",\n \"stage\": \"3\",\n \"status\": \"1\",\n \"title\": \"Test Deal\",\n \"description\": \"A deal that will make a big difference\",\n \"value\": \"10000\"\n },\n {\n \"id\": \"2\",\n \"isDisabled\": 1,\n \"title\": \"Demo Requested\"\n }\n ],\n \"meta\": {\n \"currencies\": {\n \"USD\": {\n \"currency\": \"USD\",\n \"total\": \"3\",\n \"value\": \"30000\"\n }\n },\n \"total\": 3\n }\n}" schema: type: object properties: deals: type: array items: type: object properties: owner: type: string example: '1' contact: type: string example: '39' organization: type: string example: '20' group: type: string example: '1' stage: type: string example: '2' title: type: string example: Able Hyena description: type: string example: Article do skill hope. percent: type: string example: '0' cdate: type: string example: '2019-09-06T11:29:48-05:00' mdate: type: string example: '2019-09-06T11:29:48-05:00' nextdate: {} nexttaskid: {} value: type: string example: '1872151' currency: type: string example: usd winProbability: type: integer example: 44 default: 0 winProbabilityMdate: type: string example: '2019-10-05T12:27:22-05:00' status: type: string example: '0' activitycount: type: string example: '1' nextdealid: type: string example: '46' edate: type: string example: '2019-11-22 14:15:37' links: type: object properties: dealActivities: type: string example: /api/3/deals/46/dealActivities contact: type: string example: /api/3/deals/46/contact contactDeals: type: string example: /api/3/deals/46/contactDeals group: type: string example: /api/3/deals/46/group nextTask: type: string example: /api/3/deals/46/nextTask notes: type: string example: /api/3/deals/46/notes account: type: string example: /api/3/deals/46/account customerAccount: type: string example: /api/3/deals/46/customerAccount organization: type: string example: /api/3/deals/46/organization owner: type: string example: /api/3/deals/46/owner scoreValues: type: string example: /api/3/deals/46/scoreValues stage: type: string example: /api/3/deals/46/stage tasks: type: string example: api/3/deals/46/tasks dealCustomFieldData: type: string example: /api/3/deals/46/dealCustomFieldData id: type: string example: '46' isDisabled: type: boolean example: false default: true account: type: string example: '20' customerAccount: type: string example: '20' meta: type: object properties: currencies: type: object properties: USD: type: object properties: currency: type: string example: USD total: type: string example: '3' value: type: string example: '30000' total: type: integer example: 3 default: 0 '400': description: '400' content: application/json: examples: Result: value: '{}' schema: type: object properties: {} deprecated: false tags: - Deals x-microcks-operation: delay: 0 dispatcher: FALLBACK /deals/{id}: get: summary: ActiveCampaign Retrieve a Deal description: Retrieve an existing deal operationId: retrieve-a-deal parameters: - name: id in: path description: The Deal's id schema: type: integer format: int32 required: true responses: '200': description: '200' content: application/json: examples: with pipeline permission: value: "{\n \"deal\": {\n \"owner\": \"1\",\n \"contact\": \"39\",\n \"organization\": \"20\",\n \"group\": \"1\",\n \"stage\": \"2\",\n \"title\": \"Able Hyena\",\n \"description\": \"Article do skill hope.\",\n \"percent\": \"0\",\n \"cdate\": \"2019-09-06T11:29:48-05:00\",\n \"mdate\": \"2019-09-06T11:29:48-05:00\",\n \"nextdate\": null,\n \"nexttaskid\": null,\n \"value\": \"1872151\",\n \"currency\": \"usd\",\n \"winProbability\": 44,\n \"winProbabilityMdate\": \"2019-10-05T12:27:22-05:00\",\n \"status\": \"0\",\n \"activitycount\": \"1\",\n \"nextdealid\": \"46\",\n \"edate\": \"2019-11-22 14:15:37\",\n \"links\": {\n \t\"dealActivities\": \"/api/3/deals/46/dealActivities\",\n \t\"contact\":/api/3/deals/46/contact\",\n \t\"contactDeals\": \"/api/3/deals/46/contactDeals\",\n \t\"group\": \"/api/3/deals/46/group\",\n \t\"nextTask\": \"/api/3/deals/46/nextTask\",\n \t\"notes\": \"/api/3/deals/46/notes\",\n \t\"account\": \"/api/3/deals/46/account\",\n \t\"customerAccount\": \"/api/3/deals/46/customerAccount\",\n \t\"organization\": \"/api/3/deals/46/organization\",\n \t\"owner\": \"/api/3/deals/46/owner\",\n \t\"scoreValues\": \"/api/3/deals/46/scoreValues\",\n \t\"stage\": \"/api/3/deals/46/stage\",\n \t\"tasks\": \"api/3/deals/46/tasks\",\n \t\"dealCustomFieldData\": \"/api/3/deals/46/dealCustomFieldData\"\n },\n \"id\": \"46\",\n \"isDisabled\": false,\n \"account\": \"20\",\n \"customerAccount\": \"20\"\n }\n}" without pipeline permission: value: "{\n \"deal\": {\n \"id\": \"2\",\n \"isDisabled\": true,\n \"title\": \"Demo Requested\"\n }\n}" schema: type: object properties: deal: type: object properties: id: type: string example: '2' isDisabled: type: boolean example: true default: true title: type: string example: Demo Requested deprecated: false tags: - Deals x-microcks-operation: delay: 0 dispatcher: FALLBACK put: summary: ActiveCampaign Update a Deal description: Update an existing deal operationId: update-a-deal-new parameters: - name: id in: path description: The Deal's id schema: type: integer format: int32 required: true requestBody: content: application/json: schema: type: object properties: deal: properties: title: type: string description: Deal's title. description: type: string description: Deal's description account: type: string description: Deal's account id contact: type: string description: Deal's primary contact id. value: type: integer description: Deal's value in cents. (i.e. $456.78 => 45678). Must be greater than or equal to zero. format: int32 currency: type: string description: Deal's currency in 3-digit ISO format, lowercased. group: type: string description: Deal's pipeline id. Deal's stage or `deal.stage` should belong to `deal.group`. stage: type: string description: Deal's stage id. `deal.stage` should belong to Deal's pipeline or `deal.group`. default: '0' owner: type: string description: Deal's owner id. percent: type: integer description: Deal's percentage. format: int32 status: type: integer description: Deal's status (0="open", 1="won", or 2="lost") default: 0 format: int32 fields: type: array description: 'Deal''s custom field values `{customFieldId: string, fieldValue: string, fieldCurrency?:string}[]`' items: properties: customFieldId: type: integer description: Field ID, ID of the Custom Field Meta Data format: int32 fieldValue: type: string description: Updated field value. For `currency` field, this needs to be in cents not dollars (or 100 x Base Unit). fieldCurrency: type: string description: Required only for the `currency` field type. The three letter currency code for the currency value required: - customFieldId - fieldValue type: object required: [] type: object examples: Request Example: value: deal: contact: '51' account: '45' description: This deal is an important deal currency: usd group: '1' owner: '1' percent: null stage: '1' status: 0 title: AC Deal value: 45600 fields: - customFieldId: 1 fieldValue: First field value - customFieldId: 2 fieldValue: '2008-01-20' - customFieldId: 3 fieldValue: 8800 fieldCurrency: USD responses: '200': description: '200' content: application/json: examples: Result: value: contacts: - adate: '2017-02-06 15:50:11' bounced_date: '0000-00-00' bounced_hard: '0' bounced_soft: '0' cdate: '2017-02-03T11:26:41-06:00' deleted: '0' edate: '0000-00-00 00:00:00' email: johndoe@example.com email_domain: '' email_local: '' firstName: '' gravatar: '1' hash: e1705a92f24edf5313ed21df44d6ff5f id: '51' ip: '0' lastName: '' links: bounceLogs: /api/3/contacts/51/bounceLogs contactAutomations: /api/3/contacts/51/contactAutomations contactData: /api/3/contacts/51/contactData contactDeals: /api/3/contacts/51/contactDeals contactGoals: /api/3/contacts/51/contactGoals contactLists: /api/3/contacts/51/contactLists contactLogs: /api/3/contacts/51/contactLogs contactTags: /api/3/contacts/51/contactTags deals: /api/3/contacts/51/deals fieldValues: /api/3/contacts/51/fieldValues geoIps: /api/3/contacts/51/geoIps notes: /api/3/contacts/51/notes organization: /api/3/contacts/51/organization plusAppend: /api/3/contacts/51/plusAppend scoreValues: /api/3/contacts/51/scoreValues trackingLogs: /api/3/contacts/51/trackingLogs organization: null orgid: '0' phone: '' rating_tstamp: '0000-00-00' segmentio_id: '' sentcnt: '0' socialdata_lastcheck: '0000-00-00 00:00:00' ua: '' udate: '2017-02-03T11:26:41-06:00' deal: description: This deal is an important deal currency: usd percent: null status: 0 title: AC Deal value: 45600 organization: 45 contact: 1 group: '1' owner: '1' stage: '1' cdate: '2019-12-09T12:29:33-06:00' mdate: '2019-12-09T12:29:33-06:00' nextdate: null hash: c3a5497c winProbability: null winProbabilityMdate: null links: dealActivities: /api/3/deals/51/dealActivities contact: /api/3/deals/51/contact contactDeals: /api/3/deals/51/contactDeals group: /api/3/deals/51/group nextTask: /api/3/deals/51/nextTask notes: /api/3/deals/51/notes account: /api/3/deals/51/account customerAccount: /api/3/deals/51/customerAccount organization: /api/3/deals/51/organization owner: /api/3/deals/51/owner scoreValues: /api/3/deals/51/scoreValues stage: /api/3/deals/51/stage tasks: /api/3/deals/51/tasks dealCustomFieldData: /api/3/deals/51/dealCustomFieldData fields: - customFieldId: 1 fieldValue: First field value dealId: '51' - customFieldId: 2 fieldValue: '2008-01-20' dealId: '51' - customFieldId: 3 fieldValue: 8800 fieldCurrency: USD dealId: '51' id: '51' isDisabled: false account: 45 customerAccount: 45 dealStages: - cardRegion1: title cardRegion2: next-action cardRegion3: show-avatar cardRegion4: contact-fullname-orgname cardRegion5: value cdate: '2017-01-20T09:27:32-06:00' color: C481DF dealOrder: next-action DESC group: '1' id: '1' links: group: /api/3/dealStages/1/group order: '1' title: To Contact udate: '2017-01-20T09:27:32-06:00' width: '280' '400': description: '400' content: application/json: examples: Result: value: '{}' schema: type: object properties: {} deprecated: false tags: - Deals x-microcks-operation: delay: 0 dispatcher: FALLBACK delete: summary: ActiveCampaign Delete a Deal description: Delete an existing deal operationId: delete-a-deal parameters: - name: id in: path description: The Deal's id schema: type: integer format: int32 required: true responses: '200': description: '200' content: application/json: examples: Result: value: '' '400': description: '400' content: application/json: examples: Result: value: '{}' schema: type: object properties: {} deprecated: false tags: - Deals x-microcks-operation: delay: 0 dispatcher: FALLBACK /deals/{id}/notes: post: summary: ActiveCampaign Create a Deal Note description: Create a new note for a deal operationId: create-a-deal-note parameters: - name: id in: path description: The Deal's id to assign new note to schema: type: string required: true requestBody: content: application/json: schema: type: object properties: note: properties: note: type: string description: The Deal note's content required: - note type: object examples: Request Example: value: note: note: Note for the deal responses: '201': description: '201' content: application/json: examples: Result: value: "{\n \"deals\": [\n {\n \"activitycount\": \"2\",\n \"cdate\": \"2017-05-25T12:01:01-05:00\",\n \"contact\": \"1\",\n \"currency\": \"usd\",\n \"edate\": null,\n \"group\": \"1\",\n \"hash\": \"e42436fc\",\n \"id\": \"1\",\n \"links\": {\n \"dealActivities\": \"/api/3/deals/1/dealActivities\",\n \"contact\": \"/api/3/deals/1/contact\",\n \"contactDeals\": \"/api/3/deals/1/contactDeals\",\n \"group\": \"/api/3/deals/1/group\",\n \"nextTask\": \"/api/3/deals/1/nextTask\",\n \"notes\": \"/api/3/deals/1/notes\",\n \"organization\": \"/api/3/deals/1/organization\",\n \"owner\": \"/api/3/deals/1/owner\",\n \"scoreValues\": \"/api/3/deals/1/scoreValues\",\n \"stage\": \"/api/3/deals/1/stage\",\n \"tasks\": \"/api/3/deals/1/tasks\"\n },\n \"mdate\": \"2017-05-25T12:17:23-05:00\",\n \"nextdate\": null,\n \"nextdealid\": \"1\",\n \"nexttaskid\": null,\n \"organization\": null,\n \"owner\": \"1\",\n \"percent\": \"0\",\n \"stage\": \"1\",\n \"status\": \"0\",\n \"title\": \"New Deal\",\n \"value\": \"10000\"\n }\n ],\n \"note\": {\n \"cdate\": \"2017-05-31T09:54:30-05:00\",\n \"id\": \"2\",\n \"links\": {\n \"activities\": \"/api/3/notes/2/activities\",\n \"mentions\": \"/api/3/notes/2/mentions\",\n \"notes\": \"/api/3/notes/2/notes\",\n \"owner\": \"/api/3/notes/2/owner\",\n \"user\": \"/api/3/notes/2/user\"\n },\n \"mdate\": \"2017-05-31T09:54:30-05:00\",\n \"note\": \"Note for the deal\",\n \"owner\": {\n \"id\": \"1\",\n \"type\": \"deal\"\n },\n \"relid\": \"1\",\n \"reltype\": \"Deal\",\n \"user\": \"1\",\n \"userid\": \"1\"\n }\n}" schema: type: object properties: deals: type: array items: type: object properties: activitycount: type: string example: '2' cdate: type: string example: '2017-05-25T12:01:01-05:00' contact: type: string example: '1' currency: type: string example: usd edate: {} group: type: string example: '1' hash: type: string example: e42436fc id: type: string example: '1' links: type: object properties: dealActivities: type: string example: /api/3/deals/1/dealActivities contact: type: string example: /api/3/deals/1/contact contactDeals: type: string example: /api/3/deals/1/contactDeals group: type: string example: /api/3/deals/1/group nextTask: type: string example: /api/3/deals/1/nextTask notes: type: string example: /api/3/deals/1/notes organization: type: string example: /api/3/deals/1/organization owner: type: string example: /api/3/deals/1/owner scoreValues: type: string example: /api/3/deals/1/scoreValues stage: type: string example: /api/3/deals/1/stage tasks: type: string example: /api/3/deals/1/tasks mdate: type: string example: '2017-05-25T12:17:23-05:00' nextdate: {} nextdealid: type: string example: '1' nexttaskid: {} organization: {} owner: type: string example: '1' percent: type: string example: '0' stage: type: string example: '1' status: type: string example: '0' title: type: string example: New Deal value: type: string example: '10000' note: type: object properties: cdate: type: string example: '2017-05-31T09:54:30-05:00' id: type: string example: '2' links: type: object properties: activities: type: string example: /api/3/notes/2/activities mentions: type: string example: /api/3/notes/2/mentions notes: type: string example: /api/3/notes/2/notes owner: type: string example: /api/3/notes/2/owner user: type: string example: /api/3/notes/2/user mdate: type: string example: '2017-05-31T09:54:30-05:00' note: type: string example: Note for the deal owner: type: object properties: id: type: string example: '1' type: type: string example: deal relid: type: string example: '1' reltype: type: string example: Deal user: type: string example: '1' userid: type: string example: '1' deprecated: false tags: - Deals x-microcks-operation: delay: 0 dispatcher: FALLBACK /deals/{id}/notes/{noteId}: put: summary: ActiveCampaign Update a Deal Note description: Update an existing note for a deal operationId: update-a-deal-note parameters: - name: id in: path description: Deal's id to assign new note to schema: type: string required: true - name: noteId in: path description: Deal note's id to update schema: type: string required: true requestBody: content: application/json: schema: type: object properties: note: properties: note: type: string description: Deal note's content required: - note type: object examples: Request Example: value: note: note: Update with more info responses: '200': description: '200' content: application/json: examples: Result: value: "{\n \"deals\": [\n {\n \"activitycount\": \"3\",\n \"cdate\": \"2017-06-01T13:40:04-05:00\",\n \"contact\": \"1\",\n \"currency\": \"usd\",\n \"edate\": \"0000-00-00 00:00:00\",\n \"group\": \"1\",\n \"hash\": \"5604d5b5\",\n \"id\": \"1\",\n \"links\": {\n \"dealActivities\": \"/api/3/deals/1/dealActivities\",\n \"contact\": \"/api/3/deals/1/contact\",\n \"contactDeals\": \"/api/3/deals/1/contactDeals\",\n \"group\": \"/api/3/deals/1/group\",\n \"nextTask\": \"/api/3/deals/1/nextTask\",\n \"notes\": \"/api/3/deals/1/notes\",\n \"organization\": \"/api/3/deals/1/organization\",\n \"owner\": \"/api/3/deals/1/owner\",\n \"scoreValues\": \"/api/3/deals/1/scoreValues\",\n \"stage\": \"/api/3/deals/1/stage\",\n \"tasks\": \"/api/3/deals/1/tasks\"\n },\n \"mdate\": \"2017-06-01T13:41:57-05:00\",\n \"nextTask\": \"1\",\n \"nextdate\": \"2017-06-02T12:00:00-05:00\",\n \"nextdealid\": \"1\",\n \"nexttaskid\": \"1\",\n \"organization\": null,\n \"owner\": \"1\",\n \"percent\": \"0\",\n \"stage\": \"1\",\n \"status\": \"0\",\n \"title\": \"New deal\",\n \"value\": \"10000\"\n }\n ],\n \"note\": {\n \"cdate\": \"2017-06-01T13:42:13-05:00\",\n \"id\": \"2\",\n \"links\": {\n \"activities\": \"/api/3/notes/2/activities\",\n \"mentions\": \"/api/3/notes/2/mentions\",\n \"notes\": \"/api/3/notes/2/notes\",\n \"owner\": \"/api/3/notes/2/owner\",\n \"user\": \"/api/3/notes/2/user\"\n },\n \"mdate\": \"2017-06-01T13:42:13-05:00\",\n \"note\": \"Update with more info\",\n \"owner\": {\n \"id\": \"1\",\n \"type\": \"deal\"\n },\n \"relid\": \"1\",\n \"reltype\": \"Deal\",\n \"user\": \"1\",\n \"userid\": \"1\"\n }\n}\n" schema: type: object properties: deals: type: array items: type: object properties: activitycount: type: string example: '3' cdate: type: string example: '2017-06-01T13:40:04-05:00' contact: type: string example: '1' currency: type: string example: usd edate: type: string example: '0000-00-00 00:00:00' group: type: string example: '1' hash: type: string example: 5604d5b5 id: type: string example: '1' links: type: object properties: dealActivities: type: string example: /api/3/deals/1/dealActivities contact: type: string example: /api/3/deals/1/contact contactDeals: type: string example: /api/3/deals/1/contactDeals group: type: string example: /api/3/deals/1/group nextTask: type: string example: /api/3/deals/1/nextTask notes: type: string example: /api/3/deals/1/notes organization: type: string example: /api/3/deals/1/organization owner: type: string example: /api/3/deals/1/owner scoreValues: type: string example: /api/3/deals/1/scoreValues stage: type: string example: /api/3/deals/1/stage tasks: type: string example: /api/3/deals/1/tasks mdate: type: string example: '2017-06-01T13:41:57-05:00' nextTask: type: string example: '1' nextdate: type: string example: '2017-06-02T12:00:00-05:00' nextdealid: type: string example: '1' nexttaskid: type: string example: '1' organization: {} owner: type: string example: '1' percent: type: string example: '0' stage: type: string example: '1' status: type: string example: '0' title: type: string example: New deal value: type: string example: '10000' note: type: object properties: cdate: type: string example: '2017-06-01T13:42:13-05:00' id: type: string example: '2' links: type: object properties: activities: type: string example: /api/3/notes/2/activities mentions: type: string example: /api/3/notes/2/mentions notes: type: string example: /api/3/notes/2/notes owner: type: string example: /api/3/notes/2/owner user: type: string example: /api/3/notes/2/user mdate: type: string example: '2017-06-01T13:42:13-05:00' note: type: string example: Update with more info owner: type: object properties: id: type: string example: '1' type: type: string example: deal relid: type: string example: '1' reltype: type: string example: Deal user: type: string example: '1' userid: type: string example: '1' deprecated: false tags: - Deals x-microcks-operation: delay: 0 dispatcher: FALLBACK /deals/bulkUpdate: patch: summary: ActiveCampaign Bulk Update Deal Owners description: Update an existing deal operationId: bulk-update-deal-owners requestBody: content: application/json: schema: type: object properties: deals: type: array items: properties: id: type: string description: id of the Deal ownerId: type: string description: id of the Deal's Owner type: object examples: Correct request: value: deals: - id: 1 ownerId: 1 - id: 2 ownerId: 1 - id: 3 ownerId: 1 Missing ownerId: value: deals: - id: 1 - id: 2 ownerId: 2 Non-existing deal id: value: deals: - id: 99999999 ownerId: 2 responses: '200': description: '200' content: application/json: examples: Result: value: "{\n \"success\": [\n \"1\",\n \"2\"\n ],\n \"nochange\": [\n \"3\"\n ],\n \"failed\": []\n}" schema: type: object properties: success: type: array items: type: string example: '1' nochange: type: array items: type: string example: '3' failed: type: array '422': description: '422' content: application/json: examples: Mandatory ownerId: value: "{\n \"errors\": [\n {\n \"status\": 422,\n \"title\": \"ownerId is required for a deal '1'.\"\n }\n ]\n}" schema: type: object properties: errors: type: array items: type: object properties: status: type: integer example: 422 default: 0 title: type: string example: ownerId is required for a deal '1'. text/plain: examples: Non-existing ownerId: value: "{\n \"errors\": [\n {\n \"status\": 422,\n \"title\": \"Owner(user) with id '999999' was not found for a deal '1'.\"\n }\n ]\n}" schema: type: object properties: errors: type: array items: type: object properties: status: type: integer example: 422 default: 0 title: type: string example: Owner(user) with id '999999' was not found for a deal '1'. deprecated: false x-readme: code-samples: - language: text code: "{\n \"deals\": [\n {\n \"id\": 1,\n \"ownerId\": 999999\n }\n ]\n}" name: Non-existing ownerId samples-languages: - text tags: - Deals x-microcks-operation: delay: 0 dispatcher: FALLBACK /dealActivities: get: summary: ActiveCampaign List All Deal Activities description: View a recent activity for Deals. A specific deal's activity can also be viewed using /api/3/deals/[dealID]/dealActivities. operationId: list-all-deal-activities parameters: - name: exclude in: query description: Include this param to exclude "email", "connection_email", and "LinkData" activity types schema: type: string - name: deal in: query description: Filter by deal ID schema: type: string - name: filters[data_type] in: query description: 'Enter any dataType (see Response Details) to filter by that type. Examples: "userid" or task" or "note"' schema: type: string - name: filters[data_id] in: query description: Enter any dataId (see Response details) to filter by related object. Example "291" for a note with ID 291 schema: type: string responses: '200': description: '200' content: application/json: examples: Result: value: "\"dealActivities\": [\n\t{\n \"d_id\": \"1361\",\n \"d_stageid\": \"0\",\n \"userid\": \"1\",\n \"dataId\": \"0\",\n \"dataType\": \"\",\n \"dataAction\": \"add\",\n \"dataOldval\": \"\",\n \"cdate\": \"2023-03-29T10:22:03-05:00\",\n \"sortdate\": \"2023-03-29T10:22:03-05:00\",\n \"isAddtask\": \"0\",\n \"deleted\": \"0\",\n \"seriesid\": \"0\",\n \"links\": {\n \"deal\": \"https://account.activehosted.com/api/3/dealActivities/15110/deal\",\n \"stage\": \"https://account.activehosted.com/api/3/dealActivities/15110/stage\",\n \"user\": \"https://account.activehosted.com/api/3/dealActivities/15110/user\",\n \"automation\": \"https://account.activehosted.com/api/3/dealActivities/15110/automation\",\n \"activity\": \"https://account.activehosted.com/api/3/dealActivities/15110/activity\"\n },\n \"id\": \"15110\",\n \"deal\": \"1361\",\n \"stage\": null,\n \"user\": \"1\",\n \"automation\": null\n },\n {\n \"d_id\": \"1361\",\n \"d_stageid\": \"0\",\n \"userid\": \"1\",\n \"dataId\": \"1512\",\n \"dataType\": \"contact\",\n \"dataAction\": \"add\",\n \"dataOldval\": \"\",\n \"cdate\": \"2023-03-29T10:22:04-05:00\",\n \"sortdate\": \"2023-03-29T10:22:04-05:00\",\n \"isAddtask\": \"0\",\n \"deleted\": \"0\",\n \"seriesid\": \"0\",\n \"links\": {\n \"deal\": \"https://account.activehosted.com/api/3/dealActivities/15111/deal\",\n \"stage\": \"https://account.activehosted.com/api/3/dealActivities/15111/stage\",\n \"user\": \"https://account.activehosted.com/api/3/dealActivities/15111/user\",\n \"automation\": \"https://account.activehosted.com/api/3/dealActivities/15111/automation\",\n \"activity\": \"https://account.activehosted.com/api/3/dealActivities/15111/activity\"\n },\n \"id\": \"15111\",\n \"deal\": \"1361\",\n \"stage\": null,\n \"user\": \"1\",\n \"automation\": null\n }\n ],\n \"meta\": {\n \"total\": \"2\"\n }\n}" '400': description: '400' content: application/json: examples: Result: value: '{}' schema: type: object properties: {} deprecated: false tags: - Deals x-microcks-operation: delay: 0 dispatcher: FALLBACK /dealGroups: post: summary: ActiveCampaign Create a Pipeline description: Create a new pipeline operationId: create-a-pipeline requestBody: content: application/json: schema: type: object properties: dealGroup: properties: title: type: string description: Pipeline's title. currency: type: string description: Default currency to assign to new deals that belong to this deal group. allgroups: type: integer description: Whether all user groups have permission to manage this pipeline. Can be either `1` or `0`. If `1`, all user groups can manage this pipeline. If `0`, only user groups in `dealGroup.groups` parameter can manage this pipeline. default: 1 format: int32 allusers: type: integer description: Whether new deals get auto-assigned to all users. Can be either `1` or `0`. If `1`, new deals are auto-assigned to all users unless auto-assign is disabled. If `0`, new deals are auto-assigned to only the users in `dealGroup.users` parameter. default: 0 format: int32 autoassign: type: integer description: Deal auto-assign option. Can be one of `0`, `1`, and `2`. If `0`, auto-assign is disabled. If `1`, Round Robin method is used to auto-assign new deals. If `2`, deals are distributed based on deal values. default: 1 format: int32 users: type: array description: List of user ids to auto-assign new deals to unless auto-assign option is disabled. items: type: string groups: type: array description: List of user group ids to allow managing this pipeline. items: type: string required: - title - currency type: object examples: Request Example: value: dealGroup: allgroups: 1 allusers: 0 autoassign: 1 currency: eur title: Qualifications users: - '3' - '4' responses: '200': description: '200' content: application/json: examples: Result: value: "{\n \"dealGroup\": {\n \"allgroups\": 1,\n \"allusers\": 0,\n \"autoassign\": 1,\n \"cdate\": \"2017-03-30T12:12:41-05:00\",\n \"currency\": \"eur\",\n \"dealGroupGroups\": [],\n \"dealGroupUsers\": [\n \"6\",\n \"7\"\n ],\n \"id\": \"5\",\n \"links\": {\n \"dealGroupGroups\": \"/api/3/dealGroups/5/dealGroupGroups\",\n \"dealGroupUsers\": \"/api/3/dealGroups/5/dealGroupUsers\",\n \"stages\": \"/api/3/dealGroups/5/stages\"\n },\n \"stages\": [\n \"12\",\n \"13\",\n \"14\"\n ],\n \"title\": \"Qualifications\",\n \"udate\": \"2017-03-30T12:12:41-05:00\"\n },\n \"dealGroupGroups\": [],\n \"dealGroupUsers\": [\n {\n \"cdate\": null,\n \"dealGroup\": \"5\",\n \"id\": \"6\",\n \"links\": {\n \"dealGroup\": \"/api/3/dealGroupUsers/6/dealGroup\",\n \"user\": \"/api/3/dealGroupUsers/6/user\"\n },\n \"user\": \"3\"\n },\n {\n \"cdate\": null,\n \"dealGroup\": \"5\",\n \"id\": \"7\",\n \"links\": {\n \"dealGroup\": \"/api/3/dealGroupUsers/7/dealGroup\",\n \"user\": \"/api/3/dealGroupUsers/7/user\"\n },\n \"user\": \"4\"\n }\n ],\n \"dealStages\": [\n {\n \"cardRegion1\": \"title\",\n \"cardRegion2\": \"next-action\",\n \"cardRegion3\": \"show-avatar\",\n \"cardRegion4\": \"contact-fullname-orgname\",\n \"cardRegion5\": \"value\",\n \"cdate\": null,\n \"color\": \"18D499\",\n \"dealOrder\": \"next-action DESC\",\n \"group\": \"5\",\n \"id\": \"12\",\n \"links\": {\n \"group\": \"/api/3/dealStages/12/group\"\n },\n \"order\": \"1\",\n \"title\": \"To Contact\",\n \"udate\": null,\n \"width\": \"280\"\n },\n {\n \"cardRegion1\": \"title\",\n \"cardRegion2\": \"next-action\",\n \"cardRegion3\": \"show-avatar\",\n \"cardRegion4\": \"contact-fullname-orgname\",\n \"cardRegion5\": \"value\",\n \"cdate\": null,\n \"color\": \"32B0FC\",\n \"dealOrder\": \"next-action DESC\",\n \"group\": \"5\",\n \"id\": \"13\",\n \"links\": {\n \"group\": \"/api/3/dealStages/13/group\"\n },\n \"order\": \"2\",\n \"title\": \"In Contact\",\n \"udate\": null,\n \"width\": \"280\"\n },\n {\n \"cardRegion1\": \"title\",\n \"cardRegion2\": \"next-action\",\n \"cardRegion3\": \"show-avatar\",\n \"cardRegion4\": \"contact-fullname-orgname\",\n \"cardRegion5\": \"value\",\n \"cdate\": null,\n \"color\": \"E6CE4B\",\n \"dealOrder\": \"next-action DESC\",\n \"group\": \"5\",\n \"id\": \"14\",\n \"links\": {\n \"group\": \"/api/3/dealStages/14/group\"\n },\n \"order\": \"3\",\n \"title\": \"Follow Up\",\n \"udate\": null,\n \"width\": \"280\"\n }\n ]\n}\n" schema: type: object properties: dealGroup: type: object properties: allgroups: type: integer example: 1 default: 0 allusers: type: integer example: 0 default: 0 autoassign: type: integer example: 1 default: 0 cdate: type: string example: '2017-03-30T12:12:41-05:00' currency: type: string example: eur dealGroupGroups: type: array dealGroupUsers: type: array items: type: string example: '6' id: type: string example: '5' links: type: object properties: dealGroupGroups: type: string example: /api/3/dealGroups/5/dealGroupGroups dealGroupUsers: type: string example: /api/3/dealGroups/5/dealGroupUsers stages: type: string example: /api/3/dealGroups/5/stages stages: type: array items: type: string example: '12' title: type: string example: Qualifications udate: type: string example: '2017-03-30T12:12:41-05:00' dealGroupGroups: type: array dealGroupUsers: type: array items: type: object properties: cdate: {} dealGroup: type: string example: '5' id: type: string example: '6' links: type: object properties: dealGroup: type: string example: /api/3/dealGroupUsers/6/dealGroup user: type: string example: /api/3/dealGroupUsers/6/user user: type: string example: '3' dealStages: type: array items: type: object properties: cardRegion1: type: string example: title cardRegion2: type: string example: next-action cardRegion3: type: string example: show-avatar cardRegion4: type: string example: contact-fullname-orgname cardRegion5: type: string example: value cdate: {} color: type: string example: 18D499 dealOrder: type: string example: next-action DESC group: type: string example: '5' id: type: string example: '12' links: type: object properties: group: type: string example: /api/3/dealStages/12/group order: type: string example: '1' title: type: string example: To Contact udate: {} width: type: string example: '280' '400': description: '400' content: application/json: examples: Result: value: '{}' schema: type: object properties: {} deprecated: false tags: - Deals x-microcks-operation: delay: 0 dispatcher: FALLBACK get: summary: ActiveCampaign List All Pipelines description: Retrieve all existing pipelines operationId: list-all-pipelines parameters: - name: filters[title] in: query description: Filter by pipeline's title. The filter matches any pipeline titles that contain the provided title (i.e. "Contact" matches all of "In Contact", "To Contact", and "Contact Pipeline"). schema: type: string - name: filters[have_stages] in: query description: Filter by whether pipelines have deal stages. Can be either `1` or `0`. If `1`, only pipelines with at least one stage will be returned. schema: type: integer format: int32 - name: orders[title] in: query description: Order by Pipeline's title schema: type: string default: ASC - name: orders[popular] in: query description: Order by number of deals each pipeline has. If pipelines have same number of deals, pipelines' created dates are used to determine the order. schema: type: string default: ASC responses: '200': description: '200' content: application/json: examples: Result: value: "{\n \"dealGroups\": [\n {\n \"allgroups\": \"1\",\n \"allusers\": \"1\",\n \"autoassign\": \"1\",\n \"cdate\": \"2017-01-16T14:51:57-06:00\",\n \"currency\": \"usd\",\n \"id\": \"1\",\n \"links\": {\n \"dealGroupGroups\": \"/api/3/dealGroups/1/dealGroupGroups\",\n \"dealGroupUsers\": \"/api/3/dealGroups/1/dealGroupUsers\",\n \"stages\": \"/api/3/dealGroups/1/stages\"\n },\n \"stages\": [\n \"1\",\n \"2\"\n ],\n \"title\": \"Pipeline A\",\n \"udate\": \"2017-03-01T11:06:32-06:00\"\n },\n {\n \"allgroups\": \"1\",\n \"allusers\": \"1\",\n \"autoassign\": \"0\",\n \"cdate\": \"2017-03-01T14:45:16-06:00\",\n \"currency\": \"usd\",\n \"id\": \"5\",\n \"links\": {\n \"dealGroupGroups\": \"/api/3/dealGroups/5/dealGroupGroups\",\n \"dealGroupUsers\": \"/api/3/dealGroups/5/dealGroupUsers\",\n \"stages\": \"/api/3/dealGroups/5/stages\"\n },\n \"stages\": [\n \"12\",\n \"13\",\n \"14\"\n ],\n \"title\": \"Pipeline Yesterday\",\n \"udate\": \"2017-03-01T15:07:18-06:00\"\n }\n ],\n \"dealStages\": [\n {\n \"cardRegion1\": \"title\",\n \"cardRegion2\": \"next-action\",\n \"cardRegion3\": \"show-avatar\",\n \"cardRegion4\": \"contact-fullname-orgname\",\n \"cardRegion5\": \"value\",\n \"cdate\": \"2017-01-20T09:27:32-06:00\",\n \"color\": \"C481DF\",\n \"dealOrder\": \"next-action DESC\",\n \"group\": \"1\",\n \"id\": \"1\",\n \"links\": {\n \"group\": \"/api/3/dealStages/1/group\"\n },\n \"order\": \"1\",\n \"title\": \"Stage 1\",\n \"udate\": \"2017-03-01T11:06:14-06:00\",\n \"width\": \"280\"\n },\n {\n \"cardRegion1\": \"title\",\n \"cardRegion2\": \"next-action\",\n \"cardRegion3\": \"show-avatar\",\n \"cardRegion4\": \"contact-fullname-orgname\",\n \"cardRegion5\": \"value\",\n \"cdate\": \"2017-01-20T09:27:34-06:00\",\n \"color\": \"00ECC5\",\n \"dealOrder\": \"next-action DESC\",\n \"group\": \"1\",\n \"id\": \"2\",\n \"links\": {\n \"group\": \"/api/3/dealStages/2/group\"\n },\n \"order\": \"2\",\n \"title\": \"Stage 2\",\n \"udate\": \"2017-03-01T11:06:20-06:00\",\n \"width\": \"280\"\n },\n {\n \"cardRegion1\": \"title\",\n \"cardRegion2\": \"next-action\",\n \"cardRegion3\": \"show-avatar\",\n \"cardRegion4\": \"contact-fullname-orgname\",\n \"cardRegion5\": \"value\",\n \"cdate\": null,\n \"color\": \"18D499\",\n \"dealOrder\": \"next-action DESC\",\n \"group\": \"5\",\n \"id\": \"12\",\n \"links\": {\n \"group\": \"/api/3/dealStages/12/group\"\n },\n \"order\": \"1\",\n \"title\": \"To Contact\",\n \"udate\": null,\n \"width\": \"280\"\n },\n {\n \"cardRegion1\": \"title\",\n \"cardRegion2\": \"next-action\",\n \"cardRegion3\": \"show-avatar\",\n \"cardRegion4\": \"contact-fullname-orgname\",\n \"cardRegion5\": \"value\",\n \"cdate\": null,\n \"color\": \"32B0FC\",\n \"dealOrder\": \"next-action DESC\",\n \"group\": \"5\",\n \"id\": \"13\",\n \"links\": {\n \"group\": \"/api/3/dealStages/13/group\"\n },\n \"order\": \"2\",\n \"title\": \"In Contact\",\n \"udate\": null,\n \"width\": \"280\"\n },\n {\n \"cardRegion1\": \"title\",\n \"cardRegion2\": \"next-action\",\n \"cardRegion3\": \"show-avatar\",\n \"cardRegion4\": \"contact-fullname-orgname\",\n \"cardRegion5\": \"value\",\n \"cdate\": null,\n \"color\": \"E6CE4B\",\n \"dealOrder\": \"next-action DESC\",\n \"group\": \"5\",\n \"id\": \"14\",\n \"links\": {\n \"group\": \"/api/3/dealStages/14/group\"\n },\n \"order\": \"3\",\n \"title\": \"Follow Up\",\n \"udate\": null,\n \"width\": \"280\"\n }\n ],\n \"meta\": {\n \"total\": \"2\"\n }\n}" schema: type: object properties: dealGroups: type: array items: type: object properties: allgroups: type: string example: '1' allusers: type: string example: '1' autoassign: type: string example: '1' cdate: type: string example: '2017-01-16T14:51:57-06:00' currency: type: string example: usd id: type: string example: '1' links: type: object properties: dealGroupGroups: type: string example: /api/3/dealGroups/1/dealGroupGroups dealGroupUsers: type: string example: /api/3/dealGroups/1/dealGroupUsers stages: type: string example: /api/3/dealGroups/1/stages stages: type: array items: type: string example: '1' title: type: string example: Pipeline A udate: type: string example: '2017-03-01T11:06:32-06:00' dealStages: type: array items: type: object properties: cardRegion1: type: string example: title cardRegion2: type: string example: next-action cardRegion3: type: string example: show-avatar cardRegion4: type: string example: contact-fullname-orgname cardRegion5: type: string example: value cdate: type: string example: '2017-01-20T09:27:32-06:00' color: type: string example: C481DF dealOrder: type: string example: next-action DESC group: type: string example: '1' id: type: string example: '1' links: type: object properties: group: type: string example: /api/3/dealStages/1/group order: type: string example: '1' title: type: string example: Stage 1 udate: type: string example: '2017-03-01T11:06:14-06:00' width: type: string example: '280' 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: - Deals x-microcks-operation: delay: 0 dispatcher: FALLBACK /dealGroups/{id}: get: summary: ActiveCampaign Retrieve a Pipeline description: Retrieve an existing pipeline operationId: retrieve-a-pipeline parameters: - name: id in: path description: Pipeline's id schema: type: string required: true responses: '200': description: '200' content: application/json: examples: Result: value: "{\n \"dealGroup\": {\n \"allgroups\": \"1\",\n \"allusers\": \"0\",\n \"autoassign\": \"1\",\n \"cdate\": \"2017-03-30T12:11:30-05:00\",\n \"currency\": \"eur\",\n \"id\": \"4\",\n \"links\": {\n \"dealGroupGroups\": \"/api/3/dealGroups/4/dealGroupGroups\",\n \"dealGroupUsers\": \"/api/3/dealGroups/4/dealGroupUsers\",\n \"stages\": \"/api/3/dealGroups/4/stages\"\n },\n \"stages\": [\n \"9\",\n \"10\",\n \"11\"\n ],\n \"title\": \"Qualifications\",\n \"udate\": \"2017-03-30T13:44:32-05:00\"\n },\n \"dealStages\": [\n {\n \"cardRegion1\": \"title\",\n \"cardRegion2\": \"next-action\",\n \"cardRegion3\": \"show-avatar\",\n \"cardRegion4\": \"contact-fullname-orgname\",\n \"cardRegion5\": \"value\",\n \"cdate\": null,\n \"color\": \"18D499\",\n \"dealOrder\": \"next-action DESC\",\n \"group\": \"4\",\n \"id\": \"9\",\n \"links\": {\n \"group\": \"/api/3/dealStages/9/group\"\n },\n \"order\": \"1\",\n \"title\": \"To Contact\",\n \"udate\": null,\n \"width\": \"280\"\n },\n {\n \"cardRegion1\": \"title\",\n \"cardRegion2\": \"next-action\",\n \"cardRegion3\": \"show-avatar\",\n \"cardRegion4\": \"contact-fullname-orgname\",\n \"cardRegion5\": \"value\",\n \"cdate\": null,\n \"color\": \"32B0FC\",\n \"dealOrder\": \"next-action DESC\",\n \"group\": \"4\",\n \"id\": \"10\",\n \"links\": {\n \"group\": \"/api/3/dealStages/10/group\"\n },\n \"order\": \"2\",\n \"title\": \"In Contact\",\n \"udate\": null,\n \"width\": \"280\"\n },\n {\n \"cardRegion1\": \"title\",\n \"cardRegion2\": \"next-action\",\n \"cardRegion3\": \"show-avatar\",\n \"cardRegion4\": \"contact-fullname-orgname\",\n \"cardRegion5\": \"value\",\n \"cdate\": null,\n \"color\": \"E6CE4B\",\n \"dealOrder\": \"next-action DESC\",\n \"group\": \"4\",\n \"id\": \"11\",\n \"links\": {\n \"group\": \"/api/3/dealStages/11/group\"\n },\n \"order\": \"3\",\n \"title\": \"Follow Up\",\n \"udate\": null,\n \"width\": \"280\"\n }\n ]\n}" schema: type: object properties: dealGroup: type: object properties: allgroups: type: string example: '1' allusers: type: string example: '0' autoassign: type: string example: '1' cdate: type: string example: '2017-03-30T12:11:30-05:00' currency: type: string example: eur id: type: string example: '4' links: type: object properties: dealGroupGroups: type: string example: /api/3/dealGroups/4/dealGroupGroups dealGroupUsers: type: string example: /api/3/dealGroups/4/dealGroupUsers stages: type: string example: /api/3/dealGroups/4/stages stages: type: array items: type: string example: '9' title: type: string example: Qualifications udate: type: string example: '2017-03-30T13:44:32-05:00' dealStages: type: array items: type: object properties: cardRegion1: type: string example: title cardRegion2: type: string example: next-action cardRegion3: type: string example: show-avatar cardRegion4: type: string example: contact-fullname-orgname cardRegion5: type: string example: value cdate: {} color: type: string example: 18D499 dealOrder: type: string example: next-action DESC group: type: string example: '4' id: type: string example: '9' links: type: object properties: group: type: string example: /api/3/dealStages/9/group order: type: string example: '1' title: type: string example: To Contact udate: {} width: type: string example: '280' '400': description: '400' content: application/json: examples: Result: value: '{}' schema: type: object properties: {} deprecated: false tags: - Deals x-microcks-operation: delay: 0 dispatcher: FALLBACK put: summary: ActiveCampaign Update a Pipeline description: Update an existing pipeline operationId: update-a-pipeline parameters: - name: id in: path description: Pipeline's id schema: type: integer format: int32 required: true requestBody: content: application/json: schema: type: object properties: dealGroup: properties: title: type: string description: Pipeline's title currency: type: string description: Default currency to assign to new deals that belong to this deal group. allgroups: type: integer description: Whether all user groups have permission to manage this pipeline. Can be either `1` or `0`. If `1`, all user groups can manage this pipeline. If `0`, only user groups in `dealGroup.groups` parameter can manage this pipeline. default: 1 format: int32 allusers: type: integer description: Whether new deals get auto-assigned to all users. Can be either `1` or `0`. If `1`, new deals are auto-assigned to all users unless auto-assign is disabled. If `0`, new deals are auto-assigned to only the users in `dealGroup.users` parameter. default: 0 format: int32 autoassign: type: integer description: Deal auto-assign option. Can be one of `0`, `1`, and `2`. If `0`, auto-assign is disabled. If `1`, Round Robin method is used to auto-assign new deals. If `2`, deals are distributed based on deal values. default: 1 format: int32 users: type: array description: List of user ids to auto-assign new deals to unless auto-assign option is disabled. items: type: string groups: type: array description: List of user group ids to allow managing this pipeline. items: type: string required: [] type: object examples: Request Example: value: dealGroup: allgroups: 1 allusers: 0 autoassign: 1 currency: eur title: Qualifications users: - '3' groups: [] responses: '200': description: '200' content: application/json: examples: Result: value: "{\n \"dealGroup\": {\n \"allgroups\": 1,\n \"allusers\": 0,\n \"autoassign\": 1,\n \"cdate\": \"2017-03-30T12:11:30-05:00\",\n \"currency\": \"eur\",\n \"dealGroupGroups\": [],\n \"dealGroupUsers\": [\n \"4\"\n ],\n \"id\": \"4\",\n \"links\": {\n \"dealGroupGroups\": \"/api/3/dealGroups/4/dealGroupGroups\",\n \"dealGroupUsers\": \"/api/3/dealGroups/4/dealGroupUsers\",\n \"stages\": \"/api/3/dealGroups/4/stages\"\n },\n \"title\": \"Qualifications\",\n \"udate\": \"2017-03-30T13:44:32-05:00\"\n },\n \"dealGroupGroups\": [],\n \"dealGroupUsers\": [\n {\n \"cdate\": null,\n \"dealGroup\": \"4\",\n \"id\": \"4\",\n \"links\": {\n \"dealGroup\": \"/api/3/dealGroupUsers/4/dealGroup\",\n \"user\": \"/api/3/dealGroupUsers/4/user\"\n },\n \"user\": \"3\"\n }\n ]\n}\n" schema: type: object properties: dealGroup: type: object properties: allgroups: type: integer example: 1 default: 0 allusers: type: integer example: 0 default: 0 autoassign: type: integer example: 1 default: 0 cdate: type: string example: '2017-03-30T12:11:30-05:00' currency: type: string example: eur dealGroupGroups: type: array dealGroupUsers: type: array items: type: string example: '4' id: type: string example: '4' links: type: object properties: dealGroupGroups: type: string example: /api/3/dealGroups/4/dealGroupGroups dealGroupUsers: type: string example: /api/3/dealGroups/4/dealGroupUsers stages: type: string example: /api/3/dealGroups/4/stages title: type: string example: Qualifications udate: type: string example: '2017-03-30T13:44:32-05:00' dealGroupGroups: type: array dealGroupUsers: type: array items: type: object properties: cdate: {} dealGroup: type: string example: '4' id: type: string example: '4' links: type: object properties: dealGroup: type: string example: /api/3/dealGroupUsers/4/dealGroup user: type: string example: /api/3/dealGroupUsers/4/user user: type: string example: '3' '400': description: '400' content: application/json: examples: Result: value: '{}' schema: type: object properties: {} deprecated: false tags: - Deals x-microcks-operation: delay: 0 dispatcher: FALLBACK delete: summary: ActiveCampaign Delete a Pipeline description: Delete an existing pipeline operationId: delete-a-pipeline parameters: - name: id in: path description: Pipeline's id schema: type: integer format: int32 required: true responses: '200': description: '200' content: application/json: examples: deals exist: value: '' deprecated: false tags: - Deals x-microcks-operation: delay: 0 dispatcher: FALLBACK /dealGroup/get_inaccessible_deal_groups: get: summary: ActiveCampaign Retrieve Inaccessible Pipelines by User description: Retrieve pipelines that given user doesn't have access to operationId: retrieve-inaccessible-pipelines-by-user parameters: - name: dealIds[] in: query description: Deal Ids required: true schema: type: array items: type: integer format: int32 - name: userId in: query description: User's Id required: true schema: type: integer format: int32 responses: '200': description: '200' content: application/json: examples: Result: value: "{\n \"dealGroups\": [\n {\n \"title\": \"p1\",\n \"currency\": \"usd\",\n \"autoassign\": \"0\",\n \"allusers\": \"1\",\n \"allgroups\": \"0\",\n \"win_probability_initialize_date\": \"0000-00-00 00:00:00\",\n \"cdate\": \"2021-08-10T12:16:06-05:00\",\n \"udate\": \"2021-11-09T10:09:25-06:00\",\n \"links\": {\n \"stages\": \"http://hosted.localdev/api/3/dealGroups/1/stages\",\n \"dealGroupUsers\": \"http://hosted.localdev/api/3/dealGroups/1/dealGroupUsers\",\n \"dealGroupGroups\": \"http://hosted.localdev/api/3/dealGroups/1/dealGroupGroups\",\n \"winProbabilityFeatures\": \"http://hosted.localdev/api/3/dealGroups/1/winProbabilityFeatures\"\n },\n \"id\": \"1\"\n },\n {\n \"title\": \"p6\",\n \"currency\": \"usd\",\n \"autoassign\": \"0\",\n \"allusers\": \"1\",\n \"allgroups\": \"0\",\n \"win_probability_initialize_date\": \"0000-00-00 00:00:00\",\n \"cdate\": \"2021-11-09T15:14:06-06:00\",\n \"udate\": \"2021-11-09T15:36:53-06:00\",\n \"links\": {\n \"stages\": \"http://hosted.localdev/api/3/dealGroups/6/stages\",\n \"dealGroupUsers\": \"http://hosted.localdev/api/3/dealGroups/6/dealGroupUsers\",\n \"dealGroupGroups\": \"http://hosted.localdev/api/3/dealGroups/6/dealGroupGroups\",\n \"winProbabilityFeatures\": \"http://hosted.localdev/api/3/dealGroups/6/winProbabilityFeatures\"\n },\n \"id\": \"6\"\n }\n ]\n}" schema: type: object properties: dealGroups: type: array items: type: object properties: title: type: string example: p1 currency: type: string example: usd autoassign: type: string example: '0' allusers: type: string example: '1' allgroups: type: string example: '0' win_probability_initialize_date: type: string example: '0000-00-00 00:00:00' cdate: type: string example: '2021-08-10T12:16:06-05:00' udate: type: string example: '2021-11-09T10:09:25-06:00' links: type: object properties: stages: type: string example: http://hosted.localdev/api/3/dealGroups/1/stages dealGroupUsers: type: string example: http://hosted.localdev/api/3/dealGroups/1/dealGroupUsers dealGroupGroups: type: string example: http://hosted.localdev/api/3/dealGroups/1/dealGroupGroups winProbabilityFeatures: type: string example: http://hosted.localdev/api/3/dealGroups/1/winProbabilityFeatures id: type: string example: '1' '422': description: '422' content: application/json: examples: Missing userId parameter: value: "{\n \"errors\": [\n {\n \"status\": 422,\n \"title\": \"Invalid Input Parameter\",\n \"detail\": \"Parameter userId is required.\"\n }\n ]\n}" schema: type: object properties: errors: type: array items: type: object properties: status: type: integer example: 422 default: 0 title: type: string example: Invalid Input Parameter detail: type: string example: Parameter userId is required. text/plain: examples: Missing dealIds parameter: value: "{\n \"errors\": [\n {\n \"status\": 422,\n \"title\": \"Invalid Input Parameter\",\n \"detail\": \"Parameter dealIds is required.\"\n }\n ]\n}" Non-existing user: value: "{\n \"errors\": [\n {\n \"status\": 422,\n \"title\": \"Invalid Input Parameter\",\n \"detail\": \"User was not found.\"\n }\n ]\n}" schema: oneOf: - title: Missing dealIds parameter type: object properties: errors: type: array items: type: object properties: status: type: integer example: 422 default: 0 title: type: string example: Invalid Input Parameter detail: type: string example: Parameter dealIds is required. - title: Non-existing user type: object properties: errors: type: array items: type: object properties: status: type: integer example: 422 default: 0 title: type: string example: Invalid Input Parameter detail: type: string example: User was not found. deprecated: false x-readme: code-samples: - language: text code: /dealGroup/get_inaccessible_deal_groups?userId=2&dealIds[]=1&dealIds[]=2&dealIds[]=3&dealIds[]=4&dealIds[]=5 samples-languages: - text tags: - Deals x-microcks-operation: delay: 0 dispatcher: FALLBACK /dealStages: post: summary: ActiveCampaign Create a Stage description: Create a new stage for a pipeline operationId: create-a-deal-stage parameters: - name: reorder in: query description: Whether to reorder stages within the pipeline after creating a new deal stage. Can be one of `0` and `1`. If set to `1`, new order values will be assigned to all stages within the same pipeline. If deal stages with the same order exists, the stage with the highest `id` will be assigned with the lowest `order` schema: type: integer format: int32 requestBody: content: application/json: schema: type: object properties: dealStage: properties: title: type: string description: Deal stage's title group: type: string description: Deal stage's pipeline id order: type: integer description: Order of the deal stage. If more than one deal stage share the same order value, the order of those deal stages may not be always the same. If `dealStage.order` is not provided, the order is assigned with `(the highest order of deal stages within the same pipeline) + 1` default: null format: int32 dealOrder: type: string description: Option and direction to be used to sort deals in the deal stage. The option and direction should be delimited by a space. Direction can be either "ASC" or "DESC". See [available options](#section-deal-stage-parameters-available-values) default: next-action DESC cardRegion1: type: string description: What to show in upper-left corner of Deal Cards. See [available values](#section-deal-stage-parameters-available-values) default: title cardRegion2: type: string description: What to show in upper-right corner of Deal Cards. See [available values](#section-deal-stage-parameters-available-values) default: next-action cardRegion3: type: string description: Whether to show the avatar in Deal Cards. Can be one of `show-avatar` and `hide-avatar`. If set to `show-avatar`, deal cards will show the avatars. If set to `hide-avatar`, deal cards will hide the avatars default: show-avatar cardRegion4: type: string description: What to show next to the avatar in Deal Cards. See [available values](#section-deal-stage-parameters-available-values) default: contact-fullname-orgname cardRegion5: type: string description: What to show in lower-right corner of Deal Cards. See [available values](#section-deal-stage-parameters-available-values) default: value color: type: string description: Deal Stage's color. 6-character HEX color code without the hashtag. e.g. "434343" to assign the hex color value "#434343" default: 3f3f3f width: type: integer description: Deal stage's width in pixels, without `px` unit default: 280 format: int32 required: - title - group type: object examples: Request Example: value: dealStage: cardRegion1: title cardRegion2: next-action cardRegion3: show-avatar cardRegion4: contact-fullname-orgname cardRegion5: value color: 32B0FC dealOrder: next-action DESC group: '4' order: 1 title: Initial Contact width: 360 responses: '200': description: '200' content: application/json: examples: Result: value: "{\n \"dealStage\": {\n \"cardRegion1\": \"title\",\n \"cardRegion2\": \"next-action\",\n \"cardRegion3\": \"show-avatar\",\n \"cardRegion4\": \"contact-fullname-orgname\",\n \"cardRegion5\": \"value\",\n \"cdate\": \"2017-03-01T15:55:58-06:00\",\n \"color\": \"32B0FC\",\n \"dealOrder\": \"next-action DESC\",\n \"group\": \"4\",\n \"id\": \"16\",\n \"links\": {\n \"group\": \"/api/3/dealStages/16/group\"\n },\n \"order\": 1,\n \"title\": \"Initial Contact\",\n \"udate\": \"2017-03-01T15:55:58-06:00\",\n \"width\": 280\n }\n}" schema: type: object properties: dealStage: type: object properties: cardRegion1: type: string example: title cardRegion2: type: string example: next-action cardRegion3: type: string example: show-avatar cardRegion4: type: string example: contact-fullname-orgname cardRegion5: type: string example: value cdate: type: string example: '2017-03-01T15:55:58-06:00' color: type: string example: 32B0FC dealOrder: type: string example: next-action DESC group: type: string example: '4' id: type: string example: '16' links: type: object properties: group: type: string example: /api/3/dealStages/16/group order: type: integer example: 1 default: 0 title: type: string example: Initial Contact udate: type: string example: '2017-03-01T15:55:58-06:00' width: type: integer example: 280 default: 0 '400': description: '400' content: application/json: examples: Result: value: '{}' schema: type: object properties: {} deprecated: false tags: - Deals x-microcks-operation: delay: 0 dispatcher: FALLBACK get: summary: ActiveCampaign List All Stages description: Retrieve all existing stages operationId: list-all-deal-stages parameters: - name: filters[title] in: query description: Filter by deal stages' titles. Any stages whose titles partial-match the filter value are returned schema: type: string - name: filters[d_groupid] in: query description: Filter by pipeline's id schema: type: string - name: orders[title] in: query description: Order by deal stage's title schema: type: string responses: '200': description: '200' content: application/json: examples: Result: value: "{\n \"dealStages\": [\n {\n \"cardRegion1\": \"title\",\n \"cardRegion2\": \"next-action\",\n \"cardRegion3\": \"show-avatar\",\n \"cardRegion4\": \"contact-fullname-orgname\",\n \"cardRegion5\": \"value\",\n \"cdate\": \"2017-03-01T15:52:42-06:00\",\n \"color\": \"32B0FC\",\n \"dealOrder\": \"next-action DESC\",\n \"group\": \"4\",\n \"id\": \"15\",\n \"links\": {\n \"group\": \"/api/3/dealStages/15/group\"\n },\n \"order\": \"1\",\n \"title\": \"Initial Contact\",\n \"udate\": \"2017-03-01T15:52:42-06:00\",\n \"width\": \"280\"\n },\n {\n \"cardRegion1\": \"contact-orgname\",\n \"cardRegion2\": \"next-action\",\n \"cardRegion3\": \"hide-avatar\",\n \"cardRegion4\": \"contact-fullname-orgname\",\n \"cardRegion5\": \"value\",\n \"cdate\": \"2017-03-01T15:55:58-06:00\",\n \"color\": \"696969\",\n \"dealOrder\": \"title ASC\",\n \"group\": \"4\",\n \"id\": \"16\",\n \"links\": {\n \"group\": \"/api/3/dealStages/16/group\"\n },\n \"order\": \"1\",\n \"title\": \"Qualifications - Low\",\n \"udate\": \"2017-03-01T16:03:57-06:00\",\n \"width\": \"270\"\n }\n ],\n \"meta\": {\n \"total\": \"2\"\n }\n}" schema: type: object properties: dealStages: type: array items: type: object properties: cardRegion1: type: string example: title cardRegion2: type: string example: next-action cardRegion3: type: string example: show-avatar cardRegion4: type: string example: contact-fullname-orgname cardRegion5: type: string example: value cdate: type: string example: '2017-03-01T15:52:42-06:00' color: type: string example: 32B0FC dealOrder: type: string example: next-action DESC group: type: string example: '4' id: type: string example: '15' links: type: object properties: group: type: string example: /api/3/dealStages/15/group order: type: string example: '1' title: type: string example: Initial Contact udate: type: string example: '2017-03-01T15:52:42-06:00' width: type: string example: '280' 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: - Deals x-microcks-operation: delay: 0 dispatcher: FALLBACK /dealStages/{id}: get: summary: ActiveCampaign Retrieve a Stage description: Retrieve an existing stage operationId: retrieve-a-deal-stage parameters: - name: id in: path description: Deal stage's id schema: type: integer format: int32 required: true responses: '200': description: '200' content: application/json: examples: Result: value: "{\n \"dealStage\": {\n \"cardRegion1\": \"title\",\n \"cardRegion2\": \"next-action\",\n \"cardRegion3\": \"show-avatar\",\n \"cardRegion4\": \"contact-fullname-orgname\",\n \"cardRegion5\": \"value\",\n \"cdate\": \"2017-01-20T09:27:32-06:00\",\n \"color\": \"C481DF\",\n \"dealOrder\": \"score DESC\",\n \"group\": \"1\",\n \"id\": \"1\",\n \"links\": {\n \"group\": \"/api/3/dealStages/1/group\"\n },\n \"order\": \"1\",\n \"title\": \"Stage 1\",\n \"udate\": \"2017-03-02T11:41:01-06:00\",\n \"width\": \"280\"\n }\n}" schema: type: object properties: dealStage: type: object properties: cardRegion1: type: string example: title cardRegion2: type: string example: next-action cardRegion3: type: string example: show-avatar cardRegion4: type: string example: contact-fullname-orgname cardRegion5: type: string example: value cdate: type: string example: '2017-01-20T09:27:32-06:00' color: type: string example: C481DF dealOrder: type: string example: score DESC group: type: string example: '1' id: type: string example: '1' links: type: object properties: group: type: string example: /api/3/dealStages/1/group order: type: string example: '1' title: type: string example: Stage 1 udate: type: string example: '2017-03-02T11:41:01-06:00' width: type: string example: '280' '400': description: '400' content: application/json: examples: Result: value: '{}' schema: type: object properties: {} deprecated: false tags: - Deals x-microcks-operation: delay: 0 dispatcher: FALLBACK put: summary: ActiveCampaign Update a Stage description: Update an existing stage operationId: update-a-deal-stage parameters: - name: id in: path description: Deal stage's id schema: type: integer format: int32 required: true - name: reorder in: query description: Whether to reorder stages within the pipeline after creating a new deal stage. Can be one of `0` and `1`. If set to `1`, new order values will be assigned to all stages within the same pipeline. If deal stages with the same order exists, the stage with the highest `id` will be assigned with the lowest `order` schema: type: integer format: int32 requestBody: content: application/json: schema: type: object properties: dealStage: properties: title: type: string description: Deal stage's title group: type: string description: Deal stage's pipeline id order: type: integer description: Order of the deal stage. If more than one deal stage share the same order value, the order of those deal stages may not be always the same format: int32 dealOrder: type: string description: Option and direction to be used to sort deals in the deal stage. The option and direction should be delimited by a space. Direction can be either "ASC" or "DESC". See [available options](#section-deal-stage-parameters-available-values) cardRegion1: type: string description: What to show in upper-left corner of Deal Cards. See [available values](#section-deal-stage-parameters-available-values) cardRegion2: type: string description: What to show in upper-right corner of Deal Cards. See [available values](#section-deal-stage-parameters-available-values) cardRegion3: type: string description: Whether to show the avatar in Deal Cards. Can be one of `show-avatar` and `hide-avatar`. If set to `show-avatar`, deal cards will show the avatars. If set to `hide-avatar`, deal cards will hide the avatars cardRegion4: type: string description: What to show next to the avatar in Deal Cards. See [available values](#section-deal-stage-parameters-available-values) cardRegion5: type: string description: What to show in lower-right corner of Deal Cards. See [available values](#section-deal-stage-parameters-available-values) color: type: string description: Deal Stage's color. 6-character HEX color code without the hashtag. e.g. "434343" to assign the hex color value "#434343" width: type: integer description: Deal stage's width in pixels, without `px` unit format: int32 required: [] type: object examples: Request Example: value: dealStage: cardRegion1: contact-orgname cardRegion2: next-action cardRegion3: hide-avatar cardRegion4: contact-fullname-orgname cardRegion5: value color: '696969' dealOrder: title ASC group: '4' order: 1 title: Qualifications - Low width: 270 responses: '200': description: '200' content: application/json: examples: Result: value: "{\n \"dealStage\": {\n \"cardRegion1\": \"contact-orgname\",\n \"cardRegion2\": \"next-action\",\n \"cardRegion3\": \"hide-avatar\",\n \"cardRegion4\": \"contact-fullname-orgname\",\n \"cardRegion5\": \"value\",\n \"cdate\": \"2017-03-01T15:55:58-06:00\",\n \"color\": \"696969\",\n \"dealOrder\": \"title ASC\",\n \"group\": \"4\",\n \"id\": \"16\",\n \"links\": {\n \"group\": \"/api/3/dealStages/16/group\"\n },\n \"order\": 1,\n \"title\": \"Qualifications - Low\",\n \"udate\": \"2017-03-01T16:03:57-06:00\",\n \"width\": 270\n }\n}" schema: type: object properties: dealStage: type: object properties: cardRegion1: type: string example: contact-orgname cardRegion2: type: string example: next-action cardRegion3: type: string example: hide-avatar cardRegion4: type: string example: contact-fullname-orgname cardRegion5: type: string example: value cdate: type: string example: '2017-03-01T15:55:58-06:00' color: type: string example: '696969' dealOrder: type: string example: title ASC group: type: string example: '4' id: type: string example: '16' links: type: object properties: group: type: string example: /api/3/dealStages/16/group order: type: integer example: 1 default: 0 title: type: string example: Qualifications - Low udate: type: string example: '2017-03-01T16:03:57-06:00' width: type: integer example: 270 default: 0 '400': description: '400' content: application/json: examples: Result: value: '{}' schema: type: object properties: {} deprecated: false tags: - Deals x-microcks-operation: delay: 0 dispatcher: FALLBACK delete: summary: ActiveCampaign Delete a Stage description: Delete an existing stage operationId: delete-a-deal-stage parameters: - name: id in: path description: Deal stage's id schema: type: integer format: int32 required: true responses: '200': description: '200' content: application/json: examples: Result: value: '{}' schema: type: object properties: {} deprecated: false tags: - Deals x-microcks-operation: delay: 0 dispatcher: FALLBACK /dealStages/{id}/deals: put: summary: ActiveCampaign Move Deals to Another Stage description: Move all deals in one stage to another stage operationId: move-deals-to-another-deal-stage parameters: - name: id in: path description: Deal stage's id whose deals are to be moved to another deal stage schema: type: integer format: int32 required: true requestBody: content: application/json: schema: type: object properties: deal: properties: stage: type: string description: Target deal stage's id to move deals to required: [] type: object examples: Request Example: value: deal: stage: '3' responses: '200': description: '200' content: application/json: examples: Result: value: "{\n \"deals\": [\n {\n \"activitycount\": \"1\",\n \"cdate\": \"2017-05-19T16:21:47-05:00\",\n \"contact\": \"1\",\n \"currency\": \"usd\",\n \"edate\": \"0000-00-00 00:00:00\",\n \"group\": \"1\",\n \"hash\": \"6faccb2d\",\n \"id\": \"1\",\n \"links\": {\n \"dealActivities\": \"/api/3/deals/1/dealActivities\",\n \"contact\": \"/api/3/deals/1/contact\",\n \"contactDeals\": \"/api/3/deals/1/contactDeals\",\n \"group\": \"/api/3/deals/1/group\",\n \"nextTask\": \"/api/3/deals/1/nextTask\",\n \"notes\": \"/api/3/deals/1/notes\",\n \"organization\": \"/api/3/deals/1/organization\",\n \"owner\": \"/api/3/deals/1/owner\",\n \"scoreValues\": \"/api/3/deals/1/scoreValues\",\n \"stage\": \"/api/3/deals/1/stage\",\n \"tasks\": \"/api/3/deals/1/tasks\"\n },\n \"mdate\": \"2017-05-19T16:21:47-05:00\",\n \"nextTask\": null,\n \"nextdealid\": \"2\",\n \"nexttaskid\": \"0\",\n \"organization\": null,\n \"owner\": \"1\",\n \"percent\": \"0\",\n \"stage\": \"3\",\n \"status\": \"0\",\n \"title\": \"Another Deal\",\n \"value\": \"10000\"\n },\n {\n \"activitycount\": \"1\",\n \"cdate\": \"2017-05-19T16:23:01-05:00\",\n \"contact\": \"2\",\n \"currency\": \"usd\",\n \"edate\": \"0000-00-00 00:00:00\",\n \"group\": \"1\",\n \"hash\": \"fe7cc4f3\",\n \"id\": \"2\",\n \"links\": {\n \"dealActivities\": \"/api/3/deals/2/dealActivities\",\n \"contact\": \"/api/3/deals/2/contact\",\n \"contactDeals\": \"/api/3/deals/2/contactDeals\",\n \"group\": \"/api/3/deals/2/group\",\n \"nextTask\": \"/api/3/deals/2/nextTask\",\n \"notes\": \"/api/3/deals/2/notes\",\n \"organization\": \"/api/3/deals/2/organization\",\n \"owner\": \"/api/3/deals/2/owner\",\n \"scoreValues\": \"/api/3/deals/2/scoreValues\",\n \"stage\": \"/api/3/deals/2/stage\",\n \"tasks\": \"/api/3/deals/2/tasks\"\n },\n \"mdate\": \"2017-05-19T16:23:01-05:00\",\n \"nextTask\": null,\n \"nextdealid\": \"1\",\n \"nexttaskid\": \"0\",\n \"organization\": null,\n \"owner\": \"1\",\n \"percent\": \"0\",\n \"stage\": \"3\",\n \"status\": \"0\",\n \"title\": \"Urgent Deal\",\n \"value\": \"10000\"\n }\n ]\n}" schema: type: object properties: deals: type: array items: type: object properties: activitycount: type: string example: '1' cdate: type: string example: '2017-05-19T16:21:47-05:00' contact: type: string example: '1' currency: type: string example: usd edate: type: string example: '0000-00-00 00:00:00' group: type: string example: '1' hash: type: string example: 6faccb2d id: type: string example: '1' links: type: object properties: dealActivities: type: string example: /api/3/deals/1/dealActivities contact: type: string example: /api/3/deals/1/contact contactDeals: type: string example: /api/3/deals/1/contactDeals group: type: string example: /api/3/deals/1/group nextTask: type: string example: /api/3/deals/1/nextTask notes: type: string example: /api/3/deals/1/notes organization: type: string example: /api/3/deals/1/organization owner: type: string example: /api/3/deals/1/owner scoreValues: type: string example: /api/3/deals/1/scoreValues stage: type: string example: /api/3/deals/1/stage tasks: type: string example: /api/3/deals/1/tasks mdate: type: string example: '2017-05-19T16:21:47-05:00' nextTask: {} nextdealid: type: string example: '2' nexttaskid: type: string example: '0' organization: {} owner: type: string example: '1' percent: type: string example: '0' stage: type: string example: '3' status: type: string example: '0' title: type: string example: Another Deal value: type: string example: '10000' '422': description: '422' content: application/json: examples: Different pipeline: value: "{\n \"errors\": [\n {\n \"detail\": \"Target stage does not belong to same pipeline\",\n \"source\": {\n \"pointer\": \"/data/attributes/stage\"\n },\n \"status\": 422,\n \"title\": \"Invalid attribute\"\n }\n ]\n}" schema: type: object properties: errors: type: array items: type: object properties: detail: type: string example: Target stage does not belong to same pipeline source: type: object properties: pointer: type: string example: /data/attributes/stage status: type: integer example: 422 default: 0 title: type: string example: Invalid attribute deprecated: false tags: - Deals x-microcks-operation: delay: 0 dispatcher: FALLBACK /dealCustomFieldMeta: post: summary: ActiveCampaign Create a Custom Field Meta description: '' operationId: create-custom-deal-field-meta requestBody: content: application/json: schema: type: object properties: dealCustomFieldMetum: properties: fieldLabel: type: string description: Name of the field fieldType: type: string description: 'Type of field. Possible values are: `text`, `textarea`, `date`, `datetime`, `dropdown`, `multiselect`, `radio`, `checkbox`, `hidden`, `currency`, or `number`.' fieldOptions: type: array description: Options for the field. Only necessary if `field_type` is `dropdown`, `multiselect`, `radio`, or `checkbox`. items: type: string fieldDefault: type: string description: Default value of the field fieldDefaultCurrency: type: string description: The 3-letter currency code of the default currency for the field. Only necessary if `field_type` is `currency`. isFormVisible: type: boolean description: Whether or not the field is visible on forms displayOrder: type: integer description: Order for displaying the field on Manage Fields page and deal profiles format: int32 required: - fieldLabel - fieldType type: object examples: text: value: dealCustomFieldMetum: fieldLabel: sample text field2 fieldType: text fieldDefault: Default Text isFormVisible: 1 displayOrder: 1 textarea: value: dealCustomFieldMetum: fieldLabel: sample textarea field fieldType: textarea fieldDefault: Default Text in Text Area isFormVisible: 1 isRequired: 1 displayOrder: 2 date: value: dealCustomFieldMetum: fieldLabel: sample date field fieldType: date fieldDefault: '2018-12-31 00:00:00' isFormVisible: 1 isRequired: 1 displayOrder: 3 dropdown: value: dealCustomFieldMetum: fieldLabel: sample dropdown field fieldType: dropdown fieldDefault: option 2 fieldOptions: - option 1 - option 2 - option 3 isFormVisible: 1 isRequired: 1 displayOrder: 4 multiselect: value: dealCustomFieldMetum: fieldLabel: sample multiselect field fieldType: multiselect fieldDefault: - option 2 - option 3 fieldOptions: - option 1 - option 2 - option 3 isFormVisible: 1 isRequired: 1 displayOrder: 5 radio: value: dealCustomFieldMetum: fieldLabel: sample radio field fieldType: radio fieldDefault: option 2 fieldOptions: - option 1 - option 2 - option 3 isFormVisible: 1 isRequired: 1 displayOrder: 6 checkbox: value: dealCustomFieldMetum: fieldLabel: sample checkbox field fieldType: checkbox fieldDefault: - option 2 - option 3 fieldOptions: - option 1 - option 2 - option 3 isFormVisible: 1 isRequired: 1 displayOrder: 7 hidden: value: dealCustomFieldMetum: fieldLabel: sample hidden field fieldType: hidden fieldDefault: Default Text in Hidden Field isFormVisible: 1 isRequired: 1 displayOrder: 8 number: value: dealCustomFieldMetum: fieldLabel: sample number field fieldType: number fieldDefault: '100.99' isFormVisible: 1 isRequired: 1 displayOrder: 9 currency: value: dealCustomFieldMetum: fieldLabel: sample money field fieldType: currency fieldDefault: '10099' fieldDefaultCurrency: aud isFormVisible: 1 isRequired: 1 displayOrder: 10 datetime (ISO): value: dealCustomFieldMetum: fieldLabel: sample datetime field fieldType: datetime fieldDefault: '2020-05-16T03:15:00-05:00' isFormVisible: 1 isRequired: 1 displayOrder: 3 responses: '200': description: '200' content: application/json: examples: Result: value: "{\n \"dealCustomFieldMetum\": {\n \"id\": \"1\",\n \"fieldLabel\": \"title\",\n \"fieldType\": \"text\",\n \"fieldOptions\": null,\n \"fieldDefault\": \"Default Text\",\n \"isFormVisible\": 1,\n \"isRequired\": 1,\n \"displayOrder\": 1,\n \"createdTimestamp\": \"2018-10-22 19:57:37\",\n \"updatedTimestamp\": \"2018-10-22 19:57:37\",\n \"links\": {\n \"dealCustomFieldData\": \"https://:account.api-us1.com/api/:version/3/dealCustomFieldMeta/1/dealCustomFieldData\"\n }\n }\n}" schema: type: object properties: dealCustomFieldMetum: type: object properties: id: type: string example: '1' fieldLabel: type: string example: title fieldType: type: string example: text fieldOptions: {} fieldDefault: type: string example: Default Text isFormVisible: type: integer example: 1 default: 0 isRequired: type: integer example: 1 default: 0 displayOrder: type: integer example: 1 default: 0 createdTimestamp: type: string example: '2018-10-22 19:57:37' updatedTimestamp: type: string example: '2018-10-22 19:57:37' links: type: object properties: dealCustomFieldData: type: string example: https://:account.api-us1.com/api/:version/3/dealCustomFieldMeta/1/dealCustomFieldData '422': description: '422' content: application/json: examples: Result: value: "{\n\t\"errors\": [\n \t\"title\": \"The field type field is required.\",\n \"detail\": \"\",\n \"code\": 422\n ]\n}" deprecated: false tags: - Deals x-microcks-operation: delay: 0 dispatcher: FALLBACK get: summary: ActiveCampaign List All Custom Fields description: '' operationId: retrieve-all-custom-deal-field-meta parameters: - name: limit in: query description: The number of fields returned per request. schema: type: integer format: int32 default: 100 responses: '200': description: '200' content: application/json: examples: Result: value: "{\n \"dealCustomFieldMeta\": [\n {\n \"id\": \"1\",\n \"fieldLabel\": \"Text Example\",\n \"fieldType\": \"text\",\n \"fieldOptions\": null,\n \"fieldDefault\": 1,\n \"fieldDefaultCurrency\": null,\n \"isFormVisible\": 0,\n \"isRequired\": 0,\n \"displayOrder\": 1,\n \"personalization\": \"\",\n \"knownFieldId\": null,\n \"hideFieldFlag\": 0,\n \"createdTimestamp\": \"2019-04-23 15:34:00\",\n \"updatedTimestamp\": \"2019-05-03 15:16:51\",\n \"links\": {\n \"dealCustomFieldData\": \"https://:account.api-us1.com/api/:version/dealCustomFieldMeta/1/dealCustomFieldData\"\n }\n },\n {\n \"id\": \"2\",\n \"fieldLabel\": \"Multiple Choice Example\",\n \"fieldType\": \"multiselect\",\n \"fieldOptions\": [\n \t\"Option 1\",\n \t\"Option 2\",\n \t\"Option 3\"\n ],\n \"fieldDefault\": 1,\n \"fieldDefaultCurrency\": null,\n \"isFormVisible\": 0,\n \"isRequired\": 0,\n \"displayOrder\": 2,\n \"personalization\": \"\",\n \"knownFieldId\": null,\n \"hideFieldFlag\": 0,\n \"createdTimestamp\": \"2019-04-23 15:34:00\",\n \"updatedTimestamp\": \"2019-05-03 15:16:51\",\n \"links\": {\n \"dealCustomFieldData\": \"https://:account.api-us1.com/api/:version/dealCustomFieldMeta/1/dealCustomFieldData\"\n }\n }\n ]\n}" schema: type: object properties: dealCustomFieldMeta: type: array items: type: object properties: id: type: string example: '1' fieldLabel: type: string example: Text Example fieldType: type: string example: text fieldOptions: {} fieldDefault: type: integer example: 1 default: 0 fieldDefaultCurrency: {} isFormVisible: type: integer example: 0 default: 0 isRequired: type: integer example: 0 default: 0 displayOrder: type: integer example: 1 default: 0 personalization: type: string example: '' knownFieldId: {} hideFieldFlag: type: integer example: 0 default: 0 createdTimestamp: type: string example: '2019-04-23 15:34:00' updatedTimestamp: type: string example: '2019-05-03 15:16:51' links: type: object properties: dealCustomFieldData: type: string example: https://:account.api-us1.com/api/:version/dealCustomFieldMeta/1/dealCustomFieldData deprecated: false tags: - Deals x-microcks-operation: delay: 0 dispatcher: FALLBACK /dealCustomFieldMeta/{id}: get: summary: ActiveCampaign Retrieve a Custom Field description: '' operationId: retrieve-a-custom-deal-field-meta parameters: - name: id in: path description: ID of the field to retrieve schema: type: integer format: int32 required: true responses: '200': description: '200' content: application/json: examples: Result: value: "{\n \"dealCustomFieldMetum\": {\n \"id\": \"1\",\n \"fieldLabel\": \"New Title\",\n \"fieldType\": \"text\",\n \"fieldOptions\": null,\n \"fieldDefault\": \"Default Text\",\n \"isFormVisible\": 1,\n \"isRequired\": 1,\n \"displayOrder\": 1,\n \"createdTimestamp\": \"2018-10-22 19:57:37\",\n \"updatedTimestamp\": \"2018-10-22 20:04:21\",\n \"links\": {\n \"dealCustomFieldData\": \"https://:account.api-us1.com/api/:version/dealCustomFieldMeta/1/dealCustomFieldData\"\n }\n }\n}" schema: type: object properties: dealCustomFieldMetum: type: object properties: id: type: string example: '1' fieldLabel: type: string example: New Title fieldType: type: string example: text fieldOptions: {} fieldDefault: type: string example: Default Text isFormVisible: type: integer example: 1 default: 0 isRequired: type: integer example: 1 default: 0 displayOrder: type: integer example: 1 default: 0 createdTimestamp: type: string example: '2018-10-22 19:57:37' updatedTimestamp: type: string example: '2018-10-22 20:04:21' links: type: object properties: dealCustomFieldData: type: string example: https://:account.api-us1.com/api/:version/dealCustomFieldMeta/1/dealCustomFieldData '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 tags: - Deals x-microcks-operation: delay: 0 dispatcher: FALLBACK put: summary: ActiveCampaign Update a Custom Field description: '' operationId: update-a-custom-deal-field-meta parameters: - name: id in: path description: ID of the custom field to update schema: type: integer format: int32 required: true requestBody: content: application/json: schema: type: object properties: dealCustomFieldMetum: properties: fieldLabel: type: string description: Name of the field fieldOptions: type: array description: Options for the field. Only necessary if field_type is dropdown, multiselect, radio, or checkbox. items: type: string fieldDefault: type: string description: Default value of the field isFormVisible: type: boolean description: Whether or not the field is visible on forms displayOrder: type: integer description: Order for displaying the field on Manage Fields page and deal profiles format: int32 required: [] type: object examples: Request Example: value: dealCustomFieldMetum: fieldLabel: New Title fieldDefault: Default Text isFormVisible: 1 displayOrder: 1 responses: '200': description: '200' content: application/json: examples: Result: value: "{\n \"dealCustomFieldMetum\": {\n \"id\": \"1\",\n \"fieldLabel\": \"New Title\",\n \"fieldType\": \"text\",\n \"fieldOptions\": null,\n \"fieldDefault\": \"Default Text\",\n \"isFormVisible\": 1,\n \"isRequired\": 0,\n \"displayOrder\": 1,\n \"createdTimestamp\": \"2018-10-22 19:57:37\",\n \"updatedTimestamp\": \"2018-10-22 20:04:21\",\n \"links\": {\n \"dealCustomFieldData\": \"https://:account.api-us1.com/api/:version/dealCustomFieldMeta/1/dealCustomFieldData\"\n }\n }\n}" schema: type: object properties: dealCustomFieldMetum: type: object properties: id: type: string example: '1' fieldLabel: type: string example: New Title fieldType: type: string example: text fieldOptions: {} fieldDefault: type: string example: Default Text isFormVisible: type: integer example: 1 default: 0 isRequired: type: integer example: 0 default: 0 displayOrder: type: integer example: 1 default: 0 createdTimestamp: type: string example: '2018-10-22 19:57:37' updatedTimestamp: type: string example: '2018-10-22 20:04:21' links: type: object properties: dealCustomFieldData: type: string example: https://:account.api-us1.com/api/:version/dealCustomFieldMeta/1/dealCustomFieldData '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 tags: - Deals x-microcks-operation: delay: 0 dispatcher: FALLBACK delete: summary: ActiveCampaign Delete a Custom Field description: '' operationId: delete-a-custom-deal-field-meta parameters: - name: id in: path description: ID of the field to delete schema: type: integer format: int32 required: true responses: '200': description: '200' content: application/json: examples: Result: value: "{\n \"message\": \"DealCustomFieldMeta deleted.\"\n}" schema: type: object properties: message: type: string example: DealCustomFieldMeta deleted. '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 tags: - Deals x-microcks-operation: delay: 0 dispatcher: FALLBACK /dealCustomFieldData: post: summary: ActiveCampaign Create a Custom Field Value description: '' operationId: create-custom-deal-field-value requestBody: content: application/json: schema: type: object properties: dealCustomFieldDatum: properties: dealId: type: integer description: The ID of the deal this field value relates to format: int32 customFieldId: type: integer description: The ID of the custom field metum this field value relates to format: int32 fieldValue: type: string description: 'Values for the field. (For `currency` field only, this needs to be in cents: eg, 10050 = 100.5)' fieldCurrency: type: string description: Currency code for the money value default: Default Currency for Field required: - dealId - customFieldId - fieldValue type: object examples: text/textarea/hidden: value: dealCustomFieldDatum: dealId: '2' customFieldId: '1' fieldValue: test title dropdown/radio: value: dealCustomFieldDatum: dealId: '2' customFieldId: '2' fieldValue: '||option 1||option 2||option 3||' multiselect/checkbox (multiple): value: dealCustomFieldDatum: dealId: '2' customFieldId: '3' fieldValue: - option 1 - option 3 - option 4 currency: value: dealCustomFieldDatum: dealId: '1' customFieldId: '4' fieldValue: 9999 fieldCurrency: cad number: value: dealCustomFieldDatum: dealId: '1' customFieldId: '5' fieldValue: '100.99' date: value: dealCustomFieldDatum: dealId: '1' customFieldId: '6' fieldValue: '2018-12-31' datetime: value: dealCustomFieldDatum: dealId: '1' customFieldId: '6' fieldValue: '2020-05-19T02:45:00-05:00' multiselect/checkbox (single): value: dealCustomFieldDatum: dealId: '2' customFieldId: '3' fieldValue: - option 1 responses: '200': description: '200' content: application/json: examples: Result: value: "{\n \"dealCustomFieldDatum\": {\n \"id\": \"5\",\n \"dealCustomFieldMetumId\": 1,\n \"dealId\": 2,\n \"customFieldId\": 1,\n \"createdTimestamp\": \"2018-11-06 02:27:05\",\n \"updatedTimestamp\": \"2018-11-06 02:27:05\",\n \"fieldValue\": \"test title\",\n \"links\": {\n \"deal\": \"https://:account.api-us1.com/api/:version/dealCustomFieldData/5/deal\",\n \"dealCustomFieldMetum\": \"https://:account.api-us1.com/api/:version/dealCustomFieldData/5/dealCustomFieldMetum\"\n }\n }\n}" schema: type: object properties: dealCustomFieldDatum: type: object properties: id: type: string example: '5' dealCustomFieldMetumId: type: integer example: 1 default: 0 dealId: type: integer example: 2 default: 0 customFieldId: type: integer example: 1 default: 0 createdTimestamp: type: string example: '2018-11-06 02:27:05' updatedTimestamp: type: string example: '2018-11-06 02:27:05' fieldValue: type: string example: test title links: type: object properties: deal: type: string example: https://:account.api-us1.com/api/:version/dealCustomFieldData/5/deal dealCustomFieldMetum: type: string example: https://:account.api-us1.com/api/:version/dealCustomFieldData/5/dealCustomFieldMetum '422': description: '422' content: application/json: examples: Result: value: "{\n \"errors\": [\n {\n \"detail\": \"The custom field value `abc` could not be saved to the custom field of type `date`.\"\n }\n ]\n}" schema: oneOf: - type: object properties: errors: type: array items: type: object properties: status: type: string example: '422' title: type: string example: The given data was invalid. detail: type: string example: The deal id field is required. - type: object properties: errors: type: array items: type: object properties: detail: type: string example: A related deal was not found. - type: object properties: errors: type: array items: type: object properties: detail: type: string example: A custom field value must be provided. - type: object properties: errors: type: array items: type: object properties: detail: type: string example: The custom field value `abc` could not be saved to the custom field of type `date`. deprecated: false tags: - Deals x-microcks-operation: delay: 0 dispatcher: FALLBACK get: summary: ActiveCampaign List All Custom Field Values description: '' operationId: list-all-custom-fielddata-field-values parameters: - name: filters[dealId] in: query description: Filter results by a specific deal (note that Id uses a capital I) schema: type: string responses: '200': description: '200' content: application/json: examples: Result: value: "{\n \"dealCustomFieldData\": [\n {\n \"id\": \"3\",\n \"dealCustomFieldMetumId\": 1,\n \"dealId\": 1,\n \"customFieldId\": 1,\n \"createdTimestamp\": \"2018-11-06 02:26:07\",\n \"updatedTimestamp\": \"2018-11-06 02:26:07\",\n \"fieldValue\": \"test title\",\n \"links\": {\n \"deal\": \"https://:account.api-us1.com/api/:version/dealCustomFieldData/3/deal\",\n \"dealCustomFieldMetum\": \"https://:account.api-us1.com/api/:version/dealCustomFieldData/3/dealCustomFieldMetum\"\n }\n },\n {\n \"id\": \"4\",\n \"dealCustomFieldMetumId\": 1,\n \"dealId\": 3,\n \"customFieldId\": 1,\n \"createdTimestamp\": \"2018-11-06 02:26:51\",\n \"updatedTimestamp\": \"2018-11-06 02:26:51\",\n \"fieldValue\": \"test title\",\n \"links\": {\n \"deal\": \"https://:account.api-us1.com/api/:version/dealCustomFieldData/4/deal\",\n \"dealCustomFieldMetum\": \"https://:account.api-us1.com/api/:version/dealCustomFieldData/4/dealCustomFieldMetum\"\n }\n },\n {\n \"id\": \"5\",\n \"dealCustomFieldMetumId\": 1,\n \"dealId\": 2,\n \"customFieldId\": 1,\n \"createdTimestamp\": \"2018-11-06 02:27:05\",\n \"updatedTimestamp\": \"2018-11-06 02:27:05\",\n \"fieldValue\": \"test title\",\n \"links\": {\n \"deal\": \"https://:account.api-us1.com/api/:version/dealCustomFieldData/5/deal\",\n \"dealCustomFieldMetum\": \"https://:account.api-us1.com/api/:version/dealCustomFieldData/5/dealCustomFieldMetum\"\n }\n },\n {\n \"id\": \"1\",\n \"dealCustomFieldMetumId\": 5,\n \"dealId\": 2,\n \"customFieldId\": 5,\n \"createdTimestamp\": \"2018-10-29 20:40:38\",\n \"updatedTimestamp\": \"2018-11-06 02:21:36\",\n \"fieldValue\": \"New title\",\n \"links\": {\n \"deal\": \"https://:account.api-us1.com/api/:version/dealCustomFieldData/1/deal\",\n \"dealCustomFieldMetum\": \"https://:account.api-us1.com/api/:version/dealCustomFieldData/1/dealCustomFieldMetum\"\n }\n }\n ]\n}" schema: type: object properties: dealCustomFieldData: type: array items: type: object properties: id: type: string example: '3' dealCustomFieldMetumId: type: integer example: 1 default: 0 dealId: type: integer example: 1 default: 0 customFieldId: type: integer example: 1 default: 0 createdTimestamp: type: string example: '2018-11-06 02:26:07' updatedTimestamp: type: string example: '2018-11-06 02:26:07' fieldValue: type: string example: test title links: type: object properties: deal: type: string example: https://:account.api-us1.com/api/:version/dealCustomFieldData/3/deal dealCustomFieldMetum: type: string example: https://:account.api-us1.com/api/:version/dealCustomFieldData/3/dealCustomFieldMetum deprecated: false tags: - Deals x-microcks-operation: delay: 0 dispatcher: FALLBACK /dealCustomFieldData/bulkCreate: post: summary: ActiveCampaign Bulk Create a Custom Deal Field Value description: '' operationId: bulk-create-a-custom-deal-field-value requestBody: content: application/json: schema: type: object properties: array: properties: dealId: type: integer description: The ID of the deal this field value relates to format: int32 customFieldId: type: integer description: The ID of the custom field metum this field value relates to format: int32 fieldValue: type: string description: 'Values for the field. (For currency field only, this needs to be in cents: eg, 10050 = 100.5)' fieldCurrency: type: string description: Currency code for the money value required: - dealId - customFieldId - fieldValue type: object examples: Request Example: value: - dealId: '1' customFieldId: '1' fieldValue: test title - dealId: '1' customFieldId: '2' fieldValue: test title - dealId: '1' customFieldId: '3' fieldValue: - option 1 - option 3 - option 4 - dealId: '1' customFieldId: '4' fieldValue: 9999 fieldCurrency: cad - dealId: '1' customFieldId: '5' fieldValue: '100.99' - dealId: '1' customFieldId: '6' fieldValue: '2018-12-31' - dealId: '1' customFieldId: '7' fieldValue: '2020-05-19T02:45:00-05:00' responses: '200': description: '200' content: application/json: examples: Result: value: "{\n \"message\": \"the bulk insert was successful\"\n}" schema: type: object properties: message: type: string example: the bulk insert was successful deprecated: false tags: - Deals x-microcks-operation: delay: 0 dispatcher: FALLBACK /dealCustomFieldData/{id}: get: summary: ActiveCampaign Retrieve a Custom Field Value description: '' operationId: retrieve-a-custom-deal-field-value parameters: - name: id in: path description: ID of the dealCustomFieldData to retrieve schema: type: integer format: int32 required: true responses: '200': description: '200' content: application/json: examples: Result: value: "{\n \"dealCustomFieldDatum\": {\n \"id\": \"1\",\n \"dealCustomFieldMetumId\": 5,\n \"dealId\": 2,\n \"customFieldId\": 5,\n \"createdTimestamp\": \"2018-10-29 20:40:38\",\n \"updatedTimestamp\": \"2018-11-06 02:21:36\",\n \"fieldValue\": \"New title\",\n \"links\": {\n \"deal\": \"https://:account.api-us1.com/api/:version/dealCustomFieldData/1/deal\",\n \"dealCustomFieldMetum\": \"https://:account.api-us1.com/api/:version/dealCustomFieldData/1/dealCustomFieldMetum\"\n }\n }\n}" schema: type: object properties: dealCustomFieldDatum: type: object properties: id: type: string example: '1' dealCustomFieldMetumId: type: integer example: 5 default: 0 dealId: type: integer example: 2 default: 0 customFieldId: type: integer example: 5 default: 0 createdTimestamp: type: string example: '2018-10-29 20:40:38' updatedTimestamp: type: string example: '2018-11-06 02:21:36' fieldValue: type: string example: New title links: type: object properties: deal: type: string example: https://:account.api-us1.com/api/:version/dealCustomFieldData/1/deal dealCustomFieldMetum: type: string example: https://:account.api-us1.com/api/:version/dealCustomFieldData/1/dealCustomFieldMetum '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 tags: - Deals x-microcks-operation: delay: 0 dispatcher: FALLBACK put: summary: ActiveCampaign Update a Custom Field Value description: '' operationId: update-a-custom-deal-field-value parameters: - name: id in: path description: ID of the custom fields value to update schema: type: integer format: int32 required: true requestBody: content: application/json: schema: type: object properties: dealCustomFieldDatum: properties: fieldValue: type: string description: Values for text fieldCurrency: type: string description: Currency code for the `currency` value default: Default Currency for Field required: [] type: object examples: text/textarea/hidden: value: dealCustomFieldDatum: fieldValue: New title dropdown/radio: value: dealCustomFieldDatum: fieldValue: option 1 multiselect/checkbox (multiple): value: dealCustomFieldDatum: fieldValue: - option 1 - option 3 - option 4 currency: value: dealCustomFieldDatum: fieldValue: 9999 fieldCurrency: cad number: value: dealCustomFieldDatum: fieldValue: '100.99' date: value: dealCustomFieldDatum: fieldValue: '2018-12-31 00:00:00' multiselect/checkbox (single): value: dealCustomFieldDatum: fieldValue: - option 1 responses: '200': description: '200' content: application/json: examples: Result: value: "{\n \"dealCustomFieldDatum\": {\n \"id\": \"1\",\n \"dealCustomFieldMetumId\": 5,\n \"dealId\": 2,\n \"customFieldId\": 5,\n \"createdTimestamp\": \"2018-10-29 20:40:38\",\n \"updatedTimestamp\": \"2018-11-06 02:21:36\",\n \"fieldValue\": \"New title\",\n \"links\": {\n \"deal\": \"https://:account.api-us1.com/api/:version/dealCustomFieldData/1/deal\",\n \"dealCustomFieldMetum\": \"https://:account.api-us1.com/api/:version/dealCustomFieldData/1/dealCustomFieldMetum\"\n }\n }\n}" schema: type: object properties: dealCustomFieldDatum: type: object properties: id: type: string example: '1' dealCustomFieldMetumId: type: integer example: 5 default: 0 dealId: type: integer example: 2 default: 0 customFieldId: type: integer example: 5 default: 0 createdTimestamp: type: string example: '2018-10-29 20:40:38' updatedTimestamp: type: string example: '2018-11-06 02:21:36' fieldValue: type: string example: New title links: type: object properties: deal: type: string example: https://:account.api-us1.com/api/:version/dealCustomFieldData/1/deal dealCustomFieldMetum: type: string example: https://:account.api-us1.com/api/:version/dealCustomFieldData/1/dealCustomFieldMetum '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 '422': description: '422' content: application/json: examples: Result: value: "{\n \"errors\": [\n {\n \"detail\": \"The custom field value could not be saved to the custom field of type `number`.\"\n }\n ]\n}" schema: type: object properties: errors: type: array items: type: object properties: detail: type: string example: The custom field value could not be saved to the custom field of type `number`. deprecated: false tags: - Deals x-microcks-operation: delay: 0 dispatcher: FALLBACK delete: summary: ActiveCampaign Delete a Custom Field Value description: '' operationId: delete-a-custom-deal-field-data parameters: - name: id in: path description: ID of the dealCustomFieldData to retrieve schema: type: integer format: int32 required: true responses: '200': description: '200' content: application/json: examples: Result: value: "{\n \"message\": \"DealCustomFieldData deleted.\"\n}" schema: type: object properties: message: type: string example: DealCustomFieldData deleted. '404': description: '404' content: text/plain: 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 tags: - Deals x-microcks-operation: delay: 0 dispatcher: FALLBACK /dealCustomFieldData/bulkUpdate: patch: summary: ActiveCampaign Bulk Update a Custom Field Value description: '' operationId: bulk-update-a-custom-field-value requestBody: content: application/json: schema: type: object properties: array: properties: id: type: integer description: ID of the dealCustomFieldData to update format: int32 fieldValue: type: string description: 'Values for the field. (For currency field only, this needs to be in cents: eg, 10050 = 100.5)' fieldCurrency: type: string description: Currency code for the money value required: - id - fieldValue type: object examples: Request Example: value: - id: '1' fieldValue: test title - id: '2' fieldValue: - option 1 - option 3 - option 4 - id: '3' fieldValue: 9999 fieldCurrency: cad - id: '4' fieldValue: '100.99' - id: '5' fieldValue: '2018-12-31' - id: '6' fieldValue: '2020-05-19T02:45:00-05:00' responses: '200': description: '200' content: application/json: examples: Result: value: "{\n \"message\": \"DealCustomFieldDatas with ID(s): 1, 2, 3, 4, 5 successfully bulk updated.\"\n}" schema: type: object properties: message: type: string example: 'DealCustomFieldDatas with ID(s): 1, 2, 3, 4, 5 successfully bulk updated.' deprecated: false tags: - Deals x-microcks-operation: delay: 0 dispatcher: FALLBACK /dealRoles: get: summary: ActiveCampaign List All Deal Roles description: '' operationId: list-all-deal-roles parameters: - name: search in: query description: (optional string used to search for matching titles) schema: type: string responses: '200': description: '200' content: application/json: examples: Result: value: "{\n \"dealRoles\":[\n {\n \"title\":\"Contributor\",\n \"created_timestamp\":\"2019-09-10T13:01:49-05:00\",\n \"updated_timestamp\":\"2019-09-10T13:01:49-05:00\",\n \"links\":{\n \"contactDeals\":\"https://example.activehosted.com/api/3/dealRoles/2/contactDeals\"\n },\n \"id\":\"2\"\n },\n {\n \"title\":\"Decision Maker\",\n \"created_timestamp\":\"2019-09-10T13:01:49-05:00\",\n \"updated_timestamp\":\"2019-09-10T13:01:49-05:00\",\n \"links\":{\n \"contactDeals\":\"https://example.activehosted.com/api/3/dealRoles/1/contactDeals\"\n },\n \"id\":\"1\"\n }\n ],\n \"meta\":{\n \"total\":\"2\"\n }\n}" schema: type: object properties: dealRoles: type: array items: type: object properties: title: type: string example: Contributor created_timestamp: type: string example: '2019-09-10T13:01:49-05:00' updated_timestamp: type: string example: '2019-09-10T13:01:49-05:00' links: type: object properties: contactDeals: type: string example: https://example.activehosted.com/api/3/dealRoles/2/contactDeals id: type: string example: '2' 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: - Deals x-microcks-operation: delay: 0 dispatcher: FALLBACK post: summary: ActiveCampaign Create a Deal Role description: '' operationId: create-a-deal-role requestBody: content: application/json: schema: type: object properties: title: type: string description: Title for the new deal role responses: '200': description: '200' content: application/json: examples: Result: value: "{\n \"dealRole\":{\n \"title\":\"Finance\",\n \"created_timestamp\":\"2021-04-14T21:34:55-05:00\",\n \"updated_timestamp\":\"2021-04-14T21:34:55-05:00\",\n \"links\":{\"contactDeals\":\"https://example.activehosted.com/api/3/dealRoles/3/contactDeals\"},\n \"id\":\"3\"\n }\n}\n" schema: type: object properties: dealRole: type: object properties: title: type: string example: Finance created_timestamp: type: string example: '2021-04-14T21:34:55-05:00' updated_timestamp: type: string example: '2021-04-14T21:34:55-05:00' links: type: object properties: contactDeals: type: string example: https://example.activehosted.com/api/3/dealRoles/3/contactDeals id: type: string example: '3' '400': description: '400' content: application/json: examples: Result: value: '{}' schema: type: object properties: {} deprecated: false tags: - Deals x-microcks-operation: delay: 0 dispatcher: FALLBACK /dealRoles/{id}: delete: summary: ActiveCampaign Delete a Deal Role description: '' operationId: delete-a-deal-role parameters: - name: id in: path description: Deal role's id schema: type: string required: true responses: '200': description: '200' content: application/json: examples: Result: value: '{}' schema: type: object properties: {} '400': description: '400' content: application/json: examples: Result: value: '{}' schema: type: object properties: {} deprecated: false tags: - Deals x-microcks-operation: delay: 0 dispatcher: FALLBACK /dealTasks: post: summary: ActiveCampaign Create a Task description: Create a new task operationId: create-task requestBody: content: application/json: schema: type: object properties: dealTask: properties: title: type: string description: The title to be assigned to the task ownerType: type: string description: The name of the relating object. Valid values are `contact` or `deal`. (see relationships table) default: deal relid: type: integer description: The id of the relational object for this task format: int32 status: type: integer description: Task status means complete or incomplete. 1 is complete and 0 is incomplete. format: int32 note: type: string description: The content describing the task duedate: type: string description: Due date of the task format: date dealTasktype: type: integer description: The type of the task based on the available Task Types in the account format: int32 assignee: type: integer description: The id of an user the task will be assigned to format: int32 triggerAutomationOnCreate: type: integer description: Id of an automation that will be triggered when the task is created. format: int32 doneAutomation: type: integer description: Id of an automation that will be triggered when the task is completed. format: int32 required: - relid - duedate - dealTasktype type: object examples: Request Example: value: dealTask: title: null ownerType: contact relid: '7' status: 0 note: Testing Task duedate: '2017-02-25T12:00:00-06:00' edate: '2017-02-25T12:15:00-06:00' dealTasktype: '1' assignee: 2 triggerAutomationOnCreate: 100 doneAutomation: 101 responses: '201': description: '201' content: application/json: examples: Result: value: "{\n \"dealTask\": {\n \"id\":\"1\",\n \"duedate\":\"2017-02-25T12:00:00-06:00\",\n \"edate\":\"2017-02-25T12:15:00-06:00\",\n \"status\":0,\n \"title\":null,\n \"note\":\"Testing Task\",\n \"relid\":\"7\",\n \"reltype\":\"Subscriber\",\n \"dealTasktype\":\"1\",\n \"cdate\":\"2017-02-24T13:21:56-06:00\",\n \"udate\":\"2017-02-24T13:21:56-06:00\",\n \"automation\":null,\n \"doneAutomation\":null,\n \"user\":\"1\",\n \"assignee\":\"2\",\n \"owner\":{\n \"type\":\"contact\",\n \"id\":\"7\"\n },\n \"outcomeId\": null,\n\t\t\"outcomeInfo\": null,\n \"links\": {\n \"activities\":\"/1/activities\",\n \"automation\":\"/1/automation\",\n \"dealTasktype\":\"/1/dealTasktype\",\n \"doneAutomation\":\"/1/doneAutomation\",\n \"notes\":\"/1/notes\",\n \"owner\":\"/1/owner\",\n \"taskNotifications\":\"/1/taskNotifications\",\n \"user\":\"/1/user\",\n \"assignee\": \"/1/assignee\",\n }\n }\n}" '400': description: '400' content: application/json: examples: Result: value: '{}' schema: type: object properties: {} deprecated: false tags: - Deals x-microcks-operation: delay: 0 dispatcher: FALLBACK get: summary: ActiveCampaign List All Tasks description: Retrieve a list of existing tasks operationId: list-all-tasks parameters: - name: filters[title] in: query description: The title to be assigned to the task schema: type: string - name: filters[reltype] in: query description: The name of the relating object (see relationships table) schema: type: string - name: filters[relid] in: query description: The id of the relational object for this task schema: type: integer format: int32 - name: filters[status] in: query description: Task status means complete or incomplete. 1 is complete and 0 is incomplete. schema: type: integer format: int32 - name: filters[note] in: query description: The content describing the task schema: type: string - name: filters[duedate] in: query description: Due date of the task schema: type: string format: date - name: filters[d_tasktypeid] in: query description: The type of the task based on the available Task Types in the account schema: type: integer format: int32 - name: filters[userid] in: query description: User ID this task belongs to schema: type: integer format: int32 - name: filters[due_after] in: query description: Filter deal tasks that are due after a specific date schema: type: string - name: Fitlers[due_before] in: query description: Filter deal tasks that are due before a specific date schema: type: string - name: filters[duedate_range] in: query description: Filter deal tasks that are due between specific date range (YYYY-MM-DD+YYYY-MM-DD format) or get categorized tasks (upcoming, scheduled, overdue values) schema: type: string - name: filters[assignee_userid] in: query description: The id of the user a task is assigned to schema: type: integer format: int32 - name: filters[outcome_id] in: query description: The id of a task outcome that the task belongs to. schema: type: integer format: int32 responses: '201': description: '201' content: application/json: examples: Result: value: "{\n \"dealTasks\": [{\n \"id\":\"1\",\n \"duedate\":\"2017-02-25T12:00:00-06:00\",\n \"edate\":\"2017-02-25T12:15:00-06:00\",\n \"status\":0,\n \"title\":null,\n \"note\":\"Testing Task\",\n \"relid\":\"7\",\n \"reltype\":\"Subscriber\",\n \"dealTasktype\":\"1\",\n \"cdate\":\"2017-02-24T13:21:56-06:00\",\n \"udate\":\"2017-02-24T13:21:56-06:00\",\n \"automation\":null,\n \"doneAutomation\":null,\n \"user\":\"1\",\n \"assignee\":\"2\",\n \"owner\":{\n \"type\":\"contact\",\n \"id\":\"7\"\n },\n \"outcomeId\": null,\n\t\t\"outcomeInfo\": null,\n \"links\": {\n \"activities\":\"/1/activities\",\n \"automation\":\"/1/automation\",\n \"dealTasktype\":\"/1/dealTasktype\",\n \"doneAutomation\":\"/1/doneAutomation\",\n \"notes\":\"/1/notes\",\n \"owner\":\"/1/owner\",\n \"taskNotifications\":\"/1/taskNotifications\",\n \"user\":\"/3/dealTasks/1/user\",\n \"assignee\":\"/1/assignee\"\n }\n },\n {\n \"id\":\"2\",\n \"duedate\":\"2017-02-25T12:00:00-06:00\",\n \"edate\":\"2017-02-25T12:15:00-06:00\",\n \"status\":0,\n \"title\":null,\n \"note\":\"Testing Task 2\",\n \"relid\":\"8\",\n \"reltype\":\"Deal\",\n \"dealTasktype\":\"1\",\n \"cdate\":\"2017-02-24T13:21:56-06:00\",\n \"udate\":\"2017-02-24T13:21:56-06:00\",\n \"automation\":null,\n \"doneAutomation\":null,\n \"user\":\"1\",\n \"assignee\":\"2\",\n \"owner\":{\n \"type\":\"deal\",\n \"id\":\"5\"\n },\n \"outcomeId\": 91,\n\t\t\"outcomeInfo\": \"More details about the outcome\",\n \"links\": {\n \"activities\":\"/2/activities\",\n \"automation\":\"/2/automation\",\n \"dealTasktype\":\"/2/dealTasktype\",\n \"doneAutomation\":\"/2/doneAutomation\",\n \"notes\":\"/2/notes\",\n \"owner\":\"/2/owner\",\n \"taskNotifications\":\"/2/taskNotifications\",\n \"user\":\"/2/user\",\n \"assignee\":\"/1/assignee\"\n }\n }],\n \"meta\":{\n \"total\":\"2\"\n }\n}" schema: type: object properties: dealTasks: type: array items: type: object properties: id: type: string example: '1' duedate: type: string example: '2017-02-25T12:00:00-06:00' edate: type: string example: '2017-02-25T12:15:00-06:00' status: type: integer example: 0 default: 0 title: {} note: type: string example: Testing Task relid: type: string example: '7' reltype: type: string example: Subscriber dealTasktype: type: string example: '1' cdate: type: string example: '2017-02-24T13:21:56-06:00' udate: type: string example: '2017-02-24T13:21:56-06:00' automation: {} doneAutomation: {} user: type: string example: '1' assignee: type: string example: '2' owner: type: object properties: type: type: string example: contact id: type: string example: '7' outcomeId: {} outcomeInfo: {} links: type: object properties: activities: type: string example: /1/activities automation: type: string example: /1/automation dealTasktype: type: string example: /1/dealTasktype doneAutomation: type: string example: /1/doneAutomation notes: type: string example: /1/notes owner: type: string example: /1/owner taskNotifications: type: string example: /1/taskNotifications user: type: string example: /3/dealTasks/1/user assignee: type: string example: /1/assignee 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: - Deals x-microcks-operation: delay: 0 dispatcher: FALLBACK /dealTasks/{id}: get: summary: ActiveCampaign Retrieve a Task description: Retrieve an existing task operationId: get-task parameters: - name: id in: path description: The ID of the task schema: type: integer format: int32 required: true responses: '201': description: '201' content: application/json: examples: Result: value: "{\n \"dealTask\": {\n \"relid\":\"5\",\n \"reltype\":\"Deal\",\n \"dealTasktype\":\"1\",\n \"user\":\"1\",\n \"assignee\": \"2\",\n \"automation\":null,\n \"cdate\":\"2017-02-24T15:01:37-06:00\",\n \"duedate\":\"2017-02-28T12:00:00-06:00\",\n \"edate\":\"2017-02-28T12:15:00-06:00\",\n \"duration\":\"0\",\n \"status\":\"0\",\n \"title\":\"\",\n \"note\":\"Deal task title!\",\n \"donedate\":null,\n \"doneAutomation\":null,\n \"udate\":\"2017-02-24T15:01:37-06:00\",\n \"owner\":{\n \"type\":\"deal\",\n \"id\":\"5\"\n },\n \"id\":\"1\",\n \"outcomeId\": 91,\n\t\t\"outcomeInfo\": \"More details about the outcome\",\n \"links\": {\n \"activities\":\"/1/activities\",\n \"automation\":\"/1/automation\",\n \"dealTasktype\":\"/1/dealTasktype\",\n \"doneAutomation\":\"/1/doneAutomation\",\n \"notes\":\"/1/notes\",\n \"owner\":\"/1/owner\",\n \"taskNotifications\":\"/1/taskNotifications\",\n \"user\":\"/1/user\",\n \"assignee\": \"/1/assignee\"\n }\n }\n}" schema: type: object properties: dealTask: type: object properties: relid: type: string example: '5' reltype: type: string example: Deal dealTasktype: type: string example: '1' user: type: string example: '1' assignee: type: string example: '2' automation: {} cdate: type: string example: '2017-02-24T15:01:37-06:00' duedate: type: string example: '2017-02-28T12:00:00-06:00' edate: type: string example: '2017-02-28T12:15:00-06:00' duration: type: string example: '0' status: type: string example: '0' title: type: string example: '' note: type: string example: Deal task title! donedate: {} doneAutomation: {} udate: type: string example: '2017-02-24T15:01:37-06:00' owner: type: object properties: type: type: string example: deal id: type: string example: '5' id: type: string example: '1' outcomeId: type: integer example: 91 default: 0 outcomeInfo: type: string example: More details about the outcome links: type: object properties: activities: type: string example: /1/activities automation: type: string example: /1/automation dealTasktype: type: string example: /1/dealTasktype doneAutomation: type: string example: /1/doneAutomation notes: type: string example: /1/notes owner: type: string example: /1/owner taskNotifications: type: string example: /1/taskNotifications user: type: string example: /1/user assignee: type: string example: /1/assignee '400': description: '400' content: application/json: examples: Result: value: '{}' schema: type: object properties: {} deprecated: false tags: - Deals x-microcks-operation: delay: 0 dispatcher: FALLBACK put: summary: ActiveCampaign Update a Task description: Update an existing task operationId: update-task parameters: - name: id in: path description: The ID of the task schema: type: integer format: int32 required: true requestBody: content: application/json: schema: type: object properties: dealTask: properties: title: type: string description: The title to be assigned to the task ownerType: type: string description: The name of the relating object. Valid values are `contact` or `deal`. (see relationships table) default: deal relid: type: integer description: The id of the relational object for this task format: int32 status: type: integer description: Task status means complete or incomplete. 1 is complete and 0 is incomplete. format: int32 note: type: string description: The content describing the task duedate: type: string description: Due date of the task format: date dealTasktype: type: integer description: The type of the task based on the available Task Types in the account format: int32 assignee: type: integer description: The id of an user the task will be assigned to format: int32 outcomeId: type: integer description: Task outcome's id is required at the time of task being completed. format: int32 outcomeInfo: type: string description: More information about task completion with the outcome selection. required: [] type: object responses: '201': description: '201' content: application/json: examples: Result: value: "{\n \"dealTask\": {\n \"id\":\"1\",\n \"duedate\":\"2017-02-25T12:00:00-06:00\",\n \"edate\":\"2017-02-25T12:15:00-06:00\",\n \"status\":0,\n \"title\":null,\n \"note\":\"Testing Task\",\n \"relid\":\"7\",\n \"ownerType\":\"contact\",\n \"dealTasktype\":\"1\",\n \"assignee\":\"2\"\n \"cdate\":\"2017-02-24T13:21:56-06:00\",\n \"udate\":\"2017-02-24T13:21:56-06:00\",\n \"automation\":null,\n \"doneAutomation\":null,\n \"user\":\"1\",\n \"owner\":{\n \"type\":\"contact\",\n \"id\":\"7\"\n },\n\t\t\"outcomeId\": 91,\n\t\t\"outcomeInfo\": \"More details about the outcome\",\n \"links\": {\n \"activities\":\"/1/activities\",\n \"automation\":\"/1/automation\",\n \"dealTasktype\":\"/1/dealTasktype\",\n \"doneAutomation\":\"/1/doneAutomation\",\n \"notes\":\"/1/notes\",\n \"owner\":\"/1/owner\",\n \"taskNotifications\":\"/1/taskNotifications\",\n \"user\":\"/1/user\",\n \"assignee\":\"/1/assignee\"\n }\n }\n}" '400': description: '400' content: application/json: examples: Result: value: '{}' schema: type: object properties: {} deprecated: false tags: - Deals x-microcks-operation: delay: 0 dispatcher: FALLBACK delete: summary: ActiveCampaign Delete a Task description: Delete an existing task operationId: delete-task parameters: - name: id in: path description: The task id schema: type: integer format: int32 required: true responses: '200': description: '200' content: application/json: examples: Result: value: '{}' schema: type: object properties: {} '400': description: '400' content: application/json: examples: Result: value: '{}' schema: type: object properties: {} deprecated: false tags: - Deals x-microcks-operation: delay: 0 dispatcher: FALLBACK /dealTasktypes: post: summary: ActiveCampaign Create a Task Type description: Create a new task type operationId: create-a-deal-task-type requestBody: content: application/json: schema: type: object properties: dealTasktype: properties: title: type: string description: Deal task type's title. The title should be unique among deal task types. status: type: string description: 0 - Active status, 1 - Disabled status enum: - '0' - '1' required: - title type: object examples: Request Example: value: dealTasktype: title: Skype status: 0 responses: '200': description: '200' content: application/json: examples: Result: value: "{\n \"dealTasktype\": {\n \"cdate\": \"2017-03-02T14:28:53-06:00\",\n \"defduration\": \"0\",\n \"id\": \"7\",\n \"links\": [],\n \"status\": \"0\",\n \"title\": \"Skype\",\n \"udate\": \"2017-03-02T14:28:53-06:00\"\n }\n}" schema: type: object properties: dealTasktype: type: object properties: cdate: type: string example: '2017-03-02T14:28:53-06:00' defduration: type: string example: '0' id: type: string example: '7' links: type: array status: type: string example: '0' title: type: string example: Skype udate: type: string example: '2017-03-02T14:28:53-06:00' '400': description: '400' content: application/json: examples: Result: value: '{}' schema: type: object properties: {} deprecated: false tags: - Deals x-microcks-operation: delay: 0 dispatcher: FALLBACK get: summary: ActiveCampaign List All Task Types description: Retrieve all existing task types operationId: list-all-deal-task-types responses: '200': description: '200' content: application/json: examples: Result: value: "{\n \"dealTasktypes\": [\n {\n \"cdate\": null,\n \"defduration\": \"0\",\n \"id\": \"1\",\n \"links\": [],\n \"status\": \"0\",\n \"title\": \"Call\",\n \"udate\": null\n },\n {\n \"cdate\": null,\n \"defduration\": \"0\",\n \"id\": \"2\",\n \"links\": [],\n \"status\": \"0\",\n \"title\": \"Email\",\n \"udate\": null\n },\n {\n \"cdate\": null,\n \"defduration\": \"0\",\n \"id\": \"3\",\n \"links\": [],\n \"status\": \"0\",\n \"title\": \"Lunch\",\n \"udate\": null\n },\n {\n \"cdate\": null,\n \"defduration\": \"0\",\n \"id\": \"4\",\n \"links\": [],\n \"status\": \"0\",\n \"title\": \"Meeting\",\n \"udate\": null\n }\n ],\n \"meta\": {\n \"total\": \"4\"\n }\n}" schema: type: object properties: dealTasktypes: type: array items: type: object properties: cdate: {} defduration: type: string example: '0' id: type: string example: '1' links: type: array status: type: string example: '0' title: type: string example: Call udate: {} meta: type: object properties: total: type: string example: '4' '400': description: '400' content: application/json: examples: Result: value: '{}' schema: type: object properties: {} deprecated: false tags: - Deals x-microcks-operation: delay: 0 dispatcher: FALLBACK /dealTasktypes/{id}: get: summary: ActiveCampaign Retrieve a Task Type description: Retrieve an existing task type operationId: retrieve-a-deal-task-type parameters: - name: id in: path description: Deal task type's id schema: type: integer format: int32 required: true responses: '200': description: '200' content: application/json: examples: Result: value: "{\n \"dealTasktype\": {\n \"cdate\": \"2017-03-02T14:22:51-06:00\",\n \"defduration\": \"0\",\n \"id\": \"5\",\n \"links\": [],\n \"status\": \"0\",\n \"title\": \"Skype\",\n \"udate\": \"2017-03-02T14:22:51-06:00\"\n }\n}" schema: type: object properties: dealTasktype: type: object properties: cdate: type: string example: '2017-03-02T14:22:51-06:00' defduration: type: string example: '0' id: type: string example: '5' links: type: array status: type: string example: '0' title: type: string example: Skype udate: type: string example: '2017-03-02T14:22:51-06:00' '400': description: '400' content: application/json: examples: Result: value: '{}' schema: type: object properties: {} deprecated: false tags: - Deals x-microcks-operation: delay: 0 dispatcher: FALLBACK put: summary: ActiveCampaign Update a Task Type description: Update an existing task type operationId: update-a-deal-task-type parameters: - name: id in: path description: Deal task type's id schema: type: integer format: int32 required: true requestBody: content: application/json: schema: type: object properties: dealTasktype: properties: title: type: string description: Deal task type's title. The title should be unique among deal task types. status: type: string description: 0 - Active status, 1 - Disabled status default: '0' enum: - '0' - '1' required: [] type: object examples: Request Example: value: dealTasktype: title: Meet in person status: 1 responses: '200': description: '200' content: application/json: examples: Result: value: "{\n \"dealTasktype\": {\n \"cdate\": \"2017-03-02T14:28:53-06:00\",\n \"defduration\": \"0\",\n \"id\": \"7\",\n \"links\": [],\n \"status\": \"1\",\n \"title\": \"Meet in person\",\n \"udate\": \"2017-03-02T14:32:20-06:00\"\n }\n}" schema: type: object properties: dealTasktype: type: object properties: cdate: type: string example: '2017-03-02T14:28:53-06:00' defduration: type: string example: '0' id: type: string example: '7' links: type: array status: type: string example: '1' title: type: string example: Meet in person udate: type: string example: '2017-03-02T14:32:20-06:00' '400': description: '400' content: application/json: examples: Result: value: '{}' schema: type: object properties: {} deprecated: false tags: - Deals x-microcks-operation: delay: 0 dispatcher: FALLBACK delete: summary: ActiveCampaign Delete a Task Type description: Delete an existing task type operationId: delete-a-deal-task-type parameters: - name: id in: path description: Deal task type's id schema: type: integer format: int32 required: true responses: '403': description: '403' content: application/json: examples: Result: value: '{}' schema: type: object properties: {} deprecated: false tags: - Deals x-microcks-operation: delay: 0 dispatcher: FALLBACK /dealTasktypes/{id}/dealTasks: put: summary: ActiveCampaign Move Tasks to Another Task Type description: Move tasks to a different task type operationId: move-deal-tasks-to-another-deal-task-type parameters: - name: id in: path description: Deal task type's id schema: type: integer format: int32 required: true requestBody: content: application/json: schema: type: object properties: dealTask: properties: dealTasktype: type: string description: Deal task type's id to move deal tasks to required: [] type: object examples: Request Example: value: dealTask: dealTasktype: '2' responses: '200': description: '200' content: application/json: examples: Result: value: "{\n \"dealTasks\": [\n {\n \"automation\": null,\n \"cdate\": \"2017-06-01T15:08:55-05:00\",\n \"dealTasktype\": \"2\",\n \"doneAutomation\": null,\n \"donedate\": null,\n \"duedate\": \"2017-06-02T12:00:00-05:00\",\n \"duration\": \"0\",\n \"edate\": \"2017-06-02T12:15:00-05:00\",\n \"id\": \"1\",\n \"links\": {\n \"activities\": \"/api/3/dealTasks/1/activities\",\n \"automation\": \"/api/3/dealTasks/1/automation\",\n \"dealTasktype\": \"/api/3/dealTasks/1/dealTasktype\",\n \"doneAutomation\": \"/api/3/dealTasks/1/doneAutomation\",\n \"notes\": \"/api/3/dealTasks/1/notes\",\n \"owner\": \"/api/3/dealTasks/1/owner\",\n \"taskNotifications\": \"/api/3/dealTasks/1/taskNotifications\",\n \"user\": \"/api/3/dealTasks/1/user\"\n },\n \"note\": \"Call Steve\",\n \"owner\": {\n \"id\": \"1\",\n \"type\": \"deal\"\n },\n \"relid\": \"1\",\n \"reltype\": \"Deal\",\n \"status\": \"0\",\n \"title\": \"\",\n \"udate\": \"2017-06-01T15:08:55-05:00\",\n \"user\": \"1\"\n }\n ],\n \"deals\": [\n {\n \"activitycount\": \"2\",\n \"cdate\": \"2017-06-01T15:08:41-05:00\",\n \"contact\": \"1\",\n \"currency\": \"usd\",\n \"edate\": \"0000-00-00 00:00:00\",\n \"group\": \"1\",\n \"hash\": \"3abd127b\",\n \"id\": \"1\",\n \"links\": {\n \"activities\": \"/api/3/deals/1/activities\",\n \"contact\": \"/api/3/deals/1/contact\",\n \"contactDeals\": \"/api/3/deals/1/contactDeals\",\n \"group\": \"/api/3/deals/1/group\",\n \"nextTask\": \"/api/3/deals/1/nextTask\",\n \"notes\": \"/api/3/deals/1/notes\",\n \"organization\": \"/api/3/deals/1/organization\",\n \"owner\": \"/api/3/deals/1/owner\",\n \"scoreValues\": \"/api/3/deals/1/scoreValues\",\n \"stage\": \"/api/3/deals/1/stage\",\n \"tasks\": \"/api/3/deals/1/tasks\"\n },\n \"mdate\": \"2017-06-01T15:08:55-05:00\",\n \"nextTask\": \"1\",\n \"nextdate\": \"2017-06-02T12:00:00-05:00\",\n \"nextdealid\": \"1\",\n \"nexttaskid\": \"1\",\n \"organization\": null,\n \"owner\": \"1\",\n \"percent\": \"0\",\n \"stage\": \"1\",\n \"status\": \"0\",\n \"title\": \"New deal\",\n \"value\": \"10000\"\n }\n ]\n}" schema: type: object properties: dealTasks: type: array items: type: object properties: automation: {} cdate: type: string example: '2017-06-01T15:08:55-05:00' dealTasktype: type: string example: '2' doneAutomation: {} donedate: {} duedate: type: string example: '2017-06-02T12:00:00-05:00' duration: type: string example: '0' edate: type: string example: '2017-06-02T12:15:00-05:00' id: type: string example: '1' links: type: object properties: activities: type: string example: /api/3/dealTasks/1/activities automation: type: string example: /api/3/dealTasks/1/automation dealTasktype: type: string example: /api/3/dealTasks/1/dealTasktype doneAutomation: type: string example: /api/3/dealTasks/1/doneAutomation notes: type: string example: /api/3/dealTasks/1/notes owner: type: string example: /api/3/dealTasks/1/owner taskNotifications: type: string example: /api/3/dealTasks/1/taskNotifications user: type: string example: /api/3/dealTasks/1/user note: type: string example: Call Steve owner: type: object properties: id: type: string example: '1' type: type: string example: deal relid: type: string example: '1' reltype: type: string example: Deal status: type: string example: '0' title: type: string example: '' udate: type: string example: '2017-06-01T15:08:55-05:00' user: type: string example: '1' deals: type: array items: type: object properties: activitycount: type: string example: '2' cdate: type: string example: '2017-06-01T15:08:41-05:00' contact: type: string example: '1' currency: type: string example: usd edate: type: string example: '0000-00-00 00:00:00' group: type: string example: '1' hash: type: string example: 3abd127b id: type: string example: '1' links: type: object properties: activities: type: string example: /api/3/deals/1/activities contact: type: string example: /api/3/deals/1/contact contactDeals: type: string example: /api/3/deals/1/contactDeals group: type: string example: /api/3/deals/1/group nextTask: type: string example: /api/3/deals/1/nextTask notes: type: string example: /api/3/deals/1/notes organization: type: string example: /api/3/deals/1/organization owner: type: string example: /api/3/deals/1/owner scoreValues: type: string example: /api/3/deals/1/scoreValues stage: type: string example: /api/3/deals/1/stage tasks: type: string example: /api/3/deals/1/tasks mdate: type: string example: '2017-06-01T15:08:55-05:00' nextTask: type: string example: '1' nextdate: type: string example: '2017-06-02T12:00:00-05:00' nextdealid: type: string example: '1' nexttaskid: type: string example: '1' organization: {} owner: type: string example: '1' percent: type: string example: '0' stage: type: string example: '1' status: type: string example: '0' title: type: string example: New deal value: type: string example: '10000' '400': description: '400' content: application/json: examples: Result: value: '{}' schema: type: object properties: {} deprecated: false tags: - Deals x-microcks-operation: delay: 0 dispatcher: FALLBACK components: securitySchemes: ApiToken: type: apiKey name: Api-Token in: header description: Your ActiveCampaign API token