{ "uuid": "80f12009-d1db-4206-98d2-e5a8ba92ea8e", "lastMigration": 29, "name": "Sakari", "endpointPrefix": "v1", "latency": 0, "port": 3000, "hostname": "", "routes": [ { "uuid": "285cce69-f0f8-45f7-b8b5-e9b6c6d3041d", "documentation": "Fetch campaigns", "method": "get", "endpoint": "accounts/:accountId/campaigns", "responses": [ { "uuid": "a7ba98f0-4060-4ee4-a105-65f16dd1b0cf", "body": "{\n \"error\": {\n \"code\": \"\",\n \"message\": \"\"\n },\n \"pagination\": {\n \"limit\": {{faker 'number.int' max=99999}},\n \"offset\": {{faker 'number.int' max=99999}},\n \"totalCount\": {{faker 'number.int' max=99999}}\n },\n \"success\": {{faker 'datatype.boolean'}}\n}", "latency": 0, "statusCode": 200, "label": "successful operation", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "73bab72e-e49e-49ca-8618-a29f8eac028c", "documentation": "Create campaign", "method": "post", "endpoint": "accounts/:accountId/campaigns", "responses": [ { "uuid": "577f708c-13fd-4f48-9d81-415a7e17e47e", "body": "{\n \"data\": {\n \"id\": \"\"\n },\n \"success\": {{faker 'datatype.boolean'}}\n}", "latency": 0, "statusCode": 201, "label": "successful operation", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "59e11ceb-67a6-445c-8584-0332d7d2ec6c", "documentation": "Deletes a campaign", "method": "delete", "endpoint": "accounts/:accountId/campaigns/:campaignId", "responses": [ { "uuid": "8fccb769-dca3-4d95-9085-aaf17705b9a8", "body": "{\n \"success\": {{faker 'datatype.boolean'}}\n}", "latency": 0, "statusCode": 200, "label": "successful operation", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "28de5dcd-9356-4f8d-8f83-5a3716ad3b9c", "documentation": "Fetch campaign by ID", "method": "get", "endpoint": "accounts/:accountId/campaigns/:campaignId", "responses": [ { "uuid": "57c1e02e-222e-4775-a008-0ecfe87336e5", "body": "{\n \"data\": {\n \"id\": \"\"\n },\n \"success\": {{faker 'datatype.boolean'}}\n}", "latency": 0, "statusCode": 200, "label": "successful operation", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "3445595f-f2bc-4a8c-8cb0-9fb42d1dcc1c", "documentation": "Updates a campaign", "method": "put", "endpoint": "accounts/:accountId/campaigns/:campaignId", "responses": [ { "uuid": "daafddbe-fb7a-4829-8695-cc1a6217c5e2", "body": "{\n \"data\": {\n \"id\": \"\"\n },\n \"success\": {{faker 'datatype.boolean'}}\n}", "latency": 0, "statusCode": 200, "label": "successful operation", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "e5e7d799-4a0d-426b-85b1-c84c71404d87", "documentation": "Fetch contacts", "method": "get", "endpoint": "accounts/:accountId/contacts", "responses": [ { "uuid": "56b5705b-8796-4ecc-a7c9-ecb00e46baec", "body": "{\n \"error\": {\n \"code\": \"\",\n \"message\": \"\"\n },\n \"pagination\": {\n \"limit\": {{faker 'number.int' max=99999}},\n \"offset\": {{faker 'number.int' max=99999}},\n \"totalCount\": {{faker 'number.int' max=99999}}\n },\n \"success\": {{faker 'datatype.boolean'}}\n}", "latency": 0, "statusCode": 200, "label": "successful operation", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "600d9349-5a46-45f5-8947-ff59ae3cad27", "documentation": "Create contact", "method": "post", "endpoint": "accounts/:accountId/contacts", "responses": [ { "uuid": "b172b6d4-5f76-46ba-bf67-7ef890897fa2", "body": "\"\"", "latency": 0, "statusCode": 201, "label": "successful operation", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "fcdbce95-9e05-4667-b659-c32ea2848866", "documentation": "Deletes a contact", "method": "delete", "endpoint": "accounts/:accountId/contacts/:contactId", "responses": [ { "uuid": "b964372b-bd28-464f-b624-0b72ed51c194", "body": "{\n \"success\": {{faker 'datatype.boolean'}}\n}", "latency": 0, "statusCode": 200, "label": "successful operation", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "fcd17d63-3e70-4464-8b75-527a45657c1d", "documentation": "Fetch contact by ID", "method": "get", "endpoint": "accounts/:accountId/contacts/:contactId", "responses": [ { "uuid": "23091b41-1930-4213-8d8f-b98146c87c4e", "body": "{\n \"data\": \"\",\n \"success\": true\n}", "latency": 0, "statusCode": 200, "label": "successful operation", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "8102f198-6b02-4c49-9062-93601afbfab3", "documentation": "Updates a contact", "method": "put", "endpoint": "accounts/:accountId/contacts/:contactId", "responses": [ { "uuid": "93d9b4f3-eeb2-4b6c-93fa-5efb914ca32a", "body": "{\n \"data\": \"\",\n \"success\": true\n}", "latency": 0, "statusCode": 200, "label": "successful operation", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "a730885c-5e45-4915-8f96-98b0967bea6b", "documentation": "Fetch conversations", "method": "get", "endpoint": "accounts/:accountId/conversations", "responses": [ { "uuid": "44fda481-d12e-43e4-9aaf-57c52d0798f4", "body": "{\n \"error\": {\n \"code\": \"\",\n \"message\": \"\"\n },\n \"pagination\": {\n \"limit\": {{faker 'number.int' max=99999}},\n \"offset\": {{faker 'number.int' max=99999}},\n \"totalCount\": {{faker 'number.int' max=99999}}\n },\n \"success\": {{faker 'datatype.boolean'}}\n}", "latency": 0, "statusCode": 200, "label": "successful operation", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "8ef302b5-d45c-4c38-88c4-f8c6f3ce11df", "documentation": "Fetch conversation by ID", "method": "get", "endpoint": "accounts/:accountId/conversations/:conversationId", "responses": [ { "uuid": "e29aac10-f2ec-4e47-8601-bc5afb471bac", "body": "{\n \"data\": {\n \"closed\": {{faker 'datatype.boolean'}},\n \"contact\": {\n \"email\": \"chris@sakari.io\",\n \"firstName\": \"Chris\",\n \"id\": \"\",\n \"lastName\": \"Bloggs\",\n \"mobile\": {\n \"country\": \"\",\n \"number\": \"123-456-7890\"\n }\n },\n \"created\": {\n \"at\": \"{{faker 'date.recent' 365}}\",\n \"by\": {\n \"firstName\": \"Joe\",\n \"id\": \"\",\n \"lastName\": \"Bloggs\"\n }\n },\n \"id\": \"\",\n \"lastMessage\": {\n \"contact\": {\n \"email\": \"chris@sakari.io\",\n \"firstName\": \"Chris\",\n \"id\": \"\",\n \"lastName\": \"Bloggs\",\n \"mobile\": {\n \"country\": \"\",\n \"number\": \"123-456-7890\"\n }\n },\n \"conversation\": {\n \"id\": \"\"\n },\n \"created\": {\n \"at\": \"{{faker 'date.recent' 365}}\",\n \"by\": {\n \"firstName\": \"Joe\",\n \"id\": \"\",\n \"lastName\": \"Bloggs\"\n }\n },\n \"error\": {\n \"code\": \"CONT-010\",\n \"description\": \"Contact has requested no further communication\"\n },\n \"id\": \"\",\n \"media\": [\n {\n \"filename\": \"\",\n \"type\": \"\",\n \"url\": \"\"\n }\n ],\n \"message\": \"\",\n \"outgoing\": {{faker 'datatype.boolean'}},\n \"phoneNumber\": \"+1234567890\",\n \"price\": {{faker 'number.int' max=99999}},\n \"read\": {{faker 'datatype.boolean'}},\n \"segments\": {{faker 'number.int' max=99999}},\n \"status\": \"\",\n \"template\": \"\",\n \"updated\": {\n \"at\": \"{{faker 'date.recent' 365}}\",\n \"by\": {\n \"firstName\": \"Joe\",\n \"id\": \"\",\n \"lastName\": \"Bloggs\"\n }\n }\n },\n \"phoneNumber\": {\n \"active\": {{faker 'datatype.boolean'}},\n \"country\": \"\",\n \"number\": \"\"\n },\n \"unread\": [\n \"\"\n ],\n \"updated\": {\n \"at\": \"{{faker 'date.recent' 365}}\",\n \"by\": {\n \"firstName\": \"Joe\",\n \"id\": \"\",\n \"lastName\": \"Bloggs\"\n }\n }\n },\n \"success\": {{faker 'datatype.boolean'}}\n}", "latency": 0, "statusCode": 200, "label": "successful operation", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "158d1a7e-79c1-411c-a63a-f09f3b081d65", "documentation": "Closes a conversation", "method": "put", "endpoint": "accounts/:accountId/conversations/:conversationId/close", "responses": [ { "uuid": "d0b73ae2-9393-49f6-9925-877e731b5f17", "body": "{\n \"data\": {\n \"closed\": {{faker 'datatype.boolean'}},\n \"contact\": {\n \"email\": \"chris@sakari.io\",\n \"firstName\": \"Chris\",\n \"id\": \"\",\n \"lastName\": \"Bloggs\",\n \"mobile\": {\n \"country\": \"\",\n \"number\": \"123-456-7890\"\n }\n },\n \"created\": {\n \"at\": \"{{faker 'date.recent' 365}}\",\n \"by\": {\n \"firstName\": \"Joe\",\n \"id\": \"\",\n \"lastName\": \"Bloggs\"\n }\n },\n \"id\": \"\",\n \"lastMessage\": {\n \"contact\": {\n \"email\": \"chris@sakari.io\",\n \"firstName\": \"Chris\",\n \"id\": \"\",\n \"lastName\": \"Bloggs\",\n \"mobile\": {\n \"country\": \"\",\n \"number\": \"123-456-7890\"\n }\n },\n \"conversation\": {\n \"id\": \"\"\n },\n \"created\": {\n \"at\": \"{{faker 'date.recent' 365}}\",\n \"by\": {\n \"firstName\": \"Joe\",\n \"id\": \"\",\n \"lastName\": \"Bloggs\"\n }\n },\n \"error\": {\n \"code\": \"CONT-010\",\n \"description\": \"Contact has requested no further communication\"\n },\n \"id\": \"\",\n \"media\": [\n {\n \"filename\": \"\",\n \"type\": \"\",\n \"url\": \"\"\n }\n ],\n \"message\": \"\",\n \"outgoing\": {{faker 'datatype.boolean'}},\n \"phoneNumber\": \"+1234567890\",\n \"price\": {{faker 'number.int' max=99999}},\n \"read\": {{faker 'datatype.boolean'}},\n \"segments\": {{faker 'number.int' max=99999}},\n \"status\": \"\",\n \"template\": \"\",\n \"updated\": {\n \"at\": \"{{faker 'date.recent' 365}}\",\n \"by\": {\n \"firstName\": \"Joe\",\n \"id\": \"\",\n \"lastName\": \"Bloggs\"\n }\n }\n },\n \"phoneNumber\": {\n \"active\": {{faker 'datatype.boolean'}},\n \"country\": \"\",\n \"number\": \"\"\n },\n \"unread\": [\n \"\"\n ],\n \"updated\": {\n \"at\": \"{{faker 'date.recent' 365}}\",\n \"by\": {\n \"firstName\": \"Joe\",\n \"id\": \"\",\n \"lastName\": \"Bloggs\"\n }\n }\n },\n \"success\": {{faker 'datatype.boolean'}}\n}", "latency": 0, "statusCode": 200, "label": "successful operation", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "120a3cb2-ad79-4e73-b93e-2264152397a5", "documentation": "Fetch messages", "method": "get", "endpoint": "accounts/:accountId/messages", "responses": [ { "uuid": "a2b603b0-0427-4f2a-8111-df1ac08a6665", "body": "{\n \"error\": {\n \"code\": \"\",\n \"message\": \"\"\n },\n \"pagination\": {\n \"limit\": {{faker 'number.int' max=99999}},\n \"offset\": {{faker 'number.int' max=99999}},\n \"totalCount\": {{faker 'number.int' max=99999}}\n },\n \"success\": {{faker 'datatype.boolean'}}\n}", "latency": 0, "statusCode": 200, "label": "successful operation", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "a7818372-64e1-4bcc-99b3-c9576bc8a18a", "documentation": "Send Messages", "method": "post", "endpoint": "accounts/:accountId/messages", "responses": [ { "uuid": "880356ca-d8d3-4f38-b081-688f391c2220", "body": "{\n \"data\": {\n \"estimatedPrice\": {{faker 'number.float'}},\n \"jobId\": \"\",\n \"messages\": [\n {\n \"contact\": {\n \"email\": \"chris@sakari.io\",\n \"firstName\": \"Chris\",\n \"id\": \"\",\n \"lastName\": \"Bloggs\",\n \"mobile\": {\n \"country\": \"\",\n \"number\": \"123-456-7890\"\n }\n },\n \"conversation\": {\n \"id\": \"\"\n },\n \"created\": {\n \"at\": \"{{faker 'date.recent' 365}}\",\n \"by\": {\n \"firstName\": \"Joe\",\n \"id\": \"\",\n \"lastName\": \"Bloggs\"\n }\n },\n \"error\": {\n \"code\": \"CONT-010\",\n \"description\": \"Contact has requested no further communication\"\n },\n \"id\": \"\",\n \"media\": [\n {\n \"filename\": \"\",\n \"type\": \"\",\n \"url\": \"\"\n }\n ],\n \"message\": \"\",\n \"outgoing\": {{faker 'datatype.boolean'}},\n \"phoneNumber\": \"+1234567890\",\n \"price\": {{faker 'number.int' max=99999}},\n \"read\": {{faker 'datatype.boolean'}},\n \"segments\": {{faker 'number.int' max=99999}},\n \"status\": \"\",\n \"template\": \"\",\n \"updated\": {\n \"at\": \"{{faker 'date.recent' 365}}\",\n \"by\": {\n \"firstName\": \"Joe\",\n \"id\": \"\",\n \"lastName\": \"Bloggs\"\n }\n }\n }\n ],\n \"queued\": {{faker 'number.int' max=99999}}\n }\n}", "latency": 0, "statusCode": 200, "label": "successful operation", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "3bd10893-e6d8-4498-a66d-c1d5f20e83bc", "documentation": "Fetch message by id", "method": "get", "endpoint": "accounts/:accountId/messages/:messageId", "responses": [ { "uuid": "0ed7fba4-5ee9-462f-a7a0-9d0323f2e4b2", "body": "{\n \"data\": {\n \"contact\": {\n \"email\": \"chris@sakari.io\",\n \"firstName\": \"Chris\",\n \"id\": \"\",\n \"lastName\": \"Bloggs\",\n \"mobile\": {\n \"country\": \"\",\n \"number\": \"123-456-7890\"\n }\n },\n \"conversation\": {\n \"id\": \"\"\n },\n \"created\": {\n \"at\": \"{{faker 'date.recent' 365}}\",\n \"by\": {\n \"firstName\": \"Joe\",\n \"id\": \"\",\n \"lastName\": \"Bloggs\"\n }\n },\n \"error\": {\n \"code\": \"CONT-010\",\n \"description\": \"Contact has requested no further communication\"\n },\n \"id\": \"\",\n \"media\": [\n {\n \"filename\": \"\",\n \"type\": \"\",\n \"url\": \"\"\n }\n ],\n \"message\": \"\",\n \"outgoing\": {{faker 'datatype.boolean'}},\n \"phoneNumber\": \"+1234567890\",\n \"price\": {{faker 'number.int' max=99999}},\n \"read\": {{faker 'datatype.boolean'}},\n \"segments\": {{faker 'number.int' max=99999}},\n \"status\": \"\",\n \"template\": \"\",\n \"updated\": {\n \"at\": \"{{faker 'date.recent' 365}}\",\n \"by\": {\n \"firstName\": \"Joe\",\n \"id\": \"\",\n \"lastName\": \"Bloggs\"\n }\n }\n },\n \"success\": {{faker 'datatype.boolean'}}\n}", "latency": 0, "statusCode": 200, "label": "successful operation", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "8b633646-0107-4207-aae4-4ae7a886d88b", "documentation": "Fetch templates", "method": "get", "endpoint": "accounts/:accountId/templates", "responses": [ { "uuid": "13b93a37-386d-4129-bd24-c3d55a94819d", "body": "{\n \"error\": {\n \"code\": \"\",\n \"message\": \"\"\n },\n \"pagination\": {\n \"limit\": {{faker 'number.int' max=99999}},\n \"offset\": {{faker 'number.int' max=99999}},\n \"totalCount\": {{faker 'number.int' max=99999}}\n },\n \"success\": {{faker 'datatype.boolean'}}\n}", "latency": 0, "statusCode": 200, "label": "successful operation", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "ee704d90-76cf-4b56-9cff-6d96bf6e395a", "documentation": "Create template", "method": "post", "endpoint": "accounts/:accountId/templates", "responses": [ { "uuid": "9408e195-f4bc-432b-8a04-c45746dde167", "body": "{\n \"error\": {\n \"code\": \"\",\n \"message\": \"\"\n },\n \"pagination\": {\n \"limit\": {{faker 'number.int' max=99999}},\n \"offset\": {{faker 'number.int' max=99999}},\n \"totalCount\": {{faker 'number.int' max=99999}}\n },\n \"success\": {{faker 'datatype.boolean'}}\n}", "latency": 0, "statusCode": 201, "label": "successful operation", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "1186c991-dc68-4941-ada0-c1930e3206c9", "documentation": "Deletes a template", "method": "delete", "endpoint": "accounts/:accountId/templates/:templateId", "responses": [ { "uuid": "f9ed4336-3657-4714-a53e-b3ef5806ffc2", "body": "{\n \"success\": {{faker 'datatype.boolean'}}\n}", "latency": 0, "statusCode": 200, "label": "successful operation", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "740d451a-9700-4e45-bacf-7f9b1f83b85e", "documentation": "Fetch template by ID", "method": "get", "endpoint": "accounts/:accountId/templates/:templateId", "responses": [ { "uuid": "ff4a3e6f-ae51-4386-9784-faa58a447fa8", "body": "{\n \"data\": {\n \"name\": \"\",\n \"template\": \"Hi {{{firstName}}}. Grab 20% off today only at ABC Shoes\",\n \"type\": \"{{oneOf (array 'SMS' 'Web')}}\"\n },\n \"success\": {{faker 'datatype.boolean'}}\n}", "latency": 0, "statusCode": 200, "label": "successful operation", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "ca7e6c47-fd99-45ef-abc1-dc2e810b5ee0", "documentation": "Updates a template", "method": "put", "endpoint": "accounts/:accountId/templates/:templateId", "responses": [ { "uuid": "a53c070e-9780-47dc-9ecd-58f9dd072356", "body": "{\n \"data\": {\n \"name\": \"\",\n \"template\": \"Hi {{{firstName}}}. Grab 20% off today only at ABC Shoes\",\n \"type\": \"{{oneOf (array 'SMS' 'Web')}}\"\n },\n \"success\": {{faker 'datatype.boolean'}}\n}", "latency": 0, "statusCode": 200, "label": "successful operation", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "d5177c2f-f793-4ca3-ae4c-e21c4dd3fa33", "documentation": "Fetch active webhooks", "method": "get", "endpoint": "accounts/:accountId/webhooks", "responses": [ { "uuid": "6e36bac3-96f6-432b-8efc-2b65b5da7647", "body": "{\n \"error\": {\n \"code\": \"\",\n \"message\": \"\"\n },\n \"pagination\": {\n \"limit\": {{faker 'number.int' max=99999}},\n \"offset\": {{faker 'number.int' max=99999}},\n \"totalCount\": {{faker 'number.int' max=99999}}\n },\n \"success\": {{faker 'datatype.boolean'}}\n}", "latency": 0, "statusCode": 200, "label": "successful operation", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "362d1be3-95f6-4d44-9328-a1de5bbac042", "documentation": "Subscribe to message events", "method": "post", "endpoint": "accounts/:accountId/webhooks", "responses": [ { "uuid": "6fbde65d-803d-42f7-8cbc-a13ec80c048d", "body": "{\n \"data\": {\n \"eventTypes\": [\n \"{{oneOf (array 'message-received' 'message-status' 'message-sent' 'conversation-closed' 'contact-created' 'contact-updated' 'contact-removed')}}\"\n ],\n \"url\": \"\"\n },\n \"success\": {{faker 'datatype.boolean'}}\n}", "latency": 0, "statusCode": 200, "label": "successful operation", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "d9a87b9a-9235-4fa5-a24a-ce6d7be7e185", "documentation": "Unsubscribe to message events", "method": "delete", "endpoint": "accounts/:accountId/webhooks/:url", "responses": [ { "uuid": "e538a962-33c4-41d7-9bb2-eb84050ebaec", "body": "", "latency": 0, "statusCode": 204, "label": "successful operation", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "c0f7e4d0-5d1f-423f-815c-c48dd5875a0e", "documentation": "Get token for accessing APIs", "method": "post", "endpoint": "oauth2/token", "responses": [ { "uuid": "7cdbcf6c-ea35-4329-88e0-f8e74f3adfa8", "body": "{\n \"access_token\": \"\",\n \"token_type\": \"\"\n}", "latency": 0, "statusCode": 200, "label": "successful operation", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "571f3a3a-a98a-425d-9993-1e91e7ee5de8", "documentation": "Share file - use to host a file and generate a short link to be used directly in a message or as a link to media for a MMS", "method": "post", "endpoint": "tools/sharefile", "responses": [ { "uuid": "7e383670-f57c-40cc-b7c1-ae0b0c3a74b2", "body": "{\n \"data\": {\n \"expires\": \"{{faker 'date.recent' 365}}\",\n \"link\": \"\"\n },\n \"success\": {{faker 'datatype.boolean'}}\n}", "latency": 0, "statusCode": 200, "label": "successful operation", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" } ], "proxyMode": false, "proxyHost": "", "proxyRemovePrefix": false, "tlsOptions": { "enabled": false, "type": "CERT", "pfxPath": "", "certPath": "", "keyPath": "", "caPath": "", "passphrase": "" }, "cors": true, "headers": [], "proxyReqHeaders": [{ "key": "", "value": "" }], "proxyResHeaders": [{ "key": "", "value": "" }], "data": [], "folders": [], "rootChildren": [ { "type": "route", "uuid": "285cce69-f0f8-45f7-b8b5-e9b6c6d3041d" }, { "type": "route", "uuid": "73bab72e-e49e-49ca-8618-a29f8eac028c" }, { "type": "route", "uuid": "59e11ceb-67a6-445c-8584-0332d7d2ec6c" }, { "type": "route", "uuid": "28de5dcd-9356-4f8d-8f83-5a3716ad3b9c" }, { "type": "route", "uuid": "3445595f-f2bc-4a8c-8cb0-9fb42d1dcc1c" }, { "type": "route", "uuid": "e5e7d799-4a0d-426b-85b1-c84c71404d87" }, { "type": "route", "uuid": "600d9349-5a46-45f5-8947-ff59ae3cad27" }, { "type": "route", "uuid": "fcdbce95-9e05-4667-b659-c32ea2848866" }, { "type": "route", "uuid": "fcd17d63-3e70-4464-8b75-527a45657c1d" }, { "type": "route", "uuid": "8102f198-6b02-4c49-9062-93601afbfab3" }, { "type": "route", "uuid": "a730885c-5e45-4915-8f96-98b0967bea6b" }, { "type": "route", "uuid": "8ef302b5-d45c-4c38-88c4-f8c6f3ce11df" }, { "type": "route", "uuid": "158d1a7e-79c1-411c-a63a-f09f3b081d65" }, { "type": "route", "uuid": "120a3cb2-ad79-4e73-b93e-2264152397a5" }, { "type": "route", "uuid": "a7818372-64e1-4bcc-99b3-c9576bc8a18a" }, { "type": "route", "uuid": "3bd10893-e6d8-4498-a66d-c1d5f20e83bc" }, { "type": "route", "uuid": "8b633646-0107-4207-aae4-4ae7a886d88b" }, { "type": "route", "uuid": "ee704d90-76cf-4b56-9cff-6d96bf6e395a" }, { "type": "route", "uuid": "1186c991-dc68-4941-ada0-c1930e3206c9" }, { "type": "route", "uuid": "740d451a-9700-4e45-bacf-7f9b1f83b85e" }, { "type": "route", "uuid": "ca7e6c47-fd99-45ef-abc1-dc2e810b5ee0" }, { "type": "route", "uuid": "d5177c2f-f793-4ca3-ae4c-e21c4dd3fa33" }, { "type": "route", "uuid": "362d1be3-95f6-4d44-9328-a1de5bbac042" }, { "type": "route", "uuid": "d9a87b9a-9235-4fa5-a24a-ce6d7be7e185" }, { "type": "route", "uuid": "c0f7e4d0-5d1f-423f-815c-c48dd5875a0e" }, { "type": "route", "uuid": "571f3a3a-a98a-425d-9993-1e91e7ee5de8" } ] }