{ "uuid": "fb01e2d8-6c21-4d8d-a6d5-32cdc642787e", "lastMigration": 29, "name": "External Accounts API", "endpointPrefix": "beta/chatapp-accounts", "latency": 0, "port": 3000, "hostname": "", "routes": [ { "uuid": "469144d9-1058-4ca6-a5a0-b12c270778dd", "documentation": "Retrieve all accounts you own", "method": "get", "endpoint": "", "responses": [ { "uuid": "9303d3e7-dbbb-4056-8a97-b2fc6626d40f", "body": "{\n \"_embedded\": [\n {\n \"access_token\": \"myAccessToken\",\n \"api_key\": \"abcd1234\",\n \"applications\": [\n \"optionalApplicationId\"\n ],\n \"external_id\": \"12345678\",\n \"name\": \"optionalName\",\n \"provider\": \"messenger\"\n }\n ],\n \"_links\": {\n \"first\": {\n \"href\": \"https://api.nexmo.com/beta/chatapp-accounts?page_number=1&page_size=10\"\n },\n \"last\": {\n \"href\": \"https://api.nexmo.com/beta/chatapp-accounts?page_number=4&page_size=10\"\n },\n \"next\": {\n \"href\": \"https://api.nexmo.com/beta/chatapp-accounts?page_number=3&page_size=10\"\n },\n \"prev\": {\n \"href\": \"https://api.nexmo.com/beta/chatapp-accounts?page_number=1&page_size=10\"\n },\n \"self\": {\n \"href\": \"https://api.nexmo.com/beta/chatapp-accounts?page_number=1&page_size=10\"\n }\n },\n \"page_number\": 1,\n \"page_size\": 10\n}", "latency": 0, "statusCode": 200, "label": "OK.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "67d67595-8a2b-4e63-9861-0e267bfa8362", "body": "{\n \"detail\": \"Request header 'Authorization' missing / Invalid Token\",\n \"title\": \"Unauthorised\"\n}", "latency": 0, "statusCode": 401, "label": "Unauthorized.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "be89fe1c-ff34-4b43-9fb8-2cdf80afa125", "documentation": "Create a Messenger account", "method": "post", "endpoint": "messenger", "responses": [ { "uuid": "c7f88100-e40c-400e-8dee-49459ca2e760", "body": "{\n \"access_token\": \"myAccessToken\",\n \"api_key\": \"abcd1234\",\n \"applications\": [\n \"optionalApplicationId\"\n ],\n \"external_id\": \"12345678\",\n \"name\": \"optionalName\",\n \"provider\": \"messenger\"\n}", "latency": 0, "statusCode": 201, "label": "Created.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "51b2b862-7a95-46c2-a842-3eb688a3d1e3", "body": "{\n \"detail\": \"Found errors validating 1 of your submitted parameters.\",\n \"instance\": \"\",\n \"invalid_params\": [\n {\n \"name\": \"external_id\",\n \"reason\": \"Missing `external_id` field\"\n }\n ],\n \"title\": \"Your request parameters didn't validate.\",\n \"type\": \"https://www.nexmo.com/messages/Errors#InvalidParams\"\n}", "latency": 0, "statusCode": 400, "label": "Bad Request.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "f20431e1-bd84-4364-9a30-79236e73d23e", "body": "{\n \"detail\": \"Request header 'Authorization' missing / Invalid Token\",\n \"title\": \"Unauthorised\"\n}", "latency": 0, "statusCode": 401, "label": "Unauthorized.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "2c700115-f937-4800-b754-59c63b2097da", "body": "{\n \"title\": \"Wrong authentication - You are not authorised to access this resource\"\n}", "latency": 0, "statusCode": 403, "label": "Forbidden.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "e1d712af-3269-4ab9-ab5e-ff434c9e74f0", "documentation": "Delete a Messenger account", "method": "delete", "endpoint": "messenger/:external_id", "responses": [ { "uuid": "46f315a6-e3bd-47aa-844f-62203661696a", "body": "", "latency": 0, "statusCode": 204, "label": "No Content.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "f2690a12-0289-4fd6-a84b-e8e7c687de1a", "body": "{\n \"detail\": \"Request header 'Authorization' missing / Invalid Token\",\n \"title\": \"Unauthorised\"\n}", "latency": 0, "statusCode": 401, "label": "Unauthorized.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "8e635d38-b703-457a-92d2-743c581d9e2d", "body": "{\n \"title\": \"Wrong authentication - You are not authorised to access this resource\"\n}", "latency": 0, "statusCode": 403, "label": "Forbidden.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "5526f0e6-5e35-4cd2-9fbd-0339f454172f", "body": "", "latency": 0, "statusCode": 404, "label": "Not Found.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "56e90c90-27ee-46d6-810a-708e328a8c2d", "documentation": "Retrieve a Messenger account", "method": "get", "endpoint": "messenger/:external_id", "responses": [ { "uuid": "5f2e3e64-6e08-4804-a44c-f8182a925f16", "body": "{\n \"access_token\": \"myAccessToken\",\n \"api_key\": \"abcd1234\",\n \"applications\": [\n \"optionalApplicationId\"\n ],\n \"external_id\": \"12345678\",\n \"name\": \"optionalName\",\n \"provider\": \"messenger\"\n}", "latency": 0, "statusCode": 200, "label": "OK.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "0845132d-6600-45a2-b7d1-0685a0af7279", "body": "{\n \"detail\": \"Request header 'Authorization' missing / Invalid Token\",\n \"title\": \"Unauthorised\"\n}", "latency": 0, "statusCode": 401, "label": "Unauthorized.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "93e40544-a5bf-4aca-bd55-1bb93eec1f0f", "body": "", "latency": 0, "statusCode": 404, "label": "Not Found.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "f5881ba9-96ce-484f-a940-e0a6da271429", "documentation": "Update a Messenger account", "method": "patch", "endpoint": "messenger/:external_id", "responses": [ { "uuid": "64efbce4-9149-4702-96bf-eb5d7e63467b", "body": "{\n \"access_token\": \"updatedAccessToken\",\n \"api_key\": \"abcd1234\",\n \"applications\": [\n \"newApplicationId\"\n ],\n \"external_id\": \"12345678\",\n \"name\": \"newName\",\n \"provider\": \"messenger\"\n}", "latency": 0, "statusCode": 200, "label": "OK.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "eb14d4e8-c2b4-4125-8ec0-d3da39db7dec", "body": "{\n \"detail\": \"Found errors validating 1 of your submitted parameters.\",\n \"instance\": \"\",\n \"invalid_params\": [\n {\n \"name\": \"external_id\",\n \"reason\": \"'external_id' parameter cannot be changed\"\n }\n ],\n \"title\": \"Your request parameters didn't validate.\",\n \"type\": \"https://www.nexmo.com/messages/Errors#InvalidParams\"\n}", "latency": 0, "statusCode": 400, "label": "Bad Request.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "294dbdfc-0a6d-43e6-82dd-92f68df5d0f6", "body": "{\n \"detail\": \"Request header 'Authorization' missing / Invalid Token\",\n \"title\": \"Unauthorised\"\n}", "latency": 0, "statusCode": 401, "label": "Unauthorized.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "acc41b2b-5598-44f9-a80c-a30e6692a022", "body": "{\n \"title\": \"Wrong authentication - You are not authorised to access this resource\"\n}", "latency": 0, "statusCode": 403, "label": "Forbidden.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "fef51ec1-2651-46ca-b72a-9d4ffc95621c", "body": "", "latency": 0, "statusCode": 404, "label": "Not Found.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "a21ad353-a41c-41b9-b68a-76fa5505467f", "documentation": "Retrieve a Viber Service Message account", "method": "get", "endpoint": "viber_service_msg/:external_id", "responses": [ { "uuid": "b2ea5f53-4954-4697-92cb-e8e3b56fe0ad", "body": "{\n \"api_key\": \"abcd1234\",\n \"applications\": [\n \"optionalApplicationId\"\n ],\n \"external_id\": \"12345678\",\n \"name\": \"optionalName\",\n \"provider\": \"viber_service_msg\"\n}", "latency": 0, "statusCode": 200, "label": "OK.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "86ab6fbc-f27f-488f-90b7-4f807be03e54", "body": "{\n \"detail\": \"Request header 'Authorization' missing / Invalid Token\",\n \"title\": \"Unauthorised\"\n}", "latency": 0, "statusCode": 401, "label": "Unauthorized.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "bfbb4896-6159-4f40-b724-8551f599868b", "body": "", "latency": 0, "statusCode": 404, "label": "Not Found.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "88d2b6c8-2494-4ccd-a744-08fb8d4b2dc7", "documentation": "Retrieve a Whatsapp account", "method": "get", "endpoint": "whatsapp/:external_id", "responses": [ { "uuid": "4e758512-341b-467b-9d61-8e2ed743a4ed", "body": "{\n \"api_key\": \"abcd1234\",\n \"applications\": [\n \"optionalApplicationId\"\n ],\n \"external_id\": \"12345678\",\n \"name\": \"optionalName\",\n \"provider\": \"whatsapp\"\n}", "latency": 0, "statusCode": 200, "label": "OK.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "c5b4b6a6-37a6-4a26-9434-fedf376a2d62", "body": "{\n \"detail\": \"Request header 'Authorization' missing / Invalid Token\",\n \"title\": \"Unauthorised\"\n}", "latency": 0, "statusCode": 401, "label": "Unauthorized.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "eb8c1fc1-65fd-4bdc-8cf8-091c904dc254", "body": "", "latency": 0, "statusCode": 404, "label": "Not Found.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "ba671b75-678f-4714-b8e5-0b2a0dbbae9f", "documentation": "Link application to an account", "method": "post", "endpoint": ":provider/:external_id/applications", "responses": [ { "uuid": "bbdd6995-8576-4176-9260-438c94702a71", "body": "{\n \"access_token\": \"accessToken\",\n \"api_key\": \"abcd1234\",\n \"applications\": [\n \"applicationId\"\n ],\n \"external_id\": \"12345678\",\n \"name\": \"name\",\n \"provider\": \"{{oneOf (array 'messenger' 'viber_service_msg' 'whatsapp')}}\"\n}", "latency": 0, "statusCode": 200, "label": "OK.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "f0884bf2-5c64-4c5e-a117-85e3a14ff9b3", "body": "{\n \"detail\": \"Request header 'Authorization' missing / Invalid Token\",\n \"title\": \"Unauthorised\"\n}", "latency": 0, "statusCode": 401, "label": "Unauthorized.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "c590d3fa-defc-4d19-aba4-9d83845c832f", "body": "{\n \"detail\": \"Cannot link application\",\n \"title\": \"Forbidden\",\n \"type\": \"https://www.nexmo.com/messages/Errors#Forbidden\"\n}", "latency": 0, "statusCode": 403, "label": "Forbidden.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "135c60d9-7f75-49e8-8466-877dc6f1e618", "body": "{\n \"detail\": \"Unable to link application\",\n \"title\": \"Application conflict\",\n \"type\": \"https://www.nexmo.com/messages/Errors#Conflict\"\n}", "latency": 0, "statusCode": 409, "label": "Conflict.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "e84db809-3441-4f34-848c-86c0bbc805a9", "documentation": "Unlink application from an account", "method": "delete", "endpoint": ":provider/:external_id/applications/:application_id", "responses": [ { "uuid": "b675af76-0aa7-4079-82a8-000536e516cf", "body": "", "latency": 0, "statusCode": 204, "label": "No Content.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "0ed00fe5-e2de-4590-93b9-91c271e4c9dd", "body": "{\n \"detail\": \"Request header 'Authorization' missing / Invalid Token\",\n \"title\": \"Unauthorised\"\n}", "latency": 0, "statusCode": 401, "label": "Unauthorized.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "762f1b91-2a4b-46bc-9774-39682e8433f9", "body": "{\n \"detail\": \"Cannot unlink application\",\n \"title\": \"Forbidden\",\n \"type\": \"https://www.nexmo.com/messages/Errors#Forbidden\"\n}", "latency": 0, "statusCode": 403, "label": "Forbidden.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "92bcf3cd-9c0d-4e81-b0bd-8193ea42e808", "body": "{\n \"detail\": \"Unable to unlink application\",\n \"title\": \"Application conflict\",\n \"type\": \"https://www.nexmo.com/messages/Errors#Conflict\"\n}", "latency": 0, "statusCode": 409, "label": "Conflict.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "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": "469144d9-1058-4ca6-a5a0-b12c270778dd" }, { "type": "route", "uuid": "be89fe1c-ff34-4b43-9fb8-2cdf80afa125" }, { "type": "route", "uuid": "e1d712af-3269-4ab9-ab5e-ff434c9e74f0" }, { "type": "route", "uuid": "56e90c90-27ee-46d6-810a-708e328a8c2d" }, { "type": "route", "uuid": "f5881ba9-96ce-484f-a940-e0a6da271429" }, { "type": "route", "uuid": "a21ad353-a41c-41b9-b68a-76fa5505467f" }, { "type": "route", "uuid": "88d2b6c8-2494-4ccd-a744-08fb8d4b2dc7" }, { "type": "route", "uuid": "ba671b75-678f-4714-b8e5-0b2a0dbbae9f" }, { "type": "route", "uuid": "e84db809-3441-4f34-848c-86c0bbc805a9" } ] }