{ "info": { "_postman_id": "604ad661-3e42-4bae-b973-9ea4823a5ed4", "name": "Automation API", "description": "API for managing workflows on 8x8 Automation\n\nContact Support:\n Name: 8x8 Inc\n Email: cpaas-support@8x8.com", "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json", "createdAt": "2026-07-28T00:28:13.000Z", "updatedAt": "2026-07-28T00:28:13.000Z", "lastUpdatedBy": "35240", "uid": "35240-604ad661-3e42-4bae-b973-9ea4823a5ed4" }, "item": [ { "name": "api", "item": [ { "name": "v1", "item": [ { "name": "accounts", "item": [ { "name": "{accountId}", "item": [ { "name": "definitions", "item": [ { "name": "{definitionId}", "item": [ { "name": "workflows", "item": [ { "name": "{workflowId}", "item": [ { "name": "errors", "item": [ { "name": "Retrieve a list of errors for a workflow instance", "id": "8d00347e-aac3-43c5-bcc0-7fb4474da236", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/accounts/:accountId/definitions/:definitionId/workflows/:workflowId/errors", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "accounts", ":accountId", "definitions", ":definitionId", "workflows", ":workflowId", "errors" ], "variable": [ { "id": "178a18a9-0a7d-4b9b-8fd2-55aa026c5c2b", "key": "accountId", "value": "", "description": "(Required) Account id" }, { "id": "640f6957-98b1-4713-98dc-e977030cfb16", "key": "definitionId", "value": "", "description": "(Required) Workflow definition id." }, { "id": "7cbcc1b9-691f-4fbe-81fa-3fda2fcc304b", "key": "workflowId", "value": "", "description": "(Required) Workflow instance id." } ] }, "description": "Use this resource to retrieve a list of runtime errors for a workflow instance. If the workflow definition is not working as expected, workflow errors help you figure out what went wrong." }, "response": [ { "id": "e1b86da9-e0fe-44cd-972f-fbbe65c8696e", "name": "List of workflow instance errors.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v1/accounts/:accountId/definitions/:definitionId/workflows/:workflowId/errors", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "accounts", ":accountId", "definitions", ":definitionId", "workflows", ":workflowId", "errors" ], "variable": [ { "key": "accountId" }, { "key": "definitionId" }, { "key": "workflowId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "[\n {\n \"workflowId\": \"\",\n \"step\": \"\",\n \"message\": \"\",\n \"errorTime\": \"\"\n },\n {\n \"workflowId\": \"\",\n \"step\": \"\",\n \"message\": \"\",\n \"errorTime\": \"\"\n }\n]", "createdAt": "2026-07-28T00:28:13.000Z", "updatedAt": "2026-07-28T00:28:13.000Z", "uid": "35240-e1b86da9-e0fe-44cd-972f-fbbe65c8696e" }, { "id": "66211f83-eecf-4923-b3b9-07fe83693354", "name": "Request is invalid.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v1/accounts/:accountId/definitions/:definitionId/workflows/:workflowId/errors", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "accounts", ":accountId", "definitions", ":definitionId", "workflows", ":workflowId", "errors" ], "variable": [ { "key": "accountId" }, { "key": "definitionId" }, { "key": "workflowId" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"errorId\": \"\",\n \"timestamp\": \"\"\n}", "createdAt": "2026-07-28T00:28:13.000Z", "updatedAt": "2026-07-28T00:28:13.000Z", "uid": "35240-66211f83-eecf-4923-b3b9-07fe83693354" }, { "id": "1581bb2d-d91c-49fe-92b7-94e38008666e", "name": "Workflow instance or definition is not found.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v1/accounts/:accountId/definitions/:definitionId/workflows/:workflowId/errors", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "accounts", ":accountId", "definitions", ":definitionId", "workflows", ":workflowId", "errors" ], "variable": [ { "key": "accountId" }, { "key": "definitionId" }, { "key": "workflowId" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"errorId\": \"\",\n \"timestamp\": \"\"\n}", "createdAt": "2026-07-28T00:28:13.000Z", "updatedAt": "2026-07-28T00:28:13.000Z", "uid": "35240-1581bb2d-d91c-49fe-92b7-94e38008666e" } ], "createdAt": "2026-07-28T00:28:13.000Z", "updatedAt": "2026-07-28T00:28:13.000Z", "uid": "35240-8d00347e-aac3-43c5-bcc0-7fb4474da236" } ], "id": "e0440902-eec5-4c77-b309-6c1a93a3b492", "createdAt": "2026-07-28T00:28:13.000Z", "updatedAt": "2026-07-28T00:28:13.000Z", "uid": "35240-e0440902-eec5-4c77-b309-6c1a93a3b492" }, { "name": "Retrieve workflow instance status", "id": "1392aee1-f288-42b6-aacf-06e422c9e22b", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/accounts/:accountId/definitions/:definitionId/workflows/:workflowId?includeLogs=false", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "accounts", ":accountId", "definitions", ":definitionId", "workflows", ":workflowId" ], "query": [ { "description": "If set to true, response includes detailed execution logs of workflow steps. This information is useful when debugging a workflow definition.", "key": "includeLogs", "value": "false" } ], "variable": [ { "id": "7367d98d-7da3-4d6b-905a-4fa12968c534", "key": "accountId", "value": "", "description": "(Required) Account id" }, { "id": "ffe9f16a-96d4-4473-8605-dcdc8d7b1819", "key": "definitionId", "value": "", "description": "(Required) Workflow definition id." }, { "id": "73fffe87-15cd-4ba3-8ad2-021078cbc20a", "key": "workflowId", "value": "", "description": "(Required) Workflow instance id." } ] }, "description": "Use this resource to view the status of a workflow instance." }, "response": [ { "id": "10f6d9ad-7706-4c4b-8817-68fd013d4c41", "name": "Workflow instance.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v1/accounts/:accountId/definitions/:definitionId/workflows/:workflowId?includeLogs=false", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "accounts", ":accountId", "definitions", ":definitionId", "workflows", ":workflowId" ], "query": [ { "description": "If set to true, response includes detailed execution logs of workflow steps. This information is useful when debugging a workflow definition.", "key": "includeLogs", "value": "false" } ], "variable": [ { "key": "accountId" }, { "key": "definitionId" }, { "key": "workflowId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"workflowId\": \"\",\n \"data\": {\n \"accountId\": \"\",\n \"triggeredAt\": \"\",\n \"subAccountId\": \"\"\n },\n \"definitionId\": \"\",\n \"version\": \"\",\n \"status\": \"\",\n \"startedAt\": \"\",\n \"completedAt\": null\n}", "createdAt": "2026-07-28T00:28:13.000Z", "updatedAt": "2026-07-28T00:28:13.000Z", "uid": "35240-10f6d9ad-7706-4c4b-8817-68fd013d4c41" }, { "id": "5edefcc5-9a84-4f41-b765-e0b4186e9df4", "name": "Workflow definition id or the workflow instance id is invalid (not a valid uuid).", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v1/accounts/:accountId/definitions/:definitionId/workflows/:workflowId?includeLogs=false", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "accounts", ":accountId", "definitions", ":definitionId", "workflows", ":workflowId" ], "query": [ { "description": "If set to true, response includes detailed execution logs of workflow steps. This information is useful when debugging a workflow definition.", "key": "includeLogs", "value": "false" } ], "variable": [ { "key": "accountId" }, { "key": "definitionId" }, { "key": "workflowId" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"errorId\": \"\",\n \"timestamp\": \"\"\n}", "createdAt": "2026-07-28T00:28:13.000Z", "updatedAt": "2026-07-28T00:28:13.000Z", "uid": "35240-5edefcc5-9a84-4f41-b765-e0b4186e9df4" }, { "id": "8597d319-82d2-4309-9746-f05922fa4ca6", "name": "Workflow instance or definition is not found.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v1/accounts/:accountId/definitions/:definitionId/workflows/:workflowId?includeLogs=false", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "accounts", ":accountId", "definitions", ":definitionId", "workflows", ":workflowId" ], "query": [ { "description": "If set to true, response includes detailed execution logs of workflow steps. This information is useful when debugging a workflow definition.", "key": "includeLogs", "value": "false" } ], "variable": [ { "key": "accountId" }, { "key": "definitionId" }, { "key": "workflowId" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"errorId\": \"\",\n \"timestamp\": \"\"\n}", "createdAt": "2026-07-28T00:28:13.000Z", "updatedAt": "2026-07-28T00:28:13.000Z", "uid": "35240-8597d319-82d2-4309-9746-f05922fa4ca6" } ], "createdAt": "2026-07-28T00:28:13.000Z", "updatedAt": "2026-07-28T00:28:13.000Z", "uid": "35240-1392aee1-f288-42b6-aacf-06e422c9e22b" }, { "name": "Update workflow instance status", "id": "8093a0b7-ec14-4cfa-8f00-60253dce8732", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"status\": \"suspend\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v1/accounts/:accountId/definitions/:definitionId/workflows/:workflowId", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "accounts", ":accountId", "definitions", ":definitionId", "workflows", ":workflowId" ], "variable": [ { "id": "562df90f-252d-46b3-bc34-4a169bf84c5b", "key": "accountId", "value": "", "description": "(Required) Account id" }, { "id": "93264631-0f1d-49c9-8285-d4bacc999d02", "key": "definitionId", "value": "", "description": "(Required) Workflow definition id." }, { "id": "b4989bb6-e6ae-436f-9bbb-ab43a0e1802e", "key": "workflowId", "value": "", "description": "(Required) Workflow instance id." } ] }, "description": "Use this resource to control the state of a workflow instance. For example, you can suspend a workflow to be resumed later or terminate a workflow due to an error." }, "response": [ { "id": "5278498e-cb8f-47ab-b38c-e81d3f27f3cd", "name": "Workflow status successfully updated.", "originalRequest": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"status\": \"suspend\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v1/accounts/:accountId/definitions/:definitionId/workflows/:workflowId", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "accounts", ":accountId", "definitions", ":definitionId", "workflows", ":workflowId" ], "variable": [ { "key": "accountId" }, { "key": "definitionId" }, { "key": "workflowId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T00:28:13.000Z", "updatedAt": "2026-07-28T00:28:13.000Z", "uid": "35240-5278498e-cb8f-47ab-b38c-e81d3f27f3cd" }, { "id": "6186e9a3-3ec7-413e-819d-f9878c86dea7", "name": "Request is invalid.", "originalRequest": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"status\": \"suspend\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v1/accounts/:accountId/definitions/:definitionId/workflows/:workflowId", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "accounts", ":accountId", "definitions", ":definitionId", "workflows", ":workflowId" ], "variable": [ { "key": "accountId" }, { "key": "definitionId" }, { "key": "workflowId" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"errorId\": \"\",\n \"timestamp\": \"\"\n}", "createdAt": "2026-07-28T00:28:13.000Z", "updatedAt": "2026-07-28T00:28:13.000Z", "uid": "35240-6186e9a3-3ec7-413e-819d-f9878c86dea7" }, { "id": "1f0ce2aa-5035-4ba4-bf37-649e12e2dfa2", "name": "Workflow instance or definition is not found.", "originalRequest": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"status\": \"suspend\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v1/accounts/:accountId/definitions/:definitionId/workflows/:workflowId", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "accounts", ":accountId", "definitions", ":definitionId", "workflows", ":workflowId" ], "variable": [ { "key": "accountId" }, { "key": "definitionId" }, { "key": "workflowId" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"errorId\": \"\",\n \"timestamp\": \"\"\n}", "createdAt": "2026-07-28T00:28:13.000Z", "updatedAt": "2026-07-28T00:28:13.000Z", "uid": "35240-1f0ce2aa-5035-4ba4-bf37-649e12e2dfa2" } ], "createdAt": "2026-07-28T00:28:13.000Z", "updatedAt": "2026-07-28T00:28:13.000Z", "uid": "35240-8093a0b7-ec14-4cfa-8f00-60253dce8732" } ], "id": "e1eca5b5-5fa7-4389-b168-9ccdf7747f2f", "createdAt": "2026-07-28T00:28:13.000Z", "updatedAt": "2026-07-28T00:28:13.000Z", "uid": "35240-e1eca5b5-5fa7-4389-b168-9ccdf7747f2f" }, { "name": "Retrieve a list of workflow instances", "id": "8a9083ee-76e8-44a9-a675-d8818b4460b8", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/accounts/:accountId/definitions/:definitionId/workflows?limit=100&offset=0&version=&status=Suspended&startTimeFrom=&startTimeTo=", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "accounts", ":accountId", "definitions", ":definitionId", "workflows" ], "query": [ { "description": "Number of items to include in the response.", "key": "limit", "value": "100" }, { "description": "Page offset. Setting limit to 10 and offset to 0 returns the first 10 items. Increment offset to retrieve more items.", "key": "offset", "value": "0" }, { "description": "Version of the workflow definition.", "key": "version", "value": "" }, { "key": "status", "value": "Suspended" }, { "description": "Minimum workflow instance start time in ISO 8601 format", "key": "startTimeFrom", "value": "" }, { "description": "Maximum workflow instance start time in ISO 8601 format", "key": "startTimeTo", "value": "" } ], "variable": [ { "id": "122b332e-abc5-418f-a7eb-3f1e8380f62d", "key": "accountId", "value": "", "description": "(Required) Account id" }, { "id": "cc6c2a62-aab4-4d3a-895f-82b7d4e9b8fd", "key": "definitionId", "value": "", "description": "(Required) Workflow definition id." } ] }, "description": "Use this resource to explore workflows created based on a specific workflow definition. If the definition version is not specified, workflows for the latest version are returned. Results are ordered in descending order of their creation time. Use parameters `limit` and `offset` to paginate through the list." }, "response": [ { "id": "b6e4dca3-caf0-49a9-a52b-4baf106375ad", "name": "List of workflow instances. If there are no workflows by the specified definition id, an empty list is returned.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v1/accounts/:accountId/definitions/:definitionId/workflows?limit=100&offset=0&version=&status=Suspended&startTimeFrom=&startTimeTo=", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "accounts", ":accountId", "definitions", ":definitionId", "workflows" ], "query": [ { "description": "Number of items to include in the response.", "key": "limit", "value": "100" }, { "description": "Page offset. Setting limit to 10 and offset to 0 returns the first 10 items. Increment offset to retrieve more items.", "key": "offset", "value": "0" }, { "description": "Version of the workflow definition.", "key": "version", "value": "" }, { "key": "status", "value": "Suspended" }, { "description": "Minimum workflow instance start time in ISO 8601 format", "key": "startTimeFrom", "value": "" }, { "description": "Maximum workflow instance start time in ISO 8601 format", "key": "startTimeTo", "value": "" } ], "variable": [ { "key": "accountId" }, { "key": "definitionId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "[\n {\n \"workflowId\": \"\",\n \"data\": {\n \"accountId\": \"\",\n \"triggeredAt\": \"\",\n \"subAccountId\": \"\"\n },\n \"definitionId\": \"\",\n \"version\": \"\",\n \"status\": \"\",\n \"startedAt\": \"\",\n \"completedAt\": null\n },\n {\n \"workflowId\": \"\",\n \"data\": {\n \"accountId\": \"\",\n \"triggeredAt\": \"\",\n \"subAccountId\": \"\"\n },\n \"definitionId\": \"\",\n \"version\": \"\",\n \"status\": \"\",\n \"startedAt\": \"\",\n \"completedAt\": null\n }\n]", "createdAt": "2026-07-28T00:28:13.000Z", "updatedAt": "2026-07-28T00:28:13.000Z", "uid": "35240-b6e4dca3-caf0-49a9-a52b-4baf106375ad" }, { "id": "d5bc4a6d-5a36-4a09-ae3e-3d4bec931d99", "name": "Definition id is invalid (not a valid uuid).", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v1/accounts/:accountId/definitions/:definitionId/workflows?limit=100&offset=0&version=&status=Suspended&startTimeFrom=&startTimeTo=", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "accounts", ":accountId", "definitions", ":definitionId", "workflows" ], "query": [ { "description": "Number of items to include in the response.", "key": "limit", "value": "100" }, { "description": "Page offset. Setting limit to 10 and offset to 0 returns the first 10 items. Increment offset to retrieve more items.", "key": "offset", "value": "0" }, { "description": "Version of the workflow definition.", "key": "version", "value": "" }, { "key": "status", "value": "Suspended" }, { "description": "Minimum workflow instance start time in ISO 8601 format", "key": "startTimeFrom", "value": "" }, { "description": "Maximum workflow instance start time in ISO 8601 format", "key": "startTimeTo", "value": "" } ], "variable": [ { "key": "accountId" }, { "key": "definitionId" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"errorId\": \"\",\n \"timestamp\": \"\"\n}", "createdAt": "2026-07-28T00:28:13.000Z", "updatedAt": "2026-07-28T00:28:13.000Z", "uid": "35240-d5bc4a6d-5a36-4a09-ae3e-3d4bec931d99" }, { "id": "48c3d0f9-342f-4b67-bc3b-6a2f677d6ba6", "name": "Workflow definition is not found.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v1/accounts/:accountId/definitions/:definitionId/workflows?limit=100&offset=0&version=&status=Suspended&startTimeFrom=&startTimeTo=", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "accounts", ":accountId", "definitions", ":definitionId", "workflows" ], "query": [ { "description": "Number of items to include in the response.", "key": "limit", "value": "100" }, { "description": "Page offset. Setting limit to 10 and offset to 0 returns the first 10 items. Increment offset to retrieve more items.", "key": "offset", "value": "0" }, { "description": "Version of the workflow definition.", "key": "version", "value": "" }, { "key": "status", "value": "Suspended" }, { "description": "Minimum workflow instance start time in ISO 8601 format", "key": "startTimeFrom", "value": "" }, { "description": "Maximum workflow instance start time in ISO 8601 format", "key": "startTimeTo", "value": "" } ], "variable": [ { "key": "accountId" }, { "key": "definitionId" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"errorId\": \"\",\n \"timestamp\": \"\"\n}", "createdAt": "2026-07-28T00:28:13.000Z", "updatedAt": "2026-07-28T00:28:13.000Z", "uid": "35240-48c3d0f9-342f-4b67-bc3b-6a2f677d6ba6" } ], "createdAt": "2026-07-28T00:28:13.000Z", "updatedAt": "2026-07-28T00:28:13.000Z", "uid": "35240-8a9083ee-76e8-44a9-a675-d8818b4460b8" }, { "name": "Test workflow definition", "id": "7c9cfa7a-d81e-46d6-90c7-f6970be33478", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v1/accounts/:accountId/definitions/:definitionId/workflows?version=", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "accounts", ":accountId", "definitions", ":definitionId", "workflows" ], "query": [ { "description": "Version of the definition to test. If not specified, latest version is used.", "key": "version", "value": "" } ], "variable": [ { "id": "2e637e49-0ccd-43f4-a224-bba70377e895", "key": "accountId", "value": "", "description": "(Required) Account id" }, { "id": "e4ef77c9-39eb-4199-9542-d8464b429e92", "key": "definitionId", "value": "", "description": "(Required) Workflow definition id." } ] }, "description": "Use this resource to test workflow definition by starting workflow instances. This endpoint is useful for testing your workflows without involving external triggers like inbound messages." }, "response": [ { "id": "72581508-6858-4913-be01-9cf71cce4cfa", "name": "A new workflow instance has been started from the specified workflow.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v1/accounts/:accountId/definitions/:definitionId/workflows?version=", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "accounts", ":accountId", "definitions", ":definitionId", "workflows" ], "query": [ { "description": "Version of the definition to test. If not specified, latest version is used.", "key": "version", "value": "" } ], "variable": [ { "key": "accountId" }, { "key": "definitionId" } ] } }, "status": "Created", "code": 201, "_postman_previewlanguage": "text", "header": [ { "disabled": false, "description": { "content": "Path to the newly started workflow instance.", "type": "text/plain" }, "key": "Location", "value": "" } ], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T00:28:13.000Z", "updatedAt": "2026-07-28T00:28:13.000Z", "uid": "35240-72581508-6858-4913-be01-9cf71cce4cfa" }, { "id": "9bb40305-0336-4c77-8819-80bc5f776a2d", "name": "Definition id is invalid (not a valid uuid).", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v1/accounts/:accountId/definitions/:definitionId/workflows?version=", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "accounts", ":accountId", "definitions", ":definitionId", "workflows" ], "query": [ { "description": "Version of the definition to test. If not specified, latest version is used.", "key": "version", "value": "" } ], "variable": [ { "key": "accountId" }, { "key": "definitionId" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"errorId\": \"\",\n \"timestamp\": \"\"\n}", "createdAt": "2026-07-28T00:28:13.000Z", "updatedAt": "2026-07-28T00:28:13.000Z", "uid": "35240-9bb40305-0336-4c77-8819-80bc5f776a2d" }, { "id": "39572fe3-f6a1-4c52-bea6-d02628d145f4", "name": "Workflow definition is not found.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v1/accounts/:accountId/definitions/:definitionId/workflows?version=", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "accounts", ":accountId", "definitions", ":definitionId", "workflows" ], "query": [ { "description": "Version of the definition to test. If not specified, latest version is used.", "key": "version", "value": "" } ], "variable": [ { "key": "accountId" }, { "key": "definitionId" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"errorId\": \"\",\n \"timestamp\": \"\"\n}", "createdAt": "2026-07-28T00:28:13.000Z", "updatedAt": "2026-07-28T00:28:13.000Z", "uid": "35240-39572fe3-f6a1-4c52-bea6-d02628d145f4" } ], "createdAt": "2026-07-28T00:28:13.000Z", "updatedAt": "2026-07-28T00:28:13.000Z", "uid": "35240-7c9cfa7a-d81e-46d6-90c7-f6970be33478" } ], "id": "f12cf7d6-ee56-4eaf-8242-da4513db05b0", "createdAt": "2026-07-28T00:28:13.000Z", "updatedAt": "2026-07-28T00:28:13.000Z", "uid": "35240-f12cf7d6-ee56-4eaf-8242-da4513db05b0" }, { "name": "Retrieve the version history of a workflow definition.", "id": "a19ad0b4-27c6-4740-9670-e1ad9cc9a593", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/accounts/:accountId/definitions/:definitionId?limit=100&offset=0", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "accounts", ":accountId", "definitions", ":definitionId" ], "query": [ { "description": "Number of items to include in the response.", "key": "limit", "value": "100" }, { "description": "Page offset. Setting limit to 10 and offset to 0 returns the first 10 items. Increment offset to retrieve more items.", "key": "offset", "value": "0" } ], "variable": [ { "id": "8aa86564-746f-49ae-b6f1-e4fdddd7bdd5", "key": "accountId", "value": "", "description": "(Required) Account id" }, { "id": "ae92a775-3bea-47bd-b8b5-a4e5d6d982bb", "key": "definitionId", "value": "", "description": "(Required) Workflow definition id." } ] }, "description": "Use this resource to explore different versions of a workflow definition. Results are ordered in the descending order of the version." }, "response": [ { "id": "bee9754f-2e91-445b-ba47-7c650278a16e", "name": "List of definitions. If there are no definitions by the specified definition id, an empty list is returned.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v1/accounts/:accountId/definitions/:definitionId?limit=100&offset=0", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "accounts", ":accountId", "definitions", ":definitionId" ], "query": [ { "description": "Number of items to include in the response.", "key": "limit", "value": "100" }, { "description": "Page offset. Setting limit to 10 and offset to 0 returns the first 10 items. Increment offset to retrieve more items.", "key": "offset", "value": "0" } ], "variable": [ { "key": "accountId" }, { "key": "definitionId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "[\n {\n \"accountId\": \"\",\n \"createdAt\": \"\",\n \"definition\": {\n \"name\": \"\",\n \"steps\": [\n {\n \"id\": \"\",\n \"stepType\": \"SMS\",\n \"inputs\": {\n \"subAccountId\": \"laborum minim culpa\",\n \"destination\": \"labore est veniam\",\n \"text\": \"est dolore aliquip\",\n \"country\": \"sint in consectetur est\",\n \"source\": \"est esse\",\n \"clientMessageId\": \"anim magna sit\",\n \"encoding\": \"sed Ut commodo\",\n \"scheduled\": \"sint elit\",\n \"expiry\": \"eiusmod\",\n \"dlrCallbackUrl\": \"Excepteur veniam sunt velit consectetur\"\n },\n \"outputs\": {\n \"umid\": \"cillum dolore laborum\",\n \"status\": \"laborum cupidatat adipisicing culpa\",\n \"description\": \"enim dolore ad irure fugiat\",\n \"destination\": \"in velit eu ullamco\",\n \"encoding\": \"sit enim ad ut\",\n \"clientMessageId\": \"veniam esse consequat ea irure\"\n },\n \"nextStepId\": \"Ut id\"\n },\n {\n \"id\": \"\",\n \"stepType\": \"SMS\",\n \"inputs\": {\n \"subAccountId\": \"quis ut qui voluptate\",\n \"destination\": \"tempor mollit\",\n \"text\": \"Lorem quis\",\n \"country\": \"Duis sit Lorem \",\n \"source\": \"mini\",\n \"clientMessageId\": \"in aliquip\",\n \"encoding\": \"cupidatat ullamco mollit laboris tempor\",\n \"scheduled\": \"qui elit volupt\",\n \"expiry\": \"pariatur volu\",\n \"dlrCallbackUrl\": \"commodo pariatur ad ut\"\n },\n \"outputs\": {\n \"umid\": \"consequat ut Duis\",\n \"status\": \"velit pariatur aliquip\",\n \"description\": \"ex ea do tempor\",\n \"destination\": \"velit irure\",\n \"encoding\": \"nisi cillum est sit\",\n \"clientMessageId\": \"reprehenderit enim consequat exercitation\"\n },\n \"nextStepId\": \"eiusmod sed commodo\"\n }\n ]\n },\n \"id\": \"\",\n \"trigger\": \"inbound_chat_apps\",\n \"version\": \"\",\n \"subAccountId\": \"\",\n \"status\": \"disabled\"\n },\n {\n \"accountId\": \"\",\n \"createdAt\": \"\",\n \"definition\": {\n \"name\": \"\",\n \"steps\": [\n {\n \"id\": \"\",\n \"stepType\": \"SMS\",\n \"inputs\": {\n \"subAccountId\": \"proident anim Lorem\",\n \"destination\": \"do\",\n \"text\": \"quis dolore sed elit esse\",\n \"country\": \"ad\",\n \"source\": \"id\",\n \"clientMessageId\": \"culpa labore s\",\n \"encoding\": \"eu laborum consectetur nulla\",\n \"scheduled\": \"esse ut non exercitation\",\n \"expiry\": \"esse u\",\n \"dlrCallbackUrl\": \"minim\"\n },\n \"outputs\": {\n \"umid\": \"culpa nu\",\n \"status\": \"in ipsum labore\",\n \"description\": \"quis in\",\n \"destination\": \"pariatur magna\",\n \"encoding\": \"ipsum dolore consequat esse\",\n \"clientMessageId\": \"pari\"\n },\n \"nextStepId\": \"in enim et labore\"\n },\n {\n \"id\": \"\",\n \"stepType\": \"SMS\",\n \"inputs\": {\n \"subAccountId\": \"proident laborum quis e\",\n \"destination\": \"eiusmod in enim\",\n \"text\": \"laborum dolore ex amet ad\",\n \"country\": \"sit elit adipisi\",\n \"source\": \"tempor esse\",\n \"clientMessageId\": \"eu\",\n \"encoding\": \"veniam et amet\",\n \"scheduled\": \"minim\",\n \"expiry\": \"dolor dolore officia Lorem\",\n \"dlrCallbackUrl\": \"dolore ea ut culpa\"\n },\n \"outputs\": {\n \"umid\": \"Lorem quis dolor consequat\",\n \"status\": \"pariatur\",\n \"description\": \"ex do\",\n \"destination\": \"proident\",\n \"encoding\": \"sed\",\n \"clientMessageId\": \"incididunt dolore consectetur\"\n },\n \"nextStepId\": \"elit ullamco non\"\n }\n ]\n },\n \"id\": \"\",\n \"trigger\": \"http_request\",\n \"version\": \"\",\n \"subAccountId\": \"\",\n \"status\": \"disabled\"\n }\n]", "createdAt": "2026-07-28T00:28:13.000Z", "updatedAt": "2026-07-28T00:28:13.000Z", "uid": "35240-bee9754f-2e91-445b-ba47-7c650278a16e" }, { "id": "5406e79b-42c1-4edf-aef1-7a7e86dfa1db", "name": "Definition id is invalid (not a valid uuid).", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v1/accounts/:accountId/definitions/:definitionId?limit=100&offset=0", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "accounts", ":accountId", "definitions", ":definitionId" ], "query": [ { "description": "Number of items to include in the response.", "key": "limit", "value": "100" }, { "description": "Page offset. Setting limit to 10 and offset to 0 returns the first 10 items. Increment offset to retrieve more items.", "key": "offset", "value": "0" } ], "variable": [ { "key": "accountId" }, { "key": "definitionId" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"errorId\": \"\",\n \"timestamp\": \"\"\n}", "createdAt": "2026-07-28T00:28:13.000Z", "updatedAt": "2026-07-28T00:28:13.000Z", "uid": "35240-5406e79b-42c1-4edf-aef1-7a7e86dfa1db" } ], "createdAt": "2026-07-28T00:28:13.000Z", "updatedAt": "2026-07-28T00:28:13.000Z", "uid": "35240-a19ad0b4-27c6-4740-9670-e1ad9cc9a593" }, { "name": "Update workflow definition", "id": "fab0ea19-cf96-465b-94b5-8d82b0651c94", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"trigger\": \"inbound_sms\",\n \"definition\": {\n \"name\": \"\",\n \"steps\": [\n {\n \"id\": \"\",\n \"stepType\": \"SMS\",\n \"inputs\": {\n \"subAccountId\": \"sed dolore\",\n \"destination\": \"Excepteur incididunt sunt aliqua\",\n \"text\": \"aliqua labore\",\n \"country\": \"laboris ex Excepteur sint\",\n \"source\": \"Dui\",\n \"clientMessageId\": \"enim esse mollit\",\n \"encoding\": \"commodo\",\n \"scheduled\": \"Duis commodo ut\",\n \"expiry\": \"quis consectetur dolore\",\n \"dlrCallbackUrl\": \"mollit veniam ea do\"\n },\n \"outputs\": {\n \"umid\": \"irure\",\n \"status\": \"anim veniam sit\",\n \"description\": \"esse nostrud\",\n \"destination\": \"ut\",\n \"encoding\": \"v\",\n \"clientMessageId\": \"irure amet cillum veniam\"\n },\n \"nextStepId\": \"irure ut dolor\"\n },\n {\n \"id\": \"\",\n \"stepType\": \"SMS\",\n \"inputs\": {\n \"subAccountId\": \"ut non incididunt\",\n \"destination\": \"occaecat eu\",\n \"text\": \"velit in sunt\",\n \"country\": \"laboris nostrud\",\n \"source\": \"Excep\",\n \"clientMessageId\": \"consectetur velit ad sed culpa\",\n \"encoding\": \"et\",\n \"scheduled\": \"eiusmod cupidatat et ut exercitation\",\n \"expiry\": \"aliqua eu\",\n \"dlrCallbackUrl\": \"ut ipsum elit nulla adipisicing\"\n },\n \"outputs\": {\n \"umid\": \"\",\n \"status\": \"commodo in\",\n \"description\": \"eiusmod\",\n \"destination\": \"ex nostrud nisi\",\n \"encoding\": \"in qui aliqua\",\n \"clientMessageId\": \"ea dolor culpa est\"\n },\n \"nextStepId\": \"qui elit esse exercitation sed\"\n }\n ]\n },\n \"subAccountId\": \"\",\n \"status\": \"disabled\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v1/accounts/:accountId/definitions/:definitionId", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "accounts", ":accountId", "definitions", ":definitionId" ], "variable": [ { "id": "44a02638-5e6a-42fc-b784-87deb369711e", "key": "accountId", "value": "", "description": "(Required) Account id" }, { "id": "e8b56961-fd96-4a6d-9ad5-0fb4dd6a8f39", "key": "definitionId", "value": "", "description": "(Required) Workflow definition id." } ] }, "description": "Use this resource to update an existing workflow definition. Updating a workflow definition creates and registers a new version of the definition and preserves the old definition in version history. This ensures that any workflows that have already been started from the old version runs to completion while new workflows are started based on the latest version of the workflow definition." }, "response": [ { "id": "193be69a-76b3-432b-95f8-c1e7b3ad6caf", "name": "Updated workflow definition.", "originalRequest": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"trigger\": \"inbound_sms\",\n \"definition\": {\n \"name\": \"\",\n \"steps\": [\n {\n \"id\": \"\",\n \"stepType\": \"SMS\",\n \"inputs\": {\n \"subAccountId\": \"sed dolore\",\n \"destination\": \"Excepteur incididunt sunt aliqua\",\n \"text\": \"aliqua labore\",\n \"country\": \"laboris ex Excepteur sint\",\n \"source\": \"Dui\",\n \"clientMessageId\": \"enim esse mollit\",\n \"encoding\": \"commodo\",\n \"scheduled\": \"Duis commodo ut\",\n \"expiry\": \"quis consectetur dolore\",\n \"dlrCallbackUrl\": \"mollit veniam ea do\"\n },\n \"outputs\": {\n \"umid\": \"irure\",\n \"status\": \"anim veniam sit\",\n \"description\": \"esse nostrud\",\n \"destination\": \"ut\",\n \"encoding\": \"v\",\n \"clientMessageId\": \"irure amet cillum veniam\"\n },\n \"nextStepId\": \"irure ut dolor\"\n },\n {\n \"id\": \"\",\n \"stepType\": \"SMS\",\n \"inputs\": {\n \"subAccountId\": \"ut non incididunt\",\n \"destination\": \"occaecat eu\",\n \"text\": \"velit in sunt\",\n \"country\": \"laboris nostrud\",\n \"source\": \"Excep\",\n \"clientMessageId\": \"consectetur velit ad sed culpa\",\n \"encoding\": \"et\",\n \"scheduled\": \"eiusmod cupidatat et ut exercitation\",\n \"expiry\": \"aliqua eu\",\n \"dlrCallbackUrl\": \"ut ipsum elit nulla adipisicing\"\n },\n \"outputs\": {\n \"umid\": \"\",\n \"status\": \"commodo in\",\n \"description\": \"eiusmod\",\n \"destination\": \"ex nostrud nisi\",\n \"encoding\": \"in qui aliqua\",\n \"clientMessageId\": \"ea dolor culpa est\"\n },\n \"nextStepId\": \"qui elit esse exercitation sed\"\n }\n ]\n },\n \"subAccountId\": \"\",\n \"status\": \"disabled\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v1/accounts/:accountId/definitions/:definitionId", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "accounts", ":accountId", "definitions", ":definitionId" ], "variable": [ { "key": "accountId" }, { "key": "definitionId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"accountId\": \"\",\n \"createdAt\": \"\",\n \"definition\": {\n \"name\": \"\",\n \"steps\": [\n {\n \"id\": \"\",\n \"stepType\": \"SMS\",\n \"inputs\": {\n \"subAccountId\": \"elit\",\n \"destination\": \"exercitation adipisicing\",\n \"text\": \"dolor veniam aliquip eu incididunt\",\n \"country\": \"adipisicing officia consequat\",\n \"source\": \"voluptate anim\",\n \"clientMessageId\": \"pariatur cillum qui nulla\",\n \"encoding\": \"dolor nulla anim dolore\",\n \"scheduled\": \"sed ea fugiat\",\n \"expiry\": \"dolor ex\",\n \"dlrCallbackUrl\": \"aliquip voluptate ullamco consectetur\"\n },\n \"outputs\": {\n \"umid\": \"amet dolor fugiat\",\n \"status\": \"sit\",\n \"description\": \"Duis ex sit\",\n \"destination\": \"nulla enim\",\n \"encoding\": \"cillum laboris labore commodo\",\n \"clientMessageId\": \"laborum\"\n },\n \"nextStepId\": \"reprehenderit eiusmod aliqua mollit\"\n },\n {\n \"id\": \"\",\n \"stepType\": \"SMS\",\n \"inputs\": {\n \"subAccountId\": \"incididunt\",\n \"destination\": \"amet dolore ut\",\n \"text\": \"culpa est irure pariatur\",\n \"country\": \"commodo aliqua nisi\",\n \"source\": \"sit ut labore\",\n \"clientMessageId\": \"incididunt deserunt exercitation\",\n \"encoding\": \"ipsum nisi sed\",\n \"scheduled\": \"Ut sit magna\",\n \"expiry\": \"qui\",\n \"dlrCallbackUrl\": \"laboris dolore sunt ipsum ex\"\n },\n \"outputs\": {\n \"umid\": \"sed \",\n \"status\": \"reprehenderit cupidatat\",\n \"description\": \"ullamco pariatur mollit eiusmod\",\n \"destination\": \"incididunt dolor\",\n \"encoding\": \"pariatur ullamco Ut\",\n \"clientMessageId\": \"in\"\n },\n \"nextStepId\": \"amet fugiat ipsum\"\n }\n ]\n },\n \"id\": \"\",\n \"trigger\": \"inbound_chat_apps\",\n \"version\": \"\",\n \"subAccountId\": \"\",\n \"status\": \"disabled\"\n}", "createdAt": "2026-07-28T00:28:13.000Z", "updatedAt": "2026-07-28T00:28:13.000Z", "uid": "35240-193be69a-76b3-432b-95f8-c1e7b3ad6caf" }, { "id": "09c0e07b-806f-4f1d-9e11-f79c5e05624c", "name": "Request is invalid.", "originalRequest": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"trigger\": \"inbound_sms\",\n \"definition\": {\n \"name\": \"\",\n \"steps\": [\n {\n \"id\": \"\",\n \"stepType\": \"SMS\",\n \"inputs\": {\n \"subAccountId\": \"sed dolore\",\n \"destination\": \"Excepteur incididunt sunt aliqua\",\n \"text\": \"aliqua labore\",\n \"country\": \"laboris ex Excepteur sint\",\n \"source\": \"Dui\",\n \"clientMessageId\": \"enim esse mollit\",\n \"encoding\": \"commodo\",\n \"scheduled\": \"Duis commodo ut\",\n \"expiry\": \"quis consectetur dolore\",\n \"dlrCallbackUrl\": \"mollit veniam ea do\"\n },\n \"outputs\": {\n \"umid\": \"irure\",\n \"status\": \"anim veniam sit\",\n \"description\": \"esse nostrud\",\n \"destination\": \"ut\",\n \"encoding\": \"v\",\n \"clientMessageId\": \"irure amet cillum veniam\"\n },\n \"nextStepId\": \"irure ut dolor\"\n },\n {\n \"id\": \"\",\n \"stepType\": \"SMS\",\n \"inputs\": {\n \"subAccountId\": \"ut non incididunt\",\n \"destination\": \"occaecat eu\",\n \"text\": \"velit in sunt\",\n \"country\": \"laboris nostrud\",\n \"source\": \"Excep\",\n \"clientMessageId\": \"consectetur velit ad sed culpa\",\n \"encoding\": \"et\",\n \"scheduled\": \"eiusmod cupidatat et ut exercitation\",\n \"expiry\": \"aliqua eu\",\n \"dlrCallbackUrl\": \"ut ipsum elit nulla adipisicing\"\n },\n \"outputs\": {\n \"umid\": \"\",\n \"status\": \"commodo in\",\n \"description\": \"eiusmod\",\n \"destination\": \"ex nostrud nisi\",\n \"encoding\": \"in qui aliqua\",\n \"clientMessageId\": \"ea dolor culpa est\"\n },\n \"nextStepId\": \"qui elit esse exercitation sed\"\n }\n ]\n },\n \"subAccountId\": \"\",\n \"status\": \"disabled\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v1/accounts/:accountId/definitions/:definitionId", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "accounts", ":accountId", "definitions", ":definitionId" ], "variable": [ { "key": "accountId" }, { "key": "definitionId" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"errorId\": \"\",\n \"timestamp\": \"\"\n}", "createdAt": "2026-07-28T00:28:13.000Z", "updatedAt": "2026-07-28T00:28:13.000Z", "uid": "35240-09c0e07b-806f-4f1d-9e11-f79c5e05624c" }, { "id": "ef32996e-2d51-4616-897c-40b173b9a502", "name": "Workflow definition is not found.", "originalRequest": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"trigger\": \"inbound_sms\",\n \"definition\": {\n \"name\": \"\",\n \"steps\": [\n {\n \"id\": \"\",\n \"stepType\": \"SMS\",\n \"inputs\": {\n \"subAccountId\": \"sed dolore\",\n \"destination\": \"Excepteur incididunt sunt aliqua\",\n \"text\": \"aliqua labore\",\n \"country\": \"laboris ex Excepteur sint\",\n \"source\": \"Dui\",\n \"clientMessageId\": \"enim esse mollit\",\n \"encoding\": \"commodo\",\n \"scheduled\": \"Duis commodo ut\",\n \"expiry\": \"quis consectetur dolore\",\n \"dlrCallbackUrl\": \"mollit veniam ea do\"\n },\n \"outputs\": {\n \"umid\": \"irure\",\n \"status\": \"anim veniam sit\",\n \"description\": \"esse nostrud\",\n \"destination\": \"ut\",\n \"encoding\": \"v\",\n \"clientMessageId\": \"irure amet cillum veniam\"\n },\n \"nextStepId\": \"irure ut dolor\"\n },\n {\n \"id\": \"\",\n \"stepType\": \"SMS\",\n \"inputs\": {\n \"subAccountId\": \"ut non incididunt\",\n \"destination\": \"occaecat eu\",\n \"text\": \"velit in sunt\",\n \"country\": \"laboris nostrud\",\n \"source\": \"Excep\",\n \"clientMessageId\": \"consectetur velit ad sed culpa\",\n \"encoding\": \"et\",\n \"scheduled\": \"eiusmod cupidatat et ut exercitation\",\n \"expiry\": \"aliqua eu\",\n \"dlrCallbackUrl\": \"ut ipsum elit nulla adipisicing\"\n },\n \"outputs\": {\n \"umid\": \"\",\n \"status\": \"commodo in\",\n \"description\": \"eiusmod\",\n \"destination\": \"ex nostrud nisi\",\n \"encoding\": \"in qui aliqua\",\n \"clientMessageId\": \"ea dolor culpa est\"\n },\n \"nextStepId\": \"qui elit esse exercitation sed\"\n }\n ]\n },\n \"subAccountId\": \"\",\n \"status\": \"disabled\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v1/accounts/:accountId/definitions/:definitionId", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "accounts", ":accountId", "definitions", ":definitionId" ], "variable": [ { "key": "accountId" }, { "key": "definitionId" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"errorId\": \"\",\n \"timestamp\": \"\"\n}", "createdAt": "2026-07-28T00:28:13.000Z", "updatedAt": "2026-07-28T00:28:13.000Z", "uid": "35240-ef32996e-2d51-4616-897c-40b173b9a502" } ], "createdAt": "2026-07-28T00:28:13.000Z", "updatedAt": "2026-07-28T00:28:13.000Z", "uid": "35240-fab0ea19-cf96-465b-94b5-8d82b0651c94" }, { "name": "Delete workflow definition", "id": "01e81c12-106b-45e6-b161-9b6623823900", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/accounts/:accountId/definitions/:definitionId?version=", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "accounts", ":accountId", "definitions", ":definitionId" ], "query": [ { "description": "Version of the workflow definition.", "key": "version", "value": "" } ], "variable": [ { "id": "6f273e3c-b0a0-40f6-9a8c-985ab4888fb3", "key": "accountId", "value": "", "description": "(Required) Account id" }, { "id": "85a82ec6-084e-4af0-a924-2f10085b2b8a", "key": "definitionId", "value": "", "description": "(Required) Workflow definition id." } ] }, "description": "Use this resource to delete workflow definitions. Specify the version of the definition to delete in the query parameter. If no version is specified, all versions of the definition will be deleted. Deleting a definition cancels any active event subscriptions, terminates all active workflows, and deletes workflow execution logs that are based on the definition that is being deleted. Once a workflow is deleted, there is no way to reverse the operation." }, "response": [ { "id": "fb270423-980b-4761-bb58-abcde6af69a9", "name": "Response indicating that a task has been scheduled to delete the workflow definition.", "originalRequest": { "method": "DELETE", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v1/accounts/:accountId/definitions/:definitionId?version=", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "accounts", ":accountId", "definitions", ":definitionId" ], "query": [ { "description": "Version of the workflow definition.", "key": "version", "value": "" } ], "variable": [ { "key": "accountId" }, { "key": "definitionId" } ] } }, "status": "Accepted", "code": 202, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T00:28:13.000Z", "updatedAt": "2026-07-28T00:28:13.000Z", "uid": "35240-fb270423-980b-4761-bb58-abcde6af69a9" }, { "id": "b62a872a-1859-4306-8945-12262110d886", "name": "Definition id is invalid (not a valid uuid).", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v1/accounts/:accountId/definitions/:definitionId?version=", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "accounts", ":accountId", "definitions", ":definitionId" ], "query": [ { "description": "Version of the workflow definition.", "key": "version", "value": "" } ], "variable": [ { "key": "accountId" }, { "key": "definitionId" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"errorId\": \"\",\n \"timestamp\": \"\"\n}", "createdAt": "2026-07-28T00:28:13.000Z", "updatedAt": "2026-07-28T00:28:13.000Z", "uid": "35240-b62a872a-1859-4306-8945-12262110d886" }, { "id": "f0f502a4-5bac-4f71-93a2-f0c6171d19b9", "name": "Workflow definition is not found.", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v1/accounts/:accountId/definitions/:definitionId?version=", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "accounts", ":accountId", "definitions", ":definitionId" ], "query": [ { "description": "Version of the workflow definition.", "key": "version", "value": "" } ], "variable": [ { "key": "accountId" }, { "key": "definitionId" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"errorId\": \"\",\n \"timestamp\": \"\"\n}", "createdAt": "2026-07-28T00:28:13.000Z", "updatedAt": "2026-07-28T00:28:13.000Z", "uid": "35240-f0f502a4-5bac-4f71-93a2-f0c6171d19b9" } ], "createdAt": "2026-07-28T00:28:13.000Z", "updatedAt": "2026-07-28T00:28:13.000Z", "uid": "35240-01e81c12-106b-45e6-b161-9b6623823900" } ], "id": "69ef770c-164a-44c8-bbe0-635c51b2af83", "createdAt": "2026-07-28T00:28:13.000Z", "updatedAt": "2026-07-28T00:28:13.000Z", "uid": "35240-69ef770c-164a-44c8-bbe0-635c51b2af83" }, { "name": "Retrieve a list of active workflow definitions.", "id": "78d0159e-2d10-4b6c-bf53-74d8ffd0df07", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/accounts/:accountId/definitions?limit=100&offset=0", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "accounts", ":accountId", "definitions" ], "query": [ { "description": "Number of items to include in the response.", "key": "limit", "value": "100" }, { "description": "Page offset. Setting limit to 10 and offset to 0 returns the first 10 items. Increment offset to retrieve more items.", "key": "offset", "value": "0" } ], "variable": [ { "id": "edc26f3f-0863-44b1-922d-8b184057ed4e", "key": "accountId", "value": "", "description": "(Required) Account id" } ] }, "description": "Use this resource to explore currently active definitions. Workflows are started based on these definitions when the trigger conditions are met. Use the parameters `limit` and `offset` to paginate through the definitions list." }, "response": [ { "id": "63228afc-e51b-42ea-8ce3-d427851f433e", "name": "List of workflow definitions", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v1/accounts/:accountId/definitions?limit=100&offset=0", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "accounts", ":accountId", "definitions" ], "query": [ { "description": "Number of items to include in the response.", "key": "limit", "value": "100" }, { "description": "Page offset. Setting limit to 10 and offset to 0 returns the first 10 items. Increment offset to retrieve more items.", "key": "offset", "value": "0" } ], "variable": [ { "key": "accountId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "[\n {\n \"accountId\": \"\",\n \"createdAt\": \"\",\n \"definition\": {\n \"name\": \"\",\n \"steps\": [\n {\n \"id\": \"\",\n \"stepType\": \"SMS\",\n \"inputs\": {\n \"subAccountId\": \"laborum minim culpa\",\n \"destination\": \"labore est veniam\",\n \"text\": \"est dolore aliquip\",\n \"country\": \"sint in consectetur est\",\n \"source\": \"est esse\",\n \"clientMessageId\": \"anim magna sit\",\n \"encoding\": \"sed Ut commodo\",\n \"scheduled\": \"sint elit\",\n \"expiry\": \"eiusmod\",\n \"dlrCallbackUrl\": \"Excepteur veniam sunt velit consectetur\"\n },\n \"outputs\": {\n \"umid\": \"cillum dolore laborum\",\n \"status\": \"laborum cupidatat adipisicing culpa\",\n \"description\": \"enim dolore ad irure fugiat\",\n \"destination\": \"in velit eu ullamco\",\n \"encoding\": \"sit enim ad ut\",\n \"clientMessageId\": \"veniam esse consequat ea irure\"\n },\n \"nextStepId\": \"Ut id\"\n },\n {\n \"id\": \"\",\n \"stepType\": \"SMS\",\n \"inputs\": {\n \"subAccountId\": \"quis ut qui voluptate\",\n \"destination\": \"tempor mollit\",\n \"text\": \"Lorem quis\",\n \"country\": \"Duis sit Lorem \",\n \"source\": \"mini\",\n \"clientMessageId\": \"in aliquip\",\n \"encoding\": \"cupidatat ullamco mollit laboris tempor\",\n \"scheduled\": \"qui elit volupt\",\n \"expiry\": \"pariatur volu\",\n \"dlrCallbackUrl\": \"commodo pariatur ad ut\"\n },\n \"outputs\": {\n \"umid\": \"consequat ut Duis\",\n \"status\": \"velit pariatur aliquip\",\n \"description\": \"ex ea do tempor\",\n \"destination\": \"velit irure\",\n \"encoding\": \"nisi cillum est sit\",\n \"clientMessageId\": \"reprehenderit enim consequat exercitation\"\n },\n \"nextStepId\": \"eiusmod sed commodo\"\n }\n ]\n },\n \"id\": \"\",\n \"trigger\": \"inbound_chat_apps\",\n \"version\": \"\",\n \"subAccountId\": \"\",\n \"status\": \"disabled\"\n },\n {\n \"accountId\": \"\",\n \"createdAt\": \"\",\n \"definition\": {\n \"name\": \"\",\n \"steps\": [\n {\n \"id\": \"\",\n \"stepType\": \"SMS\",\n \"inputs\": {\n \"subAccountId\": \"proident anim Lorem\",\n \"destination\": \"do\",\n \"text\": \"quis dolore sed elit esse\",\n \"country\": \"ad\",\n \"source\": \"id\",\n \"clientMessageId\": \"culpa labore s\",\n \"encoding\": \"eu laborum consectetur nulla\",\n \"scheduled\": \"esse ut non exercitation\",\n \"expiry\": \"esse u\",\n \"dlrCallbackUrl\": \"minim\"\n },\n \"outputs\": {\n \"umid\": \"culpa nu\",\n \"status\": \"in ipsum labore\",\n \"description\": \"quis in\",\n \"destination\": \"pariatur magna\",\n \"encoding\": \"ipsum dolore consequat esse\",\n \"clientMessageId\": \"pari\"\n },\n \"nextStepId\": \"in enim et labore\"\n },\n {\n \"id\": \"\",\n \"stepType\": \"SMS\",\n \"inputs\": {\n \"subAccountId\": \"proident laborum quis e\",\n \"destination\": \"eiusmod in enim\",\n \"text\": \"laborum dolore ex amet ad\",\n \"country\": \"sit elit adipisi\",\n \"source\": \"tempor esse\",\n \"clientMessageId\": \"eu\",\n \"encoding\": \"veniam et amet\",\n \"scheduled\": \"minim\",\n \"expiry\": \"dolor dolore officia Lorem\",\n \"dlrCallbackUrl\": \"dolore ea ut culpa\"\n },\n \"outputs\": {\n \"umid\": \"Lorem quis dolor consequat\",\n \"status\": \"pariatur\",\n \"description\": \"ex do\",\n \"destination\": \"proident\",\n \"encoding\": \"sed\",\n \"clientMessageId\": \"incididunt dolore consectetur\"\n },\n \"nextStepId\": \"elit ullamco non\"\n }\n ]\n },\n \"id\": \"\",\n \"trigger\": \"http_request\",\n \"version\": \"\",\n \"subAccountId\": \"\",\n \"status\": \"disabled\"\n }\n]", "createdAt": "2026-07-28T00:28:13.000Z", "updatedAt": "2026-07-28T00:28:13.000Z", "uid": "35240-63228afc-e51b-42ea-8ce3-d427851f433e" } ], "createdAt": "2026-07-28T00:28:13.000Z", "updatedAt": "2026-07-28T00:28:13.000Z", "uid": "35240-78d0159e-2d10-4b6c-bf53-74d8ffd0df07" }, { "name": "Create a new workflow definition", "id": "29ceba1e-b557-46db-93a9-d4dcf4f9cd83", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"trigger\": \"inbound_sms\",\n \"definition\": {\n \"name\": \"\",\n \"steps\": [\n {\n \"id\": \"\",\n \"stepType\": \"SMS\",\n \"inputs\": {\n \"subAccountId\": \"sed dolore\",\n \"destination\": \"Excepteur incididunt sunt aliqua\",\n \"text\": \"aliqua labore\",\n \"country\": \"laboris ex Excepteur sint\",\n \"source\": \"Dui\",\n \"clientMessageId\": \"enim esse mollit\",\n \"encoding\": \"commodo\",\n \"scheduled\": \"Duis commodo ut\",\n \"expiry\": \"quis consectetur dolore\",\n \"dlrCallbackUrl\": \"mollit veniam ea do\"\n },\n \"outputs\": {\n \"umid\": \"irure\",\n \"status\": \"anim veniam sit\",\n \"description\": \"esse nostrud\",\n \"destination\": \"ut\",\n \"encoding\": \"v\",\n \"clientMessageId\": \"irure amet cillum veniam\"\n },\n \"nextStepId\": \"irure ut dolor\"\n },\n {\n \"id\": \"\",\n \"stepType\": \"SMS\",\n \"inputs\": {\n \"subAccountId\": \"ut non incididunt\",\n \"destination\": \"occaecat eu\",\n \"text\": \"velit in sunt\",\n \"country\": \"laboris nostrud\",\n \"source\": \"Excep\",\n \"clientMessageId\": \"consectetur velit ad sed culpa\",\n \"encoding\": \"et\",\n \"scheduled\": \"eiusmod cupidatat et ut exercitation\",\n \"expiry\": \"aliqua eu\",\n \"dlrCallbackUrl\": \"ut ipsum elit nulla adipisicing\"\n },\n \"outputs\": {\n \"umid\": \"\",\n \"status\": \"commodo in\",\n \"description\": \"eiusmod\",\n \"destination\": \"ex nostrud nisi\",\n \"encoding\": \"in qui aliqua\",\n \"clientMessageId\": \"ea dolor culpa est\"\n },\n \"nextStepId\": \"qui elit esse exercitation sed\"\n }\n ]\n },\n \"subAccountId\": \"\",\n \"status\": \"disabled\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v1/accounts/:accountId/definitions", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "accounts", ":accountId", "definitions" ], "variable": [ { "id": "240eb08f-f640-440d-bf0a-71fa89acfa0b", "key": "accountId", "value": "", "description": "(Required) Account id" } ] }, "description": "Use this resource to create and activate a new workflow definition." }, "response": [ { "id": "0e219610-89d0-45c0-88cd-e6cd95c345d9", "name": "Newly created workflow definition.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"trigger\": \"inbound_sms\",\n \"definition\": {\n \"name\": \"\",\n \"steps\": [\n {\n \"id\": \"\",\n \"stepType\": \"SMS\",\n \"inputs\": {\n \"subAccountId\": \"sed dolore\",\n \"destination\": \"Excepteur incididunt sunt aliqua\",\n \"text\": \"aliqua labore\",\n \"country\": \"laboris ex Excepteur sint\",\n \"source\": \"Dui\",\n \"clientMessageId\": \"enim esse mollit\",\n \"encoding\": \"commodo\",\n \"scheduled\": \"Duis commodo ut\",\n \"expiry\": \"quis consectetur dolore\",\n \"dlrCallbackUrl\": \"mollit veniam ea do\"\n },\n \"outputs\": {\n \"umid\": \"irure\",\n \"status\": \"anim veniam sit\",\n \"description\": \"esse nostrud\",\n \"destination\": \"ut\",\n \"encoding\": \"v\",\n \"clientMessageId\": \"irure amet cillum veniam\"\n },\n \"nextStepId\": \"irure ut dolor\"\n },\n {\n \"id\": \"\",\n \"stepType\": \"SMS\",\n \"inputs\": {\n \"subAccountId\": \"ut non incididunt\",\n \"destination\": \"occaecat eu\",\n \"text\": \"velit in sunt\",\n \"country\": \"laboris nostrud\",\n \"source\": \"Excep\",\n \"clientMessageId\": \"consectetur velit ad sed culpa\",\n \"encoding\": \"et\",\n \"scheduled\": \"eiusmod cupidatat et ut exercitation\",\n \"expiry\": \"aliqua eu\",\n \"dlrCallbackUrl\": \"ut ipsum elit nulla adipisicing\"\n },\n \"outputs\": {\n \"umid\": \"\",\n \"status\": \"commodo in\",\n \"description\": \"eiusmod\",\n \"destination\": \"ex nostrud nisi\",\n \"encoding\": \"in qui aliqua\",\n \"clientMessageId\": \"ea dolor culpa est\"\n },\n \"nextStepId\": \"qui elit esse exercitation sed\"\n }\n ]\n },\n \"subAccountId\": \"\",\n \"status\": \"disabled\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v1/accounts/:accountId/definitions", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "accounts", ":accountId", "definitions" ], "variable": [ { "key": "accountId" } ] } }, "status": "Created", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "Path to the newly created workflow definition", "type": "text/plain" }, "key": "Location", "value": "" } ], "cookie": [], "responseTime": null, "body": "{\n \"accountId\": \"\",\n \"createdAt\": \"\",\n \"definition\": {\n \"name\": \"\",\n \"steps\": [\n {\n \"id\": \"\",\n \"stepType\": \"SMS\",\n \"inputs\": {\n \"subAccountId\": \"elit\",\n \"destination\": \"exercitation adipisicing\",\n \"text\": \"dolor veniam aliquip eu incididunt\",\n \"country\": \"adipisicing officia consequat\",\n \"source\": \"voluptate anim\",\n \"clientMessageId\": \"pariatur cillum qui nulla\",\n \"encoding\": \"dolor nulla anim dolore\",\n \"scheduled\": \"sed ea fugiat\",\n \"expiry\": \"dolor ex\",\n \"dlrCallbackUrl\": \"aliquip voluptate ullamco consectetur\"\n },\n \"outputs\": {\n \"umid\": \"amet dolor fugiat\",\n \"status\": \"sit\",\n \"description\": \"Duis ex sit\",\n \"destination\": \"nulla enim\",\n \"encoding\": \"cillum laboris labore commodo\",\n \"clientMessageId\": \"laborum\"\n },\n \"nextStepId\": \"reprehenderit eiusmod aliqua mollit\"\n },\n {\n \"id\": \"\",\n \"stepType\": \"SMS\",\n \"inputs\": {\n \"subAccountId\": \"incididunt\",\n \"destination\": \"amet dolore ut\",\n \"text\": \"culpa est irure pariatur\",\n \"country\": \"commodo aliqua nisi\",\n \"source\": \"sit ut labore\",\n \"clientMessageId\": \"incididunt deserunt exercitation\",\n \"encoding\": \"ipsum nisi sed\",\n \"scheduled\": \"Ut sit magna\",\n \"expiry\": \"qui\",\n \"dlrCallbackUrl\": \"laboris dolore sunt ipsum ex\"\n },\n \"outputs\": {\n \"umid\": \"sed \",\n \"status\": \"reprehenderit cupidatat\",\n \"description\": \"ullamco pariatur mollit eiusmod\",\n \"destination\": \"incididunt dolor\",\n \"encoding\": \"pariatur ullamco Ut\",\n \"clientMessageId\": \"in\"\n },\n \"nextStepId\": \"amet fugiat ipsum\"\n }\n ]\n },\n \"id\": \"\",\n \"trigger\": \"inbound_chat_apps\",\n \"version\": \"\",\n \"subAccountId\": \"\",\n \"status\": \"disabled\"\n}", "createdAt": "2026-07-28T00:28:13.000Z", "updatedAt": "2026-07-28T00:28:13.000Z", "uid": "35240-0e219610-89d0-45c0-88cd-e6cd95c345d9" }, { "id": "0d79416c-3393-43cf-bc67-b98960c213c6", "name": "Invalid request.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"trigger\": \"inbound_sms\",\n \"definition\": {\n \"name\": \"\",\n \"steps\": [\n {\n \"id\": \"\",\n \"stepType\": \"SMS\",\n \"inputs\": {\n \"subAccountId\": \"sed dolore\",\n \"destination\": \"Excepteur incididunt sunt aliqua\",\n \"text\": \"aliqua labore\",\n \"country\": \"laboris ex Excepteur sint\",\n \"source\": \"Dui\",\n \"clientMessageId\": \"enim esse mollit\",\n \"encoding\": \"commodo\",\n \"scheduled\": \"Duis commodo ut\",\n \"expiry\": \"quis consectetur dolore\",\n \"dlrCallbackUrl\": \"mollit veniam ea do\"\n },\n \"outputs\": {\n \"umid\": \"irure\",\n \"status\": \"anim veniam sit\",\n \"description\": \"esse nostrud\",\n \"destination\": \"ut\",\n \"encoding\": \"v\",\n \"clientMessageId\": \"irure amet cillum veniam\"\n },\n \"nextStepId\": \"irure ut dolor\"\n },\n {\n \"id\": \"\",\n \"stepType\": \"SMS\",\n \"inputs\": {\n \"subAccountId\": \"ut non incididunt\",\n \"destination\": \"occaecat eu\",\n \"text\": \"velit in sunt\",\n \"country\": \"laboris nostrud\",\n \"source\": \"Excep\",\n \"clientMessageId\": \"consectetur velit ad sed culpa\",\n \"encoding\": \"et\",\n \"scheduled\": \"eiusmod cupidatat et ut exercitation\",\n \"expiry\": \"aliqua eu\",\n \"dlrCallbackUrl\": \"ut ipsum elit nulla adipisicing\"\n },\n \"outputs\": {\n \"umid\": \"\",\n \"status\": \"commodo in\",\n \"description\": \"eiusmod\",\n \"destination\": \"ex nostrud nisi\",\n \"encoding\": \"in qui aliqua\",\n \"clientMessageId\": \"ea dolor culpa est\"\n },\n \"nextStepId\": \"qui elit esse exercitation sed\"\n }\n ]\n },\n \"subAccountId\": \"\",\n \"status\": \"disabled\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v1/accounts/:accountId/definitions", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "accounts", ":accountId", "definitions" ], "variable": [ { "key": "accountId" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"errorId\": \"\",\n \"timestamp\": \"\"\n}", "createdAt": "2026-07-28T00:28:13.000Z", "updatedAt": "2026-07-28T00:28:13.000Z", "uid": "35240-0d79416c-3393-43cf-bc67-b98960c213c6" } ], "createdAt": "2026-07-28T00:28:13.000Z", "updatedAt": "2026-07-28T00:28:13.000Z", "uid": "35240-29ceba1e-b557-46db-93a9-d4dcf4f9cd83" } ], "id": "bfde818e-22fe-48e4-a91c-6afd22d60c2a", "createdAt": "2026-07-28T00:28:13.000Z", "updatedAt": "2026-07-28T00:28:13.000Z", "uid": "35240-bfde818e-22fe-48e4-a91c-6afd22d60c2a" }, { "name": "triggers", "item": [ { "name": "http_request", "item": [ { "name": "Trigger workflows using an external event", "id": "d80658bd-848c-4fd2-bc1b-211d65830456", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v1/accounts/:accountId/triggers/http_request?subAccountId=", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "accounts", ":accountId", "triggers", "http_request" ], "query": [ { "description": "Subaccount id to trigger definitions that must be run only for specific subaccounts.", "key": "subAccountId", "value": "" } ], "variable": [ { "id": "88a21b6c-64bf-49a5-9080-55e46fd8a246", "key": "accountId", "value": "", "description": "(Required) Account id" } ] }, "description": "Use this resource to trigger workflows from an external system. Inbound SMS and chat apps message triggers are managed by the automation service. However, if you would like to trigger workflows from an external system like your CRM or ERP application or even a 3rd party system, you can use the `http_request` trigger to do so." }, "response": [ { "id": "799e98ce-38f4-4b50-81f7-15583c37f694", "name": "An event to trigger workflows is successfully raised.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v1/accounts/:accountId/triggers/http_request?subAccountId=", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "accounts", ":accountId", "triggers", "http_request" ], "query": [ { "description": "Subaccount id to trigger definitions that must be run only for specific subaccounts.", "key": "subAccountId", "value": "" } ], "variable": [ { "key": "accountId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T00:28:13.000Z", "updatedAt": "2026-07-28T00:28:13.000Z", "uid": "35240-799e98ce-38f4-4b50-81f7-15583c37f694" } ], "createdAt": "2026-07-28T00:28:13.000Z", "updatedAt": "2026-07-28T00:28:13.000Z", "uid": "35240-d80658bd-848c-4fd2-bc1b-211d65830456" } ], "id": "8ebf9766-3f3b-4d6e-8ab9-3ffca744513c", "createdAt": "2026-07-28T00:28:13.000Z", "updatedAt": "2026-07-28T00:28:13.000Z", "uid": "35240-8ebf9766-3f3b-4d6e-8ab9-3ffca744513c" } ], "id": "259603bf-cedf-4645-bfbc-620b36c7317d", "createdAt": "2026-07-28T00:28:13.000Z", "updatedAt": "2026-07-28T00:28:13.000Z", "uid": "35240-259603bf-cedf-4645-bfbc-620b36c7317d" }, { "name": "steps", "item": [ { "name": "timezones", "item": [ { "name": "Retrieve a list of supported time zones", "id": "40fb34d0-e22c-44e0-8c46-3c2cf6f41626", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/accounts/:accountId/steps/timezones?contains=", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "accounts", ":accountId", "steps", "timezones" ], "query": [ { "description": "Filter time zones by name. For instance, setting the `contains` to \"europe\" lists all time zones with names that contain the string \"europe\" (case insensitive match).", "key": "contains", "value": "" } ], "variable": [ { "id": "a6b9744c-71bd-44ac-9382-105db9fa77c0", "key": "accountId", "value": "", "description": "(Required) Account id" } ] }, "description": "Use this resource to explore supported time zones. Time zones are used as parameters in some of our time related JavaScript helper functions like `IsTimeOfDayBetween(time, start, end, timeZone)`." }, "response": [ { "id": "07bf6d49-1f93-4129-b419-884230778d90", "name": "List of time zones.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v1/accounts/:accountId/steps/timezones?contains=", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "accounts", ":accountId", "steps", "timezones" ], "query": [ { "description": "Filter time zones by name. For instance, setting the `contains` to \"europe\" lists all time zones with names that contain the string \"europe\" (case insensitive match).", "key": "contains", "value": "" } ], "variable": [ { "key": "accountId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "[\n {\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\"\n }\n]", "createdAt": "2026-07-28T00:28:13.000Z", "updatedAt": "2026-07-28T00:28:13.000Z", "uid": "35240-07bf6d49-1f93-4129-b419-884230778d90" } ], "createdAt": "2026-07-28T00:28:13.000Z", "updatedAt": "2026-07-28T00:28:13.000Z", "uid": "35240-40fb34d0-e22c-44e0-8c46-3c2cf6f41626" } ], "id": "4630d683-bf96-474b-aaa9-5b002108bacd", "createdAt": "2026-07-28T00:28:13.000Z", "updatedAt": "2026-07-28T00:28:13.000Z", "uid": "35240-4630d683-bf96-474b-aaa9-5b002108bacd" }, { "name": "functions", "item": [ { "name": "Retrieve a list of supported JavaScript functions", "id": "bdfdbfb9-3f3c-4ef6-89e4-41e4e8f7b048", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/accounts/:accountId/steps/functions", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "accounts", ":accountId", "steps", "functions" ], "variable": [ { "id": "464d5a2d-0733-4525-b441-f7f08a66af69", "key": "accountId", "value": "", "description": "(Required) Account id" } ] }, "description": "Automation supports scripting in inputs, outputs and select next steps using JavaScript (supports most features of ECMAScript 2023). On top of standard functions, we have added some custom functions to make scripting easier for you. Use this resource to explore our custom functions." }, "response": [ { "id": "14df455b-85b2-43ec-bcda-fcde6f8a105d", "name": "List of supported functions.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v1/accounts/:accountId/steps/functions", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "accounts", ":accountId", "steps", "functions" ], "variable": [ { "key": "accountId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "[\n {\n \"name\": \"\",\n \"description\": \"\",\n \"example\": \"\",\n \"parameters\": [\n {\n \"name\": \"\",\n \"type\": \"\",\n \"required\": \"\",\n \"description\": \"\",\n \"example\": {},\n \"default\": {}\n },\n {\n \"name\": \"\",\n \"type\": \"\",\n \"required\": \"\",\n \"description\": \"\",\n \"example\": {},\n \"default\": {}\n }\n ]\n },\n {\n \"name\": \"\",\n \"description\": \"\",\n \"example\": \"\",\n \"parameters\": [\n {\n \"name\": \"\",\n \"type\": \"\",\n \"required\": \"\",\n \"description\": \"\",\n \"example\": {},\n \"default\": {}\n },\n {\n \"name\": \"\",\n \"type\": \"\",\n \"required\": \"\",\n \"description\": \"\",\n \"example\": {},\n \"default\": {}\n }\n ]\n }\n]", "createdAt": "2026-07-28T00:28:13.000Z", "updatedAt": "2026-07-28T00:28:13.000Z", "uid": "35240-14df455b-85b2-43ec-bcda-fcde6f8a105d" } ], "createdAt": "2026-07-28T00:28:13.000Z", "updatedAt": "2026-07-28T00:28:13.000Z", "uid": "35240-bdfdbfb9-3f3c-4ef6-89e4-41e4e8f7b048" } ], "id": "1c765267-a943-4019-9175-f7b234749f1f", "createdAt": "2026-07-28T00:28:13.000Z", "updatedAt": "2026-07-28T00:28:13.000Z", "uid": "35240-1c765267-a943-4019-9175-f7b234749f1f" } ], "id": "f4265ed7-913d-40cf-9bed-92fe2617f533", "createdAt": "2026-07-28T00:28:13.000Z", "updatedAt": "2026-07-28T00:28:13.000Z", "uid": "35240-f4265ed7-913d-40cf-9bed-92fe2617f533" }, { "name": "usage", "item": [ { "name": "history", "item": [ { "name": "Retrieve a list of executed workflow counts by yearly", "id": "eec7e09e-8a29-41a1-ad1b-632ea75ec2d4", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/accounts/:accountId/usage/history", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "accounts", ":accountId", "usage", "history" ], "variable": [ { "id": "6ad582b7-c783-40f7-b923-a405de00c8c7", "key": "accountId", "value": "", "description": "(Required) Account id" } ] }, "description": "API which can be used to fetch usage historical data for Automation service" }, "response": [ { "id": "19683c14-c0c5-42d4-b8e7-63ae05a27eec", "name": "List of supported functions.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v1/accounts/:accountId/usage/history", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "accounts", ":accountId", "usage", "history" ], "variable": [ { "key": "accountId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "[\n {\n \"accountId\": \"\"\n },\n {\n \"accountId\": \"\"\n }\n]", "createdAt": "2026-07-28T00:28:13.000Z", "updatedAt": "2026-07-28T00:28:13.000Z", "uid": "35240-19683c14-c0c5-42d4-b8e7-63ae05a27eec" } ], "createdAt": "2026-07-28T00:28:13.000Z", "updatedAt": "2026-07-28T00:28:13.000Z", "uid": "35240-eec7e09e-8a29-41a1-ad1b-632ea75ec2d4" } ], "id": "c561493f-681f-40fa-8a20-397ecaff6174", "createdAt": "2026-07-28T00:28:13.000Z", "updatedAt": "2026-07-28T00:28:13.000Z", "uid": "35240-c561493f-681f-40fa-8a20-397ecaff6174" }, { "name": "Retrieve the allowed workflow counts and current usage", "id": "221b1ae0-9392-49ef-99db-c290f3e1d9af", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/accounts/:accountId/usage", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "accounts", ":accountId", "usage" ], "variable": [ { "id": "393955e0-7f1e-4336-980b-c5762105a87e", "key": "accountId", "value": "", "description": "(Required) Account id" } ] }, "description": "API which can be used to fetch usage and billing-related information for Automation service" }, "response": [ { "id": "099e1da2-e1ca-4b97-85bc-304809606896", "name": "List of supported functions.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v1/accounts/:accountId/usage", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "accounts", ":accountId", "usage" ], "variable": [ { "key": "accountId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "[\n {\n \"accountId\": \"\"\n },\n {\n \"accountId\": \"\"\n }\n]", "createdAt": "2026-07-28T00:28:13.000Z", "updatedAt": "2026-07-28T00:28:13.000Z", "uid": "35240-099e1da2-e1ca-4b97-85bc-304809606896" } ], "createdAt": "2026-07-28T00:28:13.000Z", "updatedAt": "2026-07-28T00:28:13.000Z", "uid": "35240-221b1ae0-9392-49ef-99db-c290f3e1d9af" } ], "id": "6f510cdc-cf0f-49aa-bd9d-de9463a4924e", "createdAt": "2026-07-28T00:28:13.000Z", "updatedAt": "2026-07-28T00:28:13.000Z", "uid": "35240-6f510cdc-cf0f-49aa-bd9d-de9463a4924e" } ], "id": "79b5978e-c564-41b9-b58c-8b53c197d10d", "createdAt": "2026-07-28T00:28:13.000Z", "updatedAt": "2026-07-28T00:28:13.000Z", "uid": "35240-79b5978e-c564-41b9-b58c-8b53c197d10d" } ], "id": "ab119f05-fee3-4009-a120-9d2e21d91e67", "createdAt": "2026-07-28T00:28:13.000Z", "updatedAt": "2026-07-28T00:28:13.000Z", "uid": "35240-ab119f05-fee3-4009-a120-9d2e21d91e67" } ], "id": "a37767c9-9155-4aee-9032-dbbf764dd49e", "createdAt": "2026-07-28T00:28:13.000Z", "updatedAt": "2026-07-28T00:28:13.000Z", "uid": "35240-a37767c9-9155-4aee-9032-dbbf764dd49e" } ], "id": "e32482ce-3005-491a-ad70-6b8ff505e4ca", "createdAt": "2026-07-28T00:28:13.000Z", "updatedAt": "2026-07-28T00:28:13.000Z", "uid": "35240-e32482ce-3005-491a-ad70-6b8ff505e4ca" } ], "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}", "type": "string" } ] }, "variable": [ { "key": "baseUrl", "value": "https://automation.8x8.com" } ] }