openapi: 3.0.3 info: title: ActiveCampaign SMS Broadcast Accounts Tasks 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: Tasks paths: /taskOutcomes: post: summary: ActiveCampaign Create a Task Outcome description: Create a new task outcome operationId: create-a-task-outcome requestBody: content: application/json: schema: type: object required: - title - sentiment properties: title: type: string description: Title of the outcome sentiment: type: string description: Sentiment of the outcome. Only three values are currently allowed. enum: - Positive - Neutral - or Negative disabled: type: string description: 1 is for disabled and 0 is for active outcome. enum: - 0 or 1 examples: Request Example: value: taskOutcome: title: Interested sentiment: Positive responses: '200': description: '200' content: application/json: examples: Result: value: "{\n \"taskOutcome\": {\n \"title\": \"Interested\",\n \"sentiment\": \"POSITIVE\",\n \"created_by\": \"1\",\n \"disabled\": \"\",\n \"links\": {\n \"tasktypeOutcomeRels\": \"https://youraccountname.api-us1.com/api/3/taskOutcomes/1/tasktypeOutcomeRels\",\n \"dealTasks\": \"https://youraccountname.api-us1.com/api/3/taskOutcomes/1/dealTasks\"\n },\n \"id\": \"1\"\n }\n}" schema: type: object properties: taskOutcome: type: object properties: title: type: string example: Interested sentiment: type: string example: POSITIVE created_by: type: string example: '1' disabled: type: string example: '' links: type: object properties: tasktypeOutcomeRels: type: string example: https://youraccountname.api-us1.com/api/3/taskOutcomes/1/tasktypeOutcomeRels dealTasks: type: string example: https://youraccountname.api-us1.com/api/3/taskOutcomes/1/dealTasks id: type: string example: '1' '422': description: '422' content: application/json: examples: Result: value: "{\n \"errors\": [\n {\n \"title\": \"The taskOutcome title was not provided.\",\n \"detail\": \"\",\n \"code\": \"field_missing\",\n \"error\": \"taskOutcome_title_was_not_provided\",\n \"source\": {\n \"pointer\": \"/data/attributes/title\"\n }\n },\n {\n \"title\": \"Sentiment value must be one of Positive, Neutral, or Negative.\",\n \"detail\": \"\",\n \"code\": \"field_invalid\",\n \"error\": \"\",\n \"source\": {\n \"pointer\": \"/data/attributes/sentiment\"\n }\n }\n ]\n}" schema: type: object properties: errors: type: array items: type: object properties: title: type: string example: The taskOutcome title was not provided. detail: type: string example: '' code: type: string example: field_missing error: type: string example: taskOutcome_title_was_not_provided source: type: object properties: pointer: type: string example: /data/attributes/title text/plain: examples: Result: value: "{\n \"errors\": [\n {\n \"title\": \"A task outcome with the same title already exists.\",\n \"detail\": \"\",\n \"code\": \"field_invalid\",\n \"error\": \"\",\n \"source\": {\n \"pointer\": \"/data/attributes/title\"\n }\n },\n {\n \"title\": \"Sentiment value must be one of Positive, Neutral, or Negative.\",\n \"detail\": \"\",\n \"code\": \"field_invalid\",\n \"error\": \"\",\n \"source\": {\n \"pointer\": \"/data/attributes/sentiment\"\n }\n }\n ]\n}" schema: type: object properties: errors: type: array items: type: object properties: title: type: string example: A task outcome with the same title already exists. detail: type: string example: '' code: type: string example: field_invalid error: type: string example: '' source: type: object properties: pointer: type: string example: /data/attributes/title deprecated: false tags: - Tasks x-microcks-operation: delay: 0 dispatcher: FALLBACK get: summary: ActiveCampaign List All Task Outcomes description: Retrieve all existing task outcomes operationId: list-all-task-outcomes parameters: - name: filters[sentiment] in: query description: 1 is for Negative, 2 is for Neutral and 3 is for Positive schema: type: string enum: - '1' - 2 or 3 responses: '200': description: '200' content: application/json: examples: Result: value: "{\n \"taskOutcomes\": [\n {\n \"title\": \"Interested\",\n \"sentiment\": \"POSITIVE\",\n \"disabled\": \"0\",\n \"created_by\": \"1\",\n \"updated_by\": \"1\",\n \"created_utc_timestamp\": \"2021-02-16T12:26:15-06:00\",\n \"updated_utc_timestamp\": \"2021-02-16T12:27:56-06:00\",\n \"dealTasktype_ids\": [],\n \"links\": {\n \"tasktypeOutcomeRels\": \"https://youraccountname.api-us1.com/api/3/taskOutcomes/1/tasktypeOutcomeRels\",\n \"dealTasks\": \"https://youraccountname.api-us1.com/api/3/taskOutcomes/1/dealTasks\"\n },\n \"id\": \"1\"\n },\n {\n \"title\": \"Not Interested\",\n \"sentiment\": \"NEGATIVE\",\n \"disabled\": \"0\",\n \"created_by\": \"1\",\n \"updated_by\": \"1\",\n \"created_utc_timestamp\": \"2021-02-16T12:27:01-06:00\",\n \"updated_utc_timestamp\": \"2021-02-16T12:27:01-06:00\",\n \"dealTasktype_ids\": [],\n \"links\": {\n \"tasktypeOutcomeRels\": \"https://youraccountname.api-us1.com/api/3/taskOutcomes/2/tasktypeOutcomeRels\",\n \"dealTasks\": \"https://youraccountname.api-us1.com/api/3/taskOutcomes/2/dealTasks\"\n },\n \"id\": \"2\"\n },\n {\n \"title\": \"Left a voicemail\",\n \"sentiment\": \"NEUTRAL\",\n \"disabled\": \"0\",\n \"created_by\": \"1\",\n \"updated_by\": \"1\",\n \"created_utc_timestamp\": \"2021-02-16T12:27:13-06:00\",\n \"updated_utc_timestamp\": \"2021-02-16T12:27:13-06:00\",\n \"dealTasktype_ids\": [],\n \"links\": {\n \"tasktypeOutcomeRels\": \"https://youraccountname.api-us1.com/api/3/taskOutcomes/3/tasktypeOutcomeRels\",\n \"dealTasks\": \"https://youraccountname.api-us1.com/api/3/taskOutcomes/3/dealTasks\"\n },\n \"id\": \"3\"\n },\n {\n \"title\": \"Disabled outcome\",\n \"sentiment\": \"NEUTRAL\",\n \"disabled\": \"1\",\n \"created_by\": \"1\",\n \"updated_by\": \"1\",\n \"created_utc_timestamp\": \"2021-02-16T12:28:27-06:00\",\n \"updated_utc_timestamp\": \"2021-02-16T12:28:27-06:00\",\n \"dealTasktype_ids\": [],\n \"links\": {\n \"tasktypeOutcomeRels\": \"https://youraccountname.api-us1.com/api/3/taskOutcomes/4/tasktypeOutcomeRels\",\n \"dealTasks\": \"https://youraccountname.api-us1.com/api/3/taskOutcomes/4/dealTasks\"\n },\n \"id\": \"4\"\n }\n ],\n \"meta\": {\n \"total\": \"4\"\n }\n}" schema: type: object properties: taskOutcomes: type: array items: type: object properties: title: type: string example: Interested sentiment: type: string example: POSITIVE disabled: type: string example: '0' created_by: type: string example: '1' updated_by: type: string example: '1' created_utc_timestamp: type: string example: '2021-02-16T12:26:15-06:00' updated_utc_timestamp: type: string example: '2021-02-16T12:27:56-06:00' dealTasktype_ids: type: array links: type: object properties: tasktypeOutcomeRels: type: string example: https://youraccountname.api-us1.com/api/3/taskOutcomes/1/tasktypeOutcomeRels dealTasks: type: string example: https://youraccountname.api-us1.com/api/3/taskOutcomes/1/dealTasks id: type: string example: '1' 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: - Tasks x-microcks-operation: delay: 0 dispatcher: FALLBACK /taskOutcomes/{id}: get: summary: ActiveCampaign Retrieve a Task Outcome description: Retrieve an existing task outcome operationId: retrieve-a-task-outcome parameters: - name: id in: path description: Task outcome's id schema: type: integer format: int32 required: true responses: '200': description: '200' content: application/json: examples: Result: value: "{\n \"taskOutcome\": {\n \"title\": \"Interested\",\n \"sentiment\": \"POSITIVE\",\n \"disabled\": \"0\",\n \"created_by\": \"1\",\n \"updated_by\": \"1\",\n \"created_utc_timestamp\": \"2021-02-16T12:26:15-06:00\",\n \"updated_utc_timestamp\": \"2021-02-16T12:27:56-06:00\",\n \"dealTasktype_ids\": [],\n \"links\": {\n \"tasktypeOutcomeRels\": \"https://youraccountname.api-us1.com/api/3/taskOutcomes/1/tasktypeOutcomeRels\",\n \"dealTasks\": \"https://youraccountname.api-us1.com/api/3/taskOutcomes/1/dealTasks\"\n },\n \"id\": \"1\"\n }\n}" schema: type: object properties: taskOutcome: type: object properties: title: type: string example: Interested sentiment: type: string example: POSITIVE disabled: type: string example: '0' created_by: type: string example: '1' updated_by: type: string example: '1' created_utc_timestamp: type: string example: '2021-02-16T12:26:15-06:00' updated_utc_timestamp: type: string example: '2021-02-16T12:27:56-06:00' dealTasktype_ids: type: array links: type: object properties: tasktypeOutcomeRels: type: string example: https://youraccountname.api-us1.com/api/3/taskOutcomes/1/tasktypeOutcomeRels dealTasks: type: string example: https://youraccountname.api-us1.com/api/3/taskOutcomes/1/dealTasks id: type: string example: '1' '404': description: '404' content: application/json: examples: Result: value: "{\n \"message\": \"No Result found for TaskOutcome with id 111\"\n}" schema: type: object properties: message: type: string example: No Result found for TaskOutcome with id 111 deprecated: false tags: - Tasks x-microcks-operation: delay: 0 dispatcher: FALLBACK /taskOutccomes/{id}: put: summary: ActiveCampaign Update a Task Outcome description: Update an existing task outcome operationId: update-a-task-outcome parameters: - name: id in: path description: Task outcome's id schema: type: integer format: int32 required: true requestBody: content: application/json: schema: type: object required: - title - sentiment properties: title: type: string description: Task outcome's title. The title should be unique among task outcomes. sentiment: type: string description: Sentiment of the outcome. Only three values are currently allowed. enum: - Positive - Neutral - or Negative disabled: type: string description: 1 is for disabled and 0 is for active outcome. enum: - 0 or 1 examples: Request Example: value: taskOutcome: sentiment: Neutral responses: '200': description: '200' content: application/json: examples: Result: value: "{\n \"taskOutcome\": {\n \"title\": \"Interested\",\n \"sentiment\": \"NEUTRAL\",\n \"disabled\": \"0\",\n \"created_by\": \"1\",\n \"updated_by\": \"1\",\n \"created_utc_timestamp\": \"2021-02-16T12:26:15-06:00\",\n \"updated_utc_timestamp\": \"2021-02-16T12:27:56-06:00\",\n \"links\": {\n \"tasktypeOutcomeRels\": \"https://youraccountname.api-us1.com/api/3/taskOutcomes/1/tasktypeOutcomeRels\",\n \"dealTasks\": \"https://youraccountname.api-us1.com/api/3/taskOutcomes/1/dealTasks\"\n },\n \"id\": \"1\"\n }\n}" schema: type: object properties: taskOutcome: type: object properties: title: type: string example: Interested sentiment: type: string example: NEUTRAL disabled: type: string example: '0' created_by: type: string example: '1' updated_by: type: string example: '1' created_utc_timestamp: type: string example: '2021-02-16T12:26:15-06:00' updated_utc_timestamp: type: string example: '2021-02-16T12:27:56-06:00' links: type: object properties: tasktypeOutcomeRels: type: string example: https://youraccountname.api-us1.com/api/3/taskOutcomes/1/tasktypeOutcomeRels dealTasks: type: string example: https://youraccountname.api-us1.com/api/3/taskOutcomes/1/dealTasks id: type: string example: '1' '422': description: '422' content: text/plain: examples: Result: value: "{\n \"errors\": [\n {\n \"title\": \"A task outcome with the same title already exists.\",\n \"detail\": \"\",\n \"code\": \"field_invalid\",\n \"error\": \"\",\n \"source\": {\n \"pointer\": \"/data/attributes/title\"\n }\n },\n {\n \"title\": \"Sentiment value must be one of Positive, Neutral, or Negative.\",\n \"detail\": \"\",\n \"code\": \"field_invalid\",\n \"error\": \"\",\n \"source\": {\n \"pointer\": \"/data/attributes/sentiment\"\n }\n }\n ]\n}" schema: type: object properties: errors: type: array items: type: object properties: title: type: string example: A task outcome with the same title already exists. detail: type: string example: '' code: type: string example: field_invalid error: type: string example: '' source: type: object properties: pointer: type: string example: /data/attributes/title deprecated: false tags: - Tasks x-microcks-operation: delay: 0 dispatcher: FALLBACK delete: summary: ActiveCampaign Delete a Task Outcome description: Delete an existing task outcome operationId: delete-a-task-outcome parameters: - name: id in: path description: Task outcome's id schema: type: string required: true responses: '200': description: '200' content: application/json: examples: Result: value: '{}' schema: type: object properties: {} '404': description: '404' content: text/plain: examples: Result: value: "{\n \"message\": \"No Result found for TaskOutcome with id 111\"\n}" schema: type: object properties: message: type: string example: No Result found for TaskOutcome with id 111 deprecated: false tags: - Tasks x-microcks-operation: delay: 0 dispatcher: FALLBACK /tasktypeOutcomeRels: post: summary: ActiveCampaign WIP Create a Task Type - Outcome Relation description: Create a new task type operationId: create-a-task-outcome-1 requestBody: content: application/json: schema: type: object required: - title - sentiment properties: title: type: string description: Title of the outcome sentiment: type: string description: Sentiment of the outcome enum: - Positive - Neutral - Negative examples: Request Example: value: taskOutcome: title: Interested sentiment: Positive responses: '200': description: '200' content: application/json: examples: Result: value: "{\n \"taskOutcome\": {\n \"title\": \"Interested\",\n \"sentiment\": \"POSITIVE\",\n \"created_by\": \"1\",\n \"disabled\": \"\",\n \"links\": {\n \"tasktypeOutcomeRels\": \"https://youraccountname.api-us1.com/api/3/taskOutcomes/1/tasktypeOutcomeRels\",\n \"dealTasks\": \"https://youraccountname.api-us1.com/api/3/taskOutcomes/1/dealTasks\"\n },\n \"id\": \"1\"\n }\n}" schema: type: object properties: taskOutcome: type: object properties: title: type: string example: Interested sentiment: type: string example: POSITIVE created_by: type: string example: '1' disabled: type: string example: '' links: type: object properties: tasktypeOutcomeRels: type: string example: https://youraccountname.api-us1.com/api/3/taskOutcomes/1/tasktypeOutcomeRels dealTasks: type: string example: https://youraccountname.api-us1.com/api/3/taskOutcomes/1/dealTasks id: type: string example: '1' '400': description: '400' content: application/json: examples: Result: value: '{}' schema: type: object properties: {} '422': description: '422' content: text/plain: examples: Result: value: "{\n \"errors\": [\n {\n \"title\": \"A task outcome with the same title already exists.\",\n \"detail\": \"\",\n \"code\": \"field_invalid\",\n \"error\": \"\",\n \"source\": {\n \"pointer\": \"/data/attributes/title\"\n }\n },\n {\n \"title\": \"Sentiment value must be one of Positive, Neutral, or Negative.\",\n \"detail\": \"\",\n \"code\": \"field_invalid\",\n \"error\": \"\",\n \"source\": {\n \"pointer\": \"/data/attributes/sentiment\"\n }\n }\n ]\n}" schema: type: object properties: errors: type: array items: type: object properties: title: type: string example: A task outcome with the same title already exists. detail: type: string example: '' code: type: string example: field_invalid error: type: string example: '' source: type: object properties: pointer: type: string example: /data/attributes/title deprecated: false tags: - Tasks x-microcks-operation: delay: 0 dispatcher: FALLBACK get: summary: ActiveCampaign List All Task Type - Outcome Relations description: Retrieve all existing task type - outcome relations operationId: list-all-task-type-outcome-relations responses: '200': description: '200' content: application/json: examples: Result: value: "{\n \"tasktypeOutcomeRels\": [\n {\n \"tasktype_id\": \"1\",\n \"outcome_id\": \"9\",\n \"display_order\": \"0\",\n \"created_by\": \"0\",\n \"created_utc_timestamp\": \"2021-04-02T12:06:06-05:00\",\n \"updated_by\": null,\n \"updated_utc_timestamp\": \"2021-04-02 12:06:06\",\n \"links\": {\n \"tasktype\": \"https://youraccountname.api-us1.com/api/3/tasktypeOutcomeRels/57/tasktype\",\n \"outcome\": \"https://youraccountname.api-us1.com/api/3/tasktypeOutcomeRels/57/outcome\",\n \"createdBy\": \"https://youraccountname.api-us1.com/api/3/tasktypeOutcomeRels/57/createdBy\"\n },\n \"id\": \"1\",\n \"tasktype\": \"1\",\n \"outcome\": \"9\",\n \"createdBy\": \"1\"\n },\n {\n \"tasktype_id\": \"1\",\n \"outcome_id\": \"10\",\n \"display_order\": \"1\",\n \"created_by\": \"0\",\n \"created_utc_timestamp\": \"2021-04-02T12:06:06-05:00\",\n \"updated_by\": null,\n \"updated_utc_timestamp\": \"2021-04-02 12:06:06\",\n \"links\": {\n \"tasktype\": \"https://youraccountname.api-us1.com/api/3/tasktypeOutcomeRels/58/tasktype\",\n \"outcome\": \"https://youraccountname.api-us1.com/api/3/tasktypeOutcomeRels/58/outcome\",\n \"createdBy\": \"https://youraccountname.api-us1.com/api/3/tasktypeOutcomeRels/58/createdBy\"\n },\n \"id\": \"2\",\n \"tasktype\": \"1\",\n \"outcome\": \"10\",\n \"createdBy\": \"1\"\n },\n {\n \"tasktype_id\": \"2\",\n \"outcome_id\": \"9\",\n \"display_order\": \"2\",\n \"created_by\": \"0\",\n \"created_utc_timestamp\": \"2021-04-02T12:06:07-05:00\",\n \"updated_by\": null,\n \"updated_utc_timestamp\": \"2021-04-02 12:06:07\",\n \"links\": {\n \"tasktype\": \"https://youraccountname.api-us1.com/api/3/tasktypeOutcomeRels/60/tasktype\",\n \"outcome\": \"https://youraccountname.api-us1.com/api/3/tasktypeOutcomeRels/60/outcome\",\n \"createdBy\": \"https://youraccountname.api-us1.com/api/3/tasktypeOutcomeRels/60/createdBy\"\n },\n \"id\": \"3\",\n \"tasktype\": \"2\",\n \"outcome\": \"9\",\n \"createdBy\": \"1\"\n }\n ],\n \"meta\": {\n \"total\": \"3\"\n }\n}" schema: type: object properties: tasktypeOutcomeRels: type: array items: type: object properties: tasktype_id: type: string example: '1' outcome_id: type: string example: '9' display_order: type: string example: '0' created_by: type: string example: '0' created_utc_timestamp: type: string example: '2021-04-02T12:06:06-05:00' updated_by: {} updated_utc_timestamp: type: string example: '2021-04-02 12:06:06' links: type: object properties: tasktype: type: string example: https://youraccountname.api-us1.com/api/3/tasktypeOutcomeRels/57/tasktype outcome: type: string example: https://youraccountname.api-us1.com/api/3/tasktypeOutcomeRels/57/outcome createdBy: type: string example: https://youraccountname.api-us1.com/api/3/tasktypeOutcomeRels/57/createdBy id: type: string example: '1' tasktype: type: string example: '1' outcome: type: string example: '9' createdBy: type: string example: '1' meta: type: object properties: total: type: string example: '3' '400': description: '400' content: application/json: examples: Result: value: '{}' schema: type: object properties: {} deprecated: false tags: - Tasks x-microcks-operation: delay: 0 dispatcher: FALLBACK /tasktypeOutcomeRels/{id}: get: summary: ActiveCampaign Retrieve a Task Type - Outcome Relation description: Retrieve an existing task type - outcome relation operationId: retrieve-a-task-type-outcome-relation parameters: - name: id in: path description: Task type - outcome relation's id schema: type: integer format: int32 required: true responses: '200': description: '200' content: application/json: examples: Result: value: "{\n \"tasktypeOutcomeRel\": {\n \"tasktype_id\": \"1\",\n \"outcome_id\": \"9\",\n \"display_order\": \"0\",\n \"created_by\": \"0\",\n \"created_utc_timestamp\": \"2021-04-05T15:19:36-05:00\",\n \"updated_by\": null,\n \"updated_utc_timestamp\": \"2021-04-05 15:19:36\",\n \"links\": {\n \"tasktype\": \"http://hosted.localdev/api/3/tasktypeOutcomeRels/1/tasktype\",\n \"outcome\": \"http://hosted.localdev/api/3/tasktypeOutcomeRels/1/outcome\",\n \"createdBy\": \"http://hosted.localdev/api/3/tasktypeOutcomeRels/1/createdBy\"\n },\n \"id\": \"1\",\n \"tasktype\": \"1\",\n \"outcome\": \"1\",\n \"createdBy\": \"1\"\n }\n}" schema: type: object properties: tasktypeOutcomeRel: type: object properties: tasktype_id: type: string example: '1' outcome_id: type: string example: '9' display_order: type: string example: '0' created_by: type: string example: '0' created_utc_timestamp: type: string example: '2021-04-05T15:19:36-05:00' updated_by: {} updated_utc_timestamp: type: string example: '2021-04-05 15:19:36' links: type: object properties: tasktype: type: string example: http://hosted.localdev/api/3/tasktypeOutcomeRels/1/tasktype outcome: type: string example: http://hosted.localdev/api/3/tasktypeOutcomeRels/1/outcome createdBy: type: string example: http://hosted.localdev/api/3/tasktypeOutcomeRels/1/createdBy id: type: string example: '1' tasktype: type: string example: '1' outcome: type: string example: '1' createdBy: type: string example: '1' '404': description: '404' content: application/json: examples: Result: value: "{\n \"message\": \"No Result found for TasktypeOutcomeRel with id 111\"\n}" schema: type: object properties: message: type: string example: No Result found for TasktypeOutcomeRel with id 111 deprecated: false tags: - Tasks x-microcks-operation: delay: 0 dispatcher: FALLBACK put: summary: ActiveCampaign WIP Update a Task Type - Outcome Relation description: Update an existing task type operationId: update-a-task-outcome-1 parameters: - name: id in: path description: Task type - outcome relation'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. required: [] type: object examples: Request Example: value: taskOutcome: title: Interested responses: '200': description: '200' content: application/json: examples: Result: value: "{\n \"taskOutcome\": {\n \"title\": \"Interested\",\n \"sentiment\": \"POSITIVE\",\n \"disabled\": \"0\",\n \"created_by\": \"1\",\n \"updated_by\": \"1\",\n \"created_utc_timestamp\": \"2021-02-16T12:26:15-06:00\",\n \"updated_utc_timestamp\": \"2021-02-16T12:27:56-06:00\",\n \"links\": {\n \"tasktypeOutcomeRels\": \"https://task-outcomes.staging.api-us1.com/api/3/taskOutcomes/1/tasktypeOutcomeRels\",\n \"dealTasks\": \"https://task-outcomes.staging.api-us1.com/api/3/taskOutcomes/1/dealTasks\"\n },\n \"id\": \"1\"\n }\n}" schema: type: object properties: taskOutcome: type: object properties: title: type: string example: Interested sentiment: type: string example: POSITIVE disabled: type: string example: '0' created_by: type: string example: '1' updated_by: type: string example: '1' created_utc_timestamp: type: string example: '2021-02-16T12:26:15-06:00' updated_utc_timestamp: type: string example: '2021-02-16T12:27:56-06:00' links: type: object properties: tasktypeOutcomeRels: type: string example: https://task-outcomes.staging.api-us1.com/api/3/taskOutcomes/1/tasktypeOutcomeRels dealTasks: type: string example: https://task-outcomes.staging.api-us1.com/api/3/taskOutcomes/1/dealTasks id: type: string example: '1' '400': description: '400' content: application/json: examples: Result: value: '{}' schema: type: object properties: {} '422': description: '422' content: text/plain: examples: Result: value: "{\n \"errors\": [\n {\n \"title\": \"A task outcome with the same title already exists.\",\n \"detail\": \"\",\n \"code\": \"field_invalid\",\n \"error\": \"\",\n \"source\": {\n \"pointer\": \"/data/attributes/title\"\n }\n },\n {\n \"title\": \"Sentiment value must be one of Positive, Neutral, or Negative.\",\n \"detail\": \"\",\n \"code\": \"field_invalid\",\n \"error\": \"\",\n \"source\": {\n \"pointer\": \"/data/attributes/sentiment\"\n }\n }\n ]\n}" schema: oneOf: - type: object properties: errors: type: array items: type: object properties: title: type: string example: The taskOutcome title was not provided. detail: type: string example: '' code: type: string example: field_missing error: type: string example: taskOutcome_title_was_not_provided source: type: object properties: pointer: type: string example: /data/attributes/title - type: object properties: errors: type: array items: type: object properties: title: type: string example: A task outcome with the same title already exists. detail: type: string example: '' code: type: string example: field_invalid error: type: string example: '' source: type: object properties: pointer: type: string example: /data/attributes/title deprecated: false tags: - Tasks x-microcks-operation: delay: 0 dispatcher: FALLBACK delete: summary: ActiveCampaign Delete a Task Type - Outcome Relation description: Delete an existing task type - outcome relation operationId: delete-a-task-type-outcome-relation parameters: - name: id in: path description: Task type - outcome relation's id schema: type: integer format: int32 required: true responses: '200': description: '200' content: application/json: examples: Result: value: '{}' schema: type: object properties: {} '404': description: '404' content: text/plain: examples: Result: value: "{\n \"message\": \"No Result found for TasktypeOutcomeRel with id 111\"\n}" schema: type: object properties: message: type: string example: No Result found for TasktypeOutcomeRel with id 111 deprecated: false tags: - Tasks x-microcks-operation: delay: 0 dispatcher: FALLBACK /taskNotifications: post: summary: ActiveCampaign Create a Task Reminder description: Create a new task reminder operationId: create-a-task-reminder requestBody: content: application/json: schema: type: object required: - dealTask - interval properties: dealTask: type: string description: ID of task interval: type: integer description: Amount of time in minutes that a reminder will be sent to a task assignee ahead of task's due date. format: int32 examples: Request Example: value: taskNotification: dealTask: '1' interval: '123' responses: '200': description: '200' content: application/json: examples: Result: value: '' '422': description: '422' content: application/json: examples: Result: value: '' deprecated: false tags: - Tasks x-microcks-operation: delay: 0 dispatcher: FALLBACK components: securitySchemes: ApiToken: type: apiKey name: Api-Token in: header description: Your ActiveCampaign API token