{ "info": { "_postman_id": "6ffbe53e-37b3-4538-bfed-a819a724ab34", "name": "Contacts API", "description": "Contacts API v1\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:34.000Z", "updatedAt": "2026-07-28T00:28:34.000Z", "lastUpdatedBy": "35240", "uid": "35240-6ffbe53e-37b3-4538-bfed-a819a724ab34" }, "item": [ { "name": "api", "item": [ { "name": "v1", "item": [ { "name": "accounts", "item": [ { "name": "{accountId}", "item": [ { "name": "contacts", "item": [ { "name": "blacklist", "item": [ { "name": "{msisdn}", "item": [ { "name": "Blacklist msisdn for a specific account", "id": "f44edcca-27db-4945-b413-ab6a10e790e1", "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/contacts/blacklist/:msisdn", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "accounts", ":accountId", "contacts", "blacklist", ":msisdn" ], "variable": [ { "id": "d482ac5b-76a8-4f93-aeb4-570b5143fc0b", "key": "accountId", "value": "c06f25f2a7ff-B3a496aD-AB1B0CcbC7de", "description": "(Required) You must replace *{accountId}* with the accountid that you want to use." }, { "id": "be17c0c9-8ba1-4a9c-af6d-4b9a6fdea634", "key": "msisdn", "value": "", "description": "(Required) Msisdn to blacklist" } ] } }, "response": [ { "id": "4991f11b-b2b6-4243-a040-9c2a848a89cd", "name": "OK", "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/contacts/blacklist/:msisdn", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "accounts", ":accountId", "contacts", "blacklist", ":msisdn" ], "variable": [ { "key": "accountId" }, { "key": "msisdn" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T00:28:34.000Z", "updatedAt": "2026-07-28T00:28:34.000Z", "uid": "35240-4991f11b-b2b6-4243-a040-9c2a848a89cd" }, { "id": "e5734ed9-0f0c-4cf8-bdbd-1514a7debbfa", "name": "Bad request error response", "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/contacts/blacklist/:msisdn", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "accounts", ":accountId", "contacts", "blacklist", ":msisdn" ], "variable": [ { "key": "accountId" }, { "key": "msisdn" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"code\": \"\",\n \"errorId\": \"\",\n \"timestamp\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-07-28T00:28:34.000Z", "updatedAt": "2026-07-28T00:28:34.000Z", "uid": "35240-e5734ed9-0f0c-4cf8-bdbd-1514a7debbfa" }, { "id": "fc194672-5405-4dcc-ae47-eb92c8f3b9d6", "name": "Request was not authenticated response", "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/contacts/blacklist/:msisdn", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "accounts", ":accountId", "contacts", "blacklist", ":msisdn" ], "variable": [ { "key": "accountId" }, { "key": "msisdn" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"code\": \"\",\n \"errorId\": \"\",\n \"timestamp\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-07-28T00:28:34.000Z", "updatedAt": "2026-07-28T00:28:34.000Z", "uid": "35240-fc194672-5405-4dcc-ae47-eb92c8f3b9d6" } ], "createdAt": "2026-07-28T00:28:34.000Z", "updatedAt": "2026-07-28T00:28:34.000Z", "uid": "35240-f44edcca-27db-4945-b413-ab6a10e790e1" } ], "id": "920a922a-6d6e-48e0-95c2-6014b82ed871", "createdAt": "2026-07-28T00:28:34.000Z", "updatedAt": "2026-07-28T00:28:34.000Z", "uid": "35240-920a922a-6d6e-48e0-95c2-6014b82ed871" } ], "id": "6e4b180a-5c0d-411a-a44d-c9c480acba85", "createdAt": "2026-07-28T00:28:34.000Z", "updatedAt": "2026-07-28T00:28:34.000Z", "uid": "35240-6e4b180a-5c0d-411a-a44d-c9c480acba85" }, { "name": "{contactId}", "item": [ { "name": "Get contact information by id", "id": "f90f9ebd-eb2c-4844-b2cf-24a9657ebd2d", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/accounts/:accountId/contacts/:contactId", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "accounts", ":accountId", "contacts", ":contactId" ], "variable": [ { "id": "309eecb9-ffb4-4433-b9be-851c1d791a47", "key": "accountId", "value": "c06f25f2a7ff-B3a496aD-AB1B0CcbC7de", "description": "(Required) You must replace *{accountId}* with the accountid that you want to use." }, { "id": "4b6225a0-2590-4e67-b2cf-eef2329b5c6e", "key": "contactId", "value": "", "description": "(Required) Contact Id" } ] }, "description": "Get contact information by contact id" }, "response": [ { "id": "bbb821ab-2c07-4656-9398-44cfef3ff2e6", "name": "OK", "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/contacts/:contactId", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "accounts", ":accountId", "contacts", ":contactId" ], "variable": [ { "key": "accountId" }, { "key": "contactId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"id\": \"\",\n \"addresses\": {\n \"msisdn\": \"+6687066623696\",\n \"weChatUserId\": \"\",\n \"facebookUserId\": \"\",\n \"email\": \"\",\n \"zaloId\": \"\",\n \"lineId\": \"\",\n \"kakaoTalkId\": \"\"\n },\n \"createdAt\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"externalId\": \"\",\n \"country\": \"\",\n \"groups\": [\n {\n \"id\": \"\",\n \"contacts\": \"\",\n \"createdAt\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"isBlacklist\": \"\"\n }\n ],\n \"customAttributes\": {}\n}", "createdAt": "2026-07-28T00:28:34.000Z", "updatedAt": "2026-07-28T00:28:34.000Z", "uid": "35240-bbb821ab-2c07-4656-9398-44cfef3ff2e6" }, { "id": "a9cac5ec-42ef-4dfd-8d00-cedef96cdade", "name": "The entity doesn't exist", "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/contacts/:contactId", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "accounts", ":accountId", "contacts", ":contactId" ], "variable": [ { "key": "accountId" }, { "key": "contactId" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"code\": \"\",\n \"errorId\": \"\",\n \"timestamp\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-07-28T00:28:34.000Z", "updatedAt": "2026-07-28T00:28:34.000Z", "uid": "35240-a9cac5ec-42ef-4dfd-8d00-cedef96cdade" } ], "createdAt": "2026-07-28T00:28:34.000Z", "updatedAt": "2026-07-28T00:28:34.000Z", "uid": "35240-f90f9ebd-eb2c-4844-b2cf-24a9657ebd2d" }, { "name": "Delete single contact", "id": "58a78209-bcab-48cf-87d1-711f5ca4f6f6", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "DELETE", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/accounts/:accountId/contacts/:contactId", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "accounts", ":accountId", "contacts", ":contactId" ], "variable": [ { "id": "6820b9f8-09a7-44c2-8232-eb4c60cd8f1a", "key": "accountId", "value": "c06f25f2a7ff-B3a496aD-AB1B0CcbC7de", "description": "(Required) You must replace *{accountId}* with the accountid that you want to use." }, { "id": "378de479-513f-4b35-b5a4-cf31fcbe4161", "key": "contactId", "value": "", "description": "(Required) Contact Id" } ] }, "description": "Delete single contact by id" }, "response": [ { "id": "53a746fc-fed7-40fa-9e11-781d920ad862", "name": "No Content", "originalRequest": { "method": "DELETE", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v1/accounts/:accountId/contacts/:contactId", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "accounts", ":accountId", "contacts", ":contactId" ], "variable": [ { "key": "accountId" }, { "key": "contactId" } ] } }, "status": "No Content", "code": 204, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T00:28:34.000Z", "updatedAt": "2026-07-28T00:28:34.000Z", "uid": "35240-53a746fc-fed7-40fa-9e11-781d920ad862" } ], "createdAt": "2026-07-28T00:28:34.000Z", "updatedAt": "2026-07-28T00:28:34.000Z", "uid": "35240-58a78209-bcab-48cf-87d1-711f5ca4f6f6" }, { "name": "Update contact information", "id": "a60fc84d-11ca-4dce-8c67-8d402976622f", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "[\n {\n \"op\": \"test\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"move\",\n \"path\": \"\",\n \"value\": \"\"\n }\n]", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v1/accounts/:accountId/contacts/:contactId", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "accounts", ":accountId", "contacts", ":contactId" ], "variable": [ { "id": "e84bdfe6-3d75-4251-b94f-acb9f001df74", "key": "accountId", "value": "c06f25f2a7ff-B3a496aD-AB1B0CcbC7de", "description": "(Required) You must replace *{accountId}* with the accountid that you want to use." }, { "id": "d0c0f9dc-9d68-4c39-b872-83e47eaf4bd2", "key": "contactId", "value": "", "description": "(Required) Contact Id" } ] }, "description": "Update contact information" }, "response": [ { "id": "28a936b1-9d61-4063-92ce-086882bc33d9", "name": "OK", "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 {\n \"op\": \"test\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"move\",\n \"path\": \"\",\n \"value\": \"\"\n }\n]", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v1/accounts/:accountId/contacts/:contactId", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "accounts", ":accountId", "contacts", ":contactId" ], "variable": [ { "key": "accountId" }, { "key": "contactId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"id\": \"\",\n \"addresses\": {\n \"msisdn\": \"+6687066623696\",\n \"weChatUserId\": \"\",\n \"facebookUserId\": \"\",\n \"email\": \"\",\n \"zaloId\": \"\",\n \"lineId\": \"\",\n \"kakaoTalkId\": \"\"\n },\n \"createdAt\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"externalId\": \"\",\n \"country\": \"\",\n \"groups\": [\n {\n \"id\": \"\",\n \"contacts\": \"\",\n \"createdAt\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"isBlacklist\": \"\"\n }\n ],\n \"customAttributes\": {}\n}", "createdAt": "2026-07-28T00:28:34.000Z", "updatedAt": "2026-07-28T00:28:34.000Z", "uid": "35240-28a936b1-9d61-4063-92ce-086882bc33d9" }, { "id": "f18de2cc-7d2e-472d-a6dc-2a861ba01fb1", "name": "Bad request error response", "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 {\n \"op\": \"test\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"move\",\n \"path\": \"\",\n \"value\": \"\"\n }\n]", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v1/accounts/:accountId/contacts/:contactId", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "accounts", ":accountId", "contacts", ":contactId" ], "variable": [ { "key": "accountId" }, { "key": "contactId" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"code\": \"\",\n \"errorId\": \"\",\n \"timestamp\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-07-28T00:28:34.000Z", "updatedAt": "2026-07-28T00:28:34.000Z", "uid": "35240-f18de2cc-7d2e-472d-a6dc-2a861ba01fb1" }, { "id": "ed6d419c-3ab8-43a7-9515-4de2e944751e", "name": "The entity doesn't exist", "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 {\n \"op\": \"test\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"move\",\n \"path\": \"\",\n \"value\": \"\"\n }\n]", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v1/accounts/:accountId/contacts/:contactId", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "accounts", ":accountId", "contacts", ":contactId" ], "variable": [ { "key": "accountId" }, { "key": "contactId" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"code\": \"\",\n \"errorId\": \"\",\n \"timestamp\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-07-28T00:28:34.000Z", "updatedAt": "2026-07-28T00:28:34.000Z", "uid": "35240-ed6d419c-3ab8-43a7-9515-4de2e944751e" } ], "createdAt": "2026-07-28T00:28:34.000Z", "updatedAt": "2026-07-28T00:28:34.000Z", "uid": "35240-a60fc84d-11ca-4dce-8c67-8d402976622f" } ], "id": "b1e8a041-700d-49a3-8ced-561467e7844a", "createdAt": "2026-07-28T00:28:34.000Z", "updatedAt": "2026-07-28T00:28:34.000Z", "uid": "35240-b1e8a041-700d-49a3-8ced-561467e7844a" }, { "name": "batches", "item": [ { "name": "createContacts", "item": [ { "name": "Batch create contacts", "id": "6621fbb7-16d5-420b-9aae-b797a1c066ba", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "multipart/form-data" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "formdata", "formdata": [ { "description": "(Required) Binary content of the file.\n\n**The file size is limited to 30 Mb.**", "key": "file", "value": "[object Object]", "type": "text" }, { "description": "Comma-separated list of group id (integer) to add contacts to. \n\n**You can add contacts to 10 groups max.**", "key": "groups", "value": "", "type": "text" }, { "description": "Set this property to `true` if provided file has a header row. \n\nThe header row will be parsed automatically, you don't need to provide a list of columns in this case.\n\nDefault value is `true`", "key": "fileHasHeader", "value": "true", "type": "text" }, { "description": "Comma-separated list of columns. \n\nThis field is **mandatory** is `fileHasHeader` is `false`", "key": "fileColumns", "value": "", "type": "text" } ] }, "url": { "raw": "{{baseUrl}}/api/v1/accounts/:accountId/contacts/batches/createContacts", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "accounts", ":accountId", "contacts", "batches", "createContacts" ], "variable": [ { "id": "c60d7c5b-1c53-4d83-ae16-8f6bb8589169", "key": "accountId", "value": "c06f25f2a7ff-B3a496aD-AB1B0CcbC7de", "description": "(Required) You must replace *{accountId}* with the accountid that you want to use." } ] }, "description": "Batch create contacts using file. The file can be either CSV or Excel. The CSV file can contain a header row (the mapping of the columns will be automatic in this case), or not. For files without a header, the `fileColumns` property should be specified for a columns mapping." }, "response": [ { "id": "8a919f22-40d6-477d-874d-94e6fd6ab66b", "name": "Accepted", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "multipart/form-data" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "formdata", "formdata": [ { "description": "(Required) Binary content of the file.\n\n**The file size is limited to 30 Mb.**", "key": "file", "value": "[object Object]", "type": "text" }, { "description": "Comma-separated list of group id (integer) to add contacts to. \n\n**You can add contacts to 10 groups max.**", "key": "groups", "value": "", "type": "text" }, { "description": "Set this property to `true` if provided file has a header row. \n\nThe header row will be parsed automatically, you don't need to provide a list of columns in this case.\n\nDefault value is `true`", "key": "fileHasHeader", "value": "true", "type": "text" }, { "description": "Comma-separated list of columns. \n\nThis field is **mandatory** is `fileHasHeader` is `false`", "key": "fileColumns", "value": "", "type": "text" } ] }, "url": { "raw": "{{baseUrl}}/api/v1/accounts/:accountId/contacts/batches/createContacts", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "accounts", ":accountId", "contacts", "batches", "createContacts" ], "variable": [ { "key": "accountId" } ] } }, "status": "Accepted", "code": 202, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"fileName\": \"\",\n \"fileType\": \"xls\",\n \"fileLocation\": \"\",\n \"id\": \"\",\n \"type\": \"moveContacts\",\n \"status\": \"timeout\",\n \"createdAt\": \"\"\n}", "createdAt": "2026-07-28T00:28:34.000Z", "updatedAt": "2026-07-28T00:28:34.000Z", "uid": "35240-8a919f22-40d6-477d-874d-94e6fd6ab66b" }, { "id": "a4a8e689-f3e5-4dfb-8f51-d220fd0c6e91", "name": "Bad request error response", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "multipart/form-data" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "formdata", "formdata": [ { "description": "(Required) Binary content of the file.\n\n**The file size is limited to 30 Mb.**", "key": "file", "value": "[object Object]", "type": "text" }, { "description": "Comma-separated list of group id (integer) to add contacts to. \n\n**You can add contacts to 10 groups max.**", "key": "groups", "value": "", "type": "text" }, { "description": "Set this property to `true` if provided file has a header row. \n\nThe header row will be parsed automatically, you don't need to provide a list of columns in this case.\n\nDefault value is `true`", "key": "fileHasHeader", "value": "true", "type": "text" }, { "description": "Comma-separated list of columns. \n\nThis field is **mandatory** is `fileHasHeader` is `false`", "key": "fileColumns", "value": "", "type": "text" } ] }, "url": { "raw": "{{baseUrl}}/api/v1/accounts/:accountId/contacts/batches/createContacts", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "accounts", ":accountId", "contacts", "batches", "createContacts" ], "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 \"errorId\": \"\",\n \"timestamp\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-07-28T00:28:34.000Z", "updatedAt": "2026-07-28T00:28:34.000Z", "uid": "35240-a4a8e689-f3e5-4dfb-8f51-d220fd0c6e91" } ], "createdAt": "2026-07-28T00:28:34.000Z", "updatedAt": "2026-07-28T00:28:34.000Z", "uid": "35240-6621fbb7-16d5-420b-9aae-b797a1c066ba" } ], "id": "72d5e25c-4cb1-4de2-a75d-57cb6e596fd2", "createdAt": "2026-07-28T00:28:34.000Z", "updatedAt": "2026-07-28T00:28:34.000Z", "uid": "35240-72d5e25c-4cb1-4de2-a75d-57cb6e596fd2" }, { "name": "deleteContacts", "item": [ { "name": "Batch delete contacts", "id": "5c4ebcc1-0276-4d2b-a3fe-c3d447c69718", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"ids\": [\n \"\",\n \"\"\n ],\n \"msisdns\": [\n \"\",\n \"\"\n ],\n \"all\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v1/accounts/:accountId/contacts/batches/deleteContacts", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "accounts", ":accountId", "contacts", "batches", "deleteContacts" ], "variable": [ { "id": "eca8df95-09e2-41eb-b932-571a32369e10", "key": "accountId", "value": "c06f25f2a7ff-B3a496aD-AB1B0CcbC7de", "description": "(Required) You must replace *{accountId}* with the accountid that you want to use." } ] }, "description": "Use this endpoint to delete multiple/all contacts in batch. Provide `ids` or `msisdns` to remove specific contacts, or set `\"all\": true` to delete all contacts in your account." }, "response": [ { "id": "619c19ab-8cc6-44ea-927e-cf63a6e169d4", "name": "Accepted", "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 \"ids\": [\n \"\",\n \"\"\n ],\n \"msisdns\": [\n \"\",\n \"\"\n ],\n \"all\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v1/accounts/:accountId/contacts/batches/deleteContacts", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "accounts", ":accountId", "contacts", "batches", "deleteContacts" ], "variable": [ { "key": "accountId" } ] } }, "status": "Accepted", "code": 202, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"id\": \"\",\n \"type\": \"deleteGroups\",\n \"status\": \"queued\",\n \"createdAt\": \"\"\n}", "createdAt": "2026-07-28T00:28:34.000Z", "updatedAt": "2026-07-28T00:28:34.000Z", "uid": "35240-619c19ab-8cc6-44ea-927e-cf63a6e169d4" }, { "id": "09704fc0-5c03-4fb1-81c7-c6770fff2a41", "name": "Bad request error response", "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 \"ids\": [\n \"\",\n \"\"\n ],\n \"msisdns\": [\n \"\",\n \"\"\n ],\n \"all\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v1/accounts/:accountId/contacts/batches/deleteContacts", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "accounts", ":accountId", "contacts", "batches", "deleteContacts" ], "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 \"errorId\": \"\",\n \"timestamp\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-07-28T00:28:34.000Z", "updatedAt": "2026-07-28T00:28:34.000Z", "uid": "35240-09704fc0-5c03-4fb1-81c7-c6770fff2a41" } ], "createdAt": "2026-07-28T00:28:34.000Z", "updatedAt": "2026-07-28T00:28:34.000Z", "uid": "35240-5c4ebcc1-0276-4d2b-a3fe-c3d447c69718" } ], "id": "ddec4eef-863f-445e-9f1d-9f0e78f080c2", "createdAt": "2026-07-28T00:28:34.000Z", "updatedAt": "2026-07-28T00:28:34.000Z", "uid": "35240-ddec4eef-863f-445e-9f1d-9f0e78f080c2" } ], "id": "2f77f8b0-a4c3-4b93-b5b2-cde7ae0748c8", "createdAt": "2026-07-28T00:28:34.000Z", "updatedAt": "2026-07-28T00:28:34.000Z", "uid": "35240-2f77f8b0-a4c3-4b93-b5b2-cde7ae0748c8" }, { "name": "Search contacts", "id": "8e9fe3a9-2db6-45c2-9812-b22c62ffdf84", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/accounts/:accountId/contacts?limit=20&offset=&query=&groupId=&country=", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "accounts", ":accountId", "contacts" ], "query": [ { "description": "Number of items to include in the response", "key": "limit", "value": "20" }, { "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": "" }, { "description": "Some arbitrary string to search for. Can be name or one of addresses (email, phone number, etc)", "key": "query", "value": "" }, { "description": "Search contacts in a particular group", "key": "groupId", "value": "" }, { "description": "To search for a contact or contacts using country, please use Alpha-2 country code ([two character country codes](https://www.iban.com/country-codes))", "key": "country", "value": "" } ], "variable": [ { "id": "e8f90d26-fd20-4477-9e97-6123e9e4e347", "key": "accountId", "value": "c06f25f2a7ff-B3a496aD-AB1B0CcbC7de", "description": "(Required) You must replace *{accountId}* with the accountid that you want to use." } ] }, "description": "Search for contacts" }, "response": [ { "id": "8ca5dbc2-8700-4b4b-8a9b-8c0f5c2c8ab3", "name": "New Response", "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/contacts?limit=20&offset=&query=&groupId=&country=", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "accounts", ":accountId", "contacts" ], "query": [ { "description": "Number of items to include in the response", "key": "limit", "value": "20" }, { "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": "" }, { "description": "Some arbitrary string to search for. Can be name or one of addresses (email, phone number, etc)", "key": "query", "value": "" }, { "description": "Search contacts in a particular group", "key": "groupId", "value": "" }, { "description": "To search for a contact or contacts using country, please use Alpha-2 country code ([two character country codes](https://www.iban.com/country-codes))", "key": "country", "value": "" } ], "variable": [ { "key": "accountId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"items\": [\n {\n \"id\": \"\",\n \"addresses\": {\n \"msisdn\": \"+91720597\",\n \"weChatUserId\": \"\",\n \"facebookUserId\": \"\",\n \"email\": \"\",\n \"zaloId\": \"\",\n \"lineId\": \"\",\n \"kakaoTalkId\": \"\"\n },\n \"createdAt\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"externalId\": \"\",\n \"country\": \"\",\n \"groups\": [\n {\n \"id\": \"\",\n \"contacts\": \"\",\n \"createdAt\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"isBlacklist\": \"\"\n }\n ],\n \"customAttributes\": {}\n },\n {\n \"id\": \"\",\n \"addresses\": {\n \"msisdn\": \"2066266917\",\n \"weChatUserId\": \"\",\n \"facebookUserId\": \"\",\n \"email\": \"\",\n \"zaloId\": \"\",\n \"lineId\": \"\",\n \"kakaoTalkId\": \"\"\n },\n \"createdAt\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"externalId\": \"\",\n \"country\": \"\",\n \"groups\": [\n {\n \"id\": \"\",\n \"contacts\": \"\",\n \"createdAt\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"isBlacklist\": \"\"\n }\n ],\n \"customAttributes\": {}\n }\n ],\n \"page\": \"\",\n \"totalPages\": \"\",\n \"totalCount\": \"\",\n \"totalFiltered\": \"\",\n \"hasPreviousPage\": \"\",\n \"hasNextPage\": \"\"\n}", "createdAt": "2026-07-28T00:28:34.000Z", "updatedAt": "2026-07-28T00:28:34.000Z", "uid": "35240-8ca5dbc2-8700-4b4b-8a9b-8c0f5c2c8ab3" }, { "id": "8d0b9189-7525-45ed-b6a7-6ab5fb328676", "name": "Bad request error response", "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/contacts?limit=20&offset=&query=&groupId=&country=", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "accounts", ":accountId", "contacts" ], "query": [ { "description": "Number of items to include in the response", "key": "limit", "value": "20" }, { "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": "" }, { "description": "Some arbitrary string to search for. Can be name or one of addresses (email, phone number, etc)", "key": "query", "value": "" }, { "description": "Search contacts in a particular group", "key": "groupId", "value": "" }, { "description": "To search for a contact or contacts using country, please use Alpha-2 country code ([two character country codes](https://www.iban.com/country-codes))", "key": "country", "value": "" } ], "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 \"errorId\": \"\",\n \"timestamp\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-07-28T00:28:34.000Z", "updatedAt": "2026-07-28T00:28:34.000Z", "uid": "35240-8d0b9189-7525-45ed-b6a7-6ab5fb328676" } ], "createdAt": "2026-07-28T00:28:34.000Z", "updatedAt": "2026-07-28T00:28:34.000Z", "uid": "35240-8e9fe3a9-2db6-45c2-9812-b22c62ffdf84" }, { "name": "Create contact", "id": "1fa5d45a-dfb2-4bf1-92b4-1938f1c10132", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"addresses\": {\n \"msisdn\": \"753127687\",\n \"weChatUserId\": \"\",\n \"facebookUserId\": \"\",\n \"email\": \"\",\n \"zaloId\": \"\",\n \"lineId\": \"\",\n \"kakaoTalkId\": \"\"\n },\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"externalId\": \"\",\n \"country\": \"\",\n \"groups\": [\n {\n \"id\": \"\"\n }\n ],\n \"customAttributes\": {}\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v1/accounts/:accountId/contacts", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "accounts", ":accountId", "contacts" ], "variable": [ { "id": "04d651e5-e35b-412c-ad1e-10b965106f30", "key": "accountId", "value": "c06f25f2a7ff-B3a496aD-AB1B0CcbC7de", "description": "(Required) You must replace *{accountId}* with the accountid that you want to use." } ] }, "description": "Create a new contact" }, "response": [ { "id": "309df9a1-4aae-467c-b28d-01fd2386d110", "name": "You'll receive 200 OK if the contact has been merged with another contact based on one of provided addresses", "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 \"addresses\": {\n \"msisdn\": \"753127687\",\n \"weChatUserId\": \"\",\n \"facebookUserId\": \"\",\n \"email\": \"\",\n \"zaloId\": \"\",\n \"lineId\": \"\",\n \"kakaoTalkId\": \"\"\n },\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"externalId\": \"\",\n \"country\": \"\",\n \"groups\": [\n {\n \"id\": \"\"\n }\n ],\n \"customAttributes\": {}\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v1/accounts/:accountId/contacts", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "accounts", ":accountId", "contacts" ], "variable": [ { "key": "accountId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"id\": \"\",\n \"addresses\": {\n \"msisdn\": \"+6687066623696\",\n \"weChatUserId\": \"\",\n \"facebookUserId\": \"\",\n \"email\": \"\",\n \"zaloId\": \"\",\n \"lineId\": \"\",\n \"kakaoTalkId\": \"\"\n },\n \"createdAt\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"externalId\": \"\",\n \"country\": \"\",\n \"groups\": [\n {\n \"id\": \"\",\n \"contacts\": \"\",\n \"createdAt\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"isBlacklist\": \"\"\n }\n ],\n \"customAttributes\": {}\n}", "createdAt": "2026-07-28T00:28:34.000Z", "updatedAt": "2026-07-28T00:28:34.000Z", "uid": "35240-309df9a1-4aae-467c-b28d-01fd2386d110" }, { "id": "d1fe161d-cdd7-4a0c-82d0-6d463d6ecc97", "name": "You'll receive 201 Created if the contact has been created", "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 \"addresses\": {\n \"msisdn\": \"753127687\",\n \"weChatUserId\": \"\",\n \"facebookUserId\": \"\",\n \"email\": \"\",\n \"zaloId\": \"\",\n \"lineId\": \"\",\n \"kakaoTalkId\": \"\"\n },\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"externalId\": \"\",\n \"country\": \"\",\n \"groups\": [\n {\n \"id\": \"\"\n }\n ],\n \"customAttributes\": {}\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v1/accounts/:accountId/contacts", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "accounts", ":accountId", "contacts" ], "variable": [ { "key": "accountId" } ] } }, "status": "Created", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"id\": \"\",\n \"addresses\": {\n \"msisdn\": \"+6687066623696\",\n \"weChatUserId\": \"\",\n \"facebookUserId\": \"\",\n \"email\": \"\",\n \"zaloId\": \"\",\n \"lineId\": \"\",\n \"kakaoTalkId\": \"\"\n },\n \"createdAt\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"externalId\": \"\",\n \"country\": \"\",\n \"groups\": [\n {\n \"id\": \"\",\n \"contacts\": \"\",\n \"createdAt\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"isBlacklist\": \"\"\n }\n ],\n \"customAttributes\": {}\n}", "createdAt": "2026-07-28T00:28:34.000Z", "updatedAt": "2026-07-28T00:28:34.000Z", "uid": "35240-d1fe161d-cdd7-4a0c-82d0-6d463d6ecc97" }, { "id": "4de60c89-7819-4e4f-a7ea-b46b27600c5d", "name": "Bad request error response", "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 \"addresses\": {\n \"msisdn\": \"753127687\",\n \"weChatUserId\": \"\",\n \"facebookUserId\": \"\",\n \"email\": \"\",\n \"zaloId\": \"\",\n \"lineId\": \"\",\n \"kakaoTalkId\": \"\"\n },\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"externalId\": \"\",\n \"country\": \"\",\n \"groups\": [\n {\n \"id\": \"\"\n }\n ],\n \"customAttributes\": {}\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v1/accounts/:accountId/contacts", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "accounts", ":accountId", "contacts" ], "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 \"errorId\": \"\",\n \"timestamp\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-07-28T00:28:34.000Z", "updatedAt": "2026-07-28T00:28:34.000Z", "uid": "35240-4de60c89-7819-4e4f-a7ea-b46b27600c5d" }, { "id": "73a68b4d-c54d-4fe7-84bb-0c3d849525c0", "name": "Conflict: more than one contact was found based on a provided set of addresses.", "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 \"addresses\": {\n \"msisdn\": \"753127687\",\n \"weChatUserId\": \"\",\n \"facebookUserId\": \"\",\n \"email\": \"\",\n \"zaloId\": \"\",\n \"lineId\": \"\",\n \"kakaoTalkId\": \"\"\n },\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"externalId\": \"\",\n \"country\": \"\",\n \"groups\": [\n {\n \"id\": \"\"\n }\n ],\n \"customAttributes\": {}\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v1/accounts/:accountId/contacts", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "accounts", ":accountId", "contacts" ], "variable": [ { "key": "accountId" } ] } }, "status": "Conflict", "code": 409, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"code\": \"\",\n \"errorId\": \"\",\n \"timestamp\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-07-28T00:28:34.000Z", "updatedAt": "2026-07-28T00:28:34.000Z", "uid": "35240-73a68b4d-c54d-4fe7-84bb-0c3d849525c0" } ], "createdAt": "2026-07-28T00:28:34.000Z", "updatedAt": "2026-07-28T00:28:34.000Z", "uid": "35240-1fa5d45a-dfb2-4bf1-92b4-1938f1c10132" } ], "id": "1953b50f-0059-48ec-aa68-72c457688b45", "createdAt": "2026-07-28T00:28:34.000Z", "updatedAt": "2026-07-28T00:28:34.000Z", "uid": "35240-1953b50f-0059-48ec-aa68-72c457688b45" }, { "name": "groups", "item": [ { "name": "{groupId}", "item": [ { "name": "contacts", "item": [ { "name": "Add a contact to a group", "id": "f6ce132a-15b7-4b54-ac7f-41300924a751", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"contacts\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v1/accounts/:accountId/groups/:groupId/contacts", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "accounts", ":accountId", "groups", ":groupId", "contacts" ], "variable": [ { "id": "e79961ac-299d-40f6-8548-4408de2810cb", "key": "accountId", "value": "c06f25f2a7ff-B3a496aD-AB1B0CcbC7de", "description": "(Required) You must replace *{accountId}* with the accountid that you want to use." }, { "id": "84c8a88c-d8bb-4072-a1df-f9d0245b1acf", "key": "groupId", "value": "", "description": "(Required) Group Id" } ] }, "description": "Add a contact to a group" }, "response": [ { "id": "abad6e28-9d45-4309-b8fb-130536e85847", "name": "Created", "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 \"contacts\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v1/accounts/:accountId/groups/:groupId/contacts", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "accounts", ":accountId", "groups", ":groupId", "contacts" ], "variable": [ { "key": "accountId" }, { "key": "groupId" } ] } }, "status": "Created", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"id\": \"\",\n \"contacts\": \"\",\n \"createdAt\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"isBlacklist\": \"\"\n}", "createdAt": "2026-07-28T00:28:34.000Z", "updatedAt": "2026-07-28T00:28:34.000Z", "uid": "35240-abad6e28-9d45-4309-b8fb-130536e85847" }, { "id": "f6deecee-2a27-4022-bbc8-675f1a9d9ad7", "name": "The entity doesn't exist", "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 \"contacts\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v1/accounts/:accountId/groups/:groupId/contacts", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "accounts", ":accountId", "groups", ":groupId", "contacts" ], "variable": [ { "key": "accountId" }, { "key": "groupId" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"code\": \"\",\n \"errorId\": \"\",\n \"timestamp\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-07-28T00:28:34.000Z", "updatedAt": "2026-07-28T00:28:34.000Z", "uid": "35240-f6deecee-2a27-4022-bbc8-675f1a9d9ad7" } ], "createdAt": "2026-07-28T00:28:34.000Z", "updatedAt": "2026-07-28T00:28:34.000Z", "uid": "35240-f6ce132a-15b7-4b54-ac7f-41300924a751" }, { "name": "Remove contacts from a group", "id": "a7cfbce6-924a-481f-bc15-1d8246255106", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"contacts\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v1/accounts/:accountId/groups/:groupId/contacts", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "accounts", ":accountId", "groups", ":groupId", "contacts" ], "variable": [ { "id": "e32db68f-f01d-46f2-b6ac-92c72f39d8a8", "key": "accountId", "value": "c06f25f2a7ff-B3a496aD-AB1B0CcbC7de", "description": "(Required) You must replace *{accountId}* with the accountid that you want to use." }, { "id": "1b391ed6-3d00-44b3-ae51-5e73b67797f5", "key": "groupId", "value": "", "description": "(Required) Group Id" } ] }, "description": "Delete contacts from group" }, "response": [ { "id": "1577d1a5-dca4-47b5-8a8b-ba478f47d0d4", "name": "OK", "originalRequest": { "method": "DELETE", "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 \"contacts\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v1/accounts/:accountId/groups/:groupId/contacts", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "accounts", ":accountId", "groups", ":groupId", "contacts" ], "variable": [ { "key": "accountId" }, { "key": "groupId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"id\": \"\",\n \"contacts\": \"\",\n \"createdAt\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"isBlacklist\": \"\"\n}", "createdAt": "2026-07-28T00:28:34.000Z", "updatedAt": "2026-07-28T00:28:34.000Z", "uid": "35240-1577d1a5-dca4-47b5-8a8b-ba478f47d0d4" }, { "id": "21825fd7-1671-438d-8221-f731a0279a98", "name": "The entity doesn't exist", "originalRequest": { "method": "DELETE", "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 \"contacts\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v1/accounts/:accountId/groups/:groupId/contacts", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "accounts", ":accountId", "groups", ":groupId", "contacts" ], "variable": [ { "key": "accountId" }, { "key": "groupId" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"code\": \"\",\n \"errorId\": \"\",\n \"timestamp\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-07-28T00:28:34.000Z", "updatedAt": "2026-07-28T00:28:34.000Z", "uid": "35240-21825fd7-1671-438d-8221-f731a0279a98" } ], "createdAt": "2026-07-28T00:28:34.000Z", "updatedAt": "2026-07-28T00:28:34.000Z", "uid": "35240-a7cfbce6-924a-481f-bc15-1d8246255106" } ], "id": "c588f54a-56b7-45e3-9d7a-a77775d661a6", "createdAt": "2026-07-28T00:28:34.000Z", "updatedAt": "2026-07-28T00:28:34.000Z", "uid": "35240-c588f54a-56b7-45e3-9d7a-a77775d661a6" }, { "name": "Get group information by id", "id": "637d2a59-3aed-4c87-910c-931340510112", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/accounts/:accountId/groups/:groupId", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "accounts", ":accountId", "groups", ":groupId" ], "variable": [ { "id": "9b3c8b8d-f802-491d-9a80-8eb86d79d2ea", "key": "accountId", "value": "c06f25f2a7ff-B3a496aD-AB1B0CcbC7de", "description": "(Required) You must replace *{accountId}* with the accountid that you want to use." }, { "id": "c321331b-6488-4bfe-9999-3fe96ed0bfac", "key": "groupId", "value": "", "description": "(Required) Group Id" } ] }, "description": "Get group information by id" }, "response": [ { "id": "17925fe9-017e-4bdb-aa4f-c91247985ead", "name": "OK", "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/groups/:groupId", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "accounts", ":accountId", "groups", ":groupId" ], "variable": [ { "key": "accountId" }, { "key": "groupId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"id\": \"\",\n \"contacts\": \"\",\n \"createdAt\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"isBlacklist\": \"\"\n}", "createdAt": "2026-07-28T00:28:34.000Z", "updatedAt": "2026-07-28T00:28:34.000Z", "uid": "35240-17925fe9-017e-4bdb-aa4f-c91247985ead" }, { "id": "3e281ddd-ddfd-465e-ab1f-e0f0e82c8d0a", "name": "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/groups/:groupId", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "accounts", ":accountId", "groups", ":groupId" ], "variable": [ { "key": "accountId" }, { "key": "groupId" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"code\": \"\",\n \"errorId\": \"\",\n \"timestamp\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-07-28T00:28:34.000Z", "updatedAt": "2026-07-28T00:28:34.000Z", "uid": "35240-3e281ddd-ddfd-465e-ab1f-e0f0e82c8d0a" } ], "createdAt": "2026-07-28T00:28:34.000Z", "updatedAt": "2026-07-28T00:28:34.000Z", "uid": "35240-637d2a59-3aed-4c87-910c-931340510112" }, { "name": "Delete group", "id": "e21675fb-2e13-4842-8b48-87049c4c392c", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/accounts/:accountId/groups/:groupId", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "accounts", ":accountId", "groups", ":groupId" ], "variable": [ { "id": "31029c6c-3111-402c-a34f-46c3b4f7c6b9", "key": "accountId", "value": "c06f25f2a7ff-B3a496aD-AB1B0CcbC7de", "description": "(Required) You must replace *{accountId}* with the accountid that you want to use." }, { "id": "18c30404-b085-4c39-bffb-96bd27ba94f6", "key": "groupId", "value": "", "description": "(Required) Group Id" } ] }, "description": "Delete group" }, "response": [ { "id": "af2aa51a-c8e0-4b5f-8ade-e3293bf5283a", "name": "No Content", "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/groups/:groupId", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "accounts", ":accountId", "groups", ":groupId" ], "variable": [ { "key": "accountId" }, { "key": "groupId" } ] } }, "status": "No Content", "code": 204, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"code\": \"\",\n \"errorId\": \"\",\n \"timestamp\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-07-28T00:28:34.000Z", "updatedAt": "2026-07-28T00:28:34.000Z", "uid": "35240-af2aa51a-c8e0-4b5f-8ade-e3293bf5283a" }, { "id": "625b6ad8-cb19-43e7-8f2d-c3c680fb168c", "name": "The entity doesn't exist", "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/groups/:groupId", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "accounts", ":accountId", "groups", ":groupId" ], "variable": [ { "key": "accountId" }, { "key": "groupId" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"code\": \"\",\n \"errorId\": \"\",\n \"timestamp\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-07-28T00:28:34.000Z", "updatedAt": "2026-07-28T00:28:34.000Z", "uid": "35240-625b6ad8-cb19-43e7-8f2d-c3c680fb168c" } ], "createdAt": "2026-07-28T00:28:34.000Z", "updatedAt": "2026-07-28T00:28:34.000Z", "uid": "35240-e21675fb-2e13-4842-8b48-87049c4c392c" }, { "name": "Update group information", "id": "9941dd12-46eb-4917-abcf-3d6bd7b5cbc7", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "[\n {\n \"op\": \"replace\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"test\",\n \"path\": \"\",\n \"value\": \"\"\n }\n]", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v1/accounts/:accountId/groups/:groupId", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "accounts", ":accountId", "groups", ":groupId" ], "variable": [ { "id": "be24d525-d4da-4e90-ad36-a2533b72f02f", "key": "accountId", "value": "c06f25f2a7ff-B3a496aD-AB1B0CcbC7de", "description": "(Required) You must replace *{accountId}* with the accountid that you want to use." }, { "id": "493d73d6-9cd4-4f2f-a9ea-3ee23a47b64c", "key": "groupId", "value": "", "description": "(Required) Group Id" } ] }, "description": "Update group information" }, "response": [ { "id": "21afc787-413e-4359-ac87-babd7cd21d3e", "name": "OK", "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 {\n \"op\": \"replace\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"test\",\n \"path\": \"\",\n \"value\": \"\"\n }\n]", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v1/accounts/:accountId/groups/:groupId", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "accounts", ":accountId", "groups", ":groupId" ], "variable": [ { "key": "accountId" }, { "key": "groupId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"id\": \"\",\n \"contacts\": \"\",\n \"createdAt\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"isBlacklist\": \"\"\n}", "createdAt": "2026-07-28T00:28:34.000Z", "updatedAt": "2026-07-28T00:28:34.000Z", "uid": "35240-21afc787-413e-4359-ac87-babd7cd21d3e" }, { "id": "39ccaf7a-9abe-4a1b-901e-70b1dc7a2a91", "name": "Bad request error response", "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 {\n \"op\": \"replace\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"test\",\n \"path\": \"\",\n \"value\": \"\"\n }\n]", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v1/accounts/:accountId/groups/:groupId", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "accounts", ":accountId", "groups", ":groupId" ], "variable": [ { "key": "accountId" }, { "key": "groupId" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"code\": \"\",\n \"errorId\": \"\",\n \"timestamp\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-07-28T00:28:34.000Z", "updatedAt": "2026-07-28T00:28:34.000Z", "uid": "35240-39ccaf7a-9abe-4a1b-901e-70b1dc7a2a91" }, { "id": "3bcc8882-cc61-46a9-af27-2a7a15a467c2", "name": "The entity doesn't exist", "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 {\n \"op\": \"replace\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"test\",\n \"path\": \"\",\n \"value\": \"\"\n }\n]", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v1/accounts/:accountId/groups/:groupId", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "accounts", ":accountId", "groups", ":groupId" ], "variable": [ { "key": "accountId" }, { "key": "groupId" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"code\": \"\",\n \"errorId\": \"\",\n \"timestamp\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-07-28T00:28:34.000Z", "updatedAt": "2026-07-28T00:28:34.000Z", "uid": "35240-3bcc8882-cc61-46a9-af27-2a7a15a467c2" }, { "id": "58d28999-bad8-4f8c-a758-ac33ad60d280", "name": "Conflict: the group with the same name already exists", "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 {\n \"op\": \"replace\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"test\",\n \"path\": \"\",\n \"value\": \"\"\n }\n]", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v1/accounts/:accountId/groups/:groupId", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "accounts", ":accountId", "groups", ":groupId" ], "variable": [ { "key": "accountId" }, { "key": "groupId" } ] } }, "status": "Conflict", "code": 409, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"code\": \"\",\n \"errorId\": \"\",\n \"timestamp\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-07-28T00:28:34.000Z", "updatedAt": "2026-07-28T00:28:34.000Z", "uid": "35240-58d28999-bad8-4f8c-a758-ac33ad60d280" } ], "createdAt": "2026-07-28T00:28:34.000Z", "updatedAt": "2026-07-28T00:28:34.000Z", "uid": "35240-9941dd12-46eb-4917-abcf-3d6bd7b5cbc7" } ], "id": "1c00d470-5b62-4a1d-8c09-a349c9984f6b", "createdAt": "2026-07-28T00:28:34.000Z", "updatedAt": "2026-07-28T00:28:34.000Z", "uid": "35240-1c00d470-5b62-4a1d-8c09-a349c9984f6b" }, { "name": "batches", "item": [ { "name": "copyContacts", "item": [ { "name": "Copy contacts between groups", "id": "97b8e1fe-632b-476b-b1d7-bc37a8ee83a5", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/accounts/:accountId/groups/batches/copyContacts?from=&to=", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "accounts", ":accountId", "groups", "batches", "copyContacts" ], "query": [ { "description": "(Required) Identifier of the source group", "key": "from", "value": "" }, { "description": "(Required) Identifier of the destination group", "key": "to", "value": "" } ], "variable": [ { "id": "f29323ad-d0ba-4b59-92cc-be4f8ae7b1cb", "key": "accountId", "value": "c06f25f2a7ff-B3a496aD-AB1B0CcbC7de", "description": "(Required) You must replace *{accountId}* with the accountid that you want to use." } ] }, "description": "Copy contacts from ony group to another one." }, "response": [ { "id": "df96bcf9-a66f-4121-98ea-910ba5988cd9", "name": "Accepted", "originalRequest": { "method": "POST", "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/groups/batches/copyContacts?from=&to=", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "accounts", ":accountId", "groups", "batches", "copyContacts" ], "query": [ { "description": "(Required) Identifier of the source group", "key": "from", "value": "" }, { "description": "(Required) Identifier of the destination group", "key": "to", "value": "" } ], "variable": [ { "key": "accountId" } ] } }, "status": "Accepted", "code": 202, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"id\": \"\",\n \"type\": \"deleteGroups\",\n \"status\": \"queued\",\n \"createdAt\": \"\"\n}", "createdAt": "2026-07-28T00:28:34.000Z", "updatedAt": "2026-07-28T00:28:34.000Z", "uid": "35240-df96bcf9-a66f-4121-98ea-910ba5988cd9" }, { "id": "12137467-cb77-4e1e-909a-b4ff0f1bdb37", "name": "Bad request error response", "originalRequest": { "method": "POST", "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/groups/batches/copyContacts?from=&to=", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "accounts", ":accountId", "groups", "batches", "copyContacts" ], "query": [ { "description": "(Required) Identifier of the source group", "key": "from", "value": "" }, { "description": "(Required) Identifier of the destination group", "key": "to", "value": "" } ], "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 \"errorId\": \"\",\n \"timestamp\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-07-28T00:28:34.000Z", "updatedAt": "2026-07-28T00:28:34.000Z", "uid": "35240-12137467-cb77-4e1e-909a-b4ff0f1bdb37" } ], "createdAt": "2026-07-28T00:28:34.000Z", "updatedAt": "2026-07-28T00:28:34.000Z", "uid": "35240-97b8e1fe-632b-476b-b1d7-bc37a8ee83a5" } ], "id": "ac549ddb-43b9-426d-8e58-6e14b9160d8a", "createdAt": "2026-07-28T00:28:34.000Z", "updatedAt": "2026-07-28T00:28:34.000Z", "uid": "35240-ac549ddb-43b9-426d-8e58-6e14b9160d8a" }, { "name": "moveContacts", "item": [ { "name": "Move contacts between groups", "id": "a3629dd1-88c3-4d27-953b-aee317370ff8", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/accounts/:accountId/groups/batches/moveContacts?from=&to=", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "accounts", ":accountId", "groups", "batches", "moveContacts" ], "query": [ { "description": "(Required) Identifier of the source group", "key": "from", "value": "" }, { "description": "(Required) Identifier of the destination group", "key": "to", "value": "" } ], "variable": [ { "id": "11309bf3-64dc-46d4-a309-5b76dc17e996", "key": "accountId", "value": "c06f25f2a7ff-B3a496aD-AB1B0CcbC7de", "description": "(Required) You must replace *{accountId}* with the accountid that you want to use." } ] }, "description": "Move contacts from one group to another one. This operation will delete contacts in the original group." }, "response": [ { "id": "e2d9dc87-2f93-4150-8a87-bac06e80c44a", "name": "Accepted", "originalRequest": { "method": "POST", "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/groups/batches/moveContacts?from=&to=", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "accounts", ":accountId", "groups", "batches", "moveContacts" ], "query": [ { "description": "(Required) Identifier of the source group", "key": "from", "value": "" }, { "description": "(Required) Identifier of the destination group", "key": "to", "value": "" } ], "variable": [ { "key": "accountId" } ] } }, "status": "Accepted", "code": 202, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"id\": \"\",\n \"type\": \"deleteGroups\",\n \"status\": \"queued\",\n \"createdAt\": \"\"\n}", "createdAt": "2026-07-28T00:28:34.000Z", "updatedAt": "2026-07-28T00:28:34.000Z", "uid": "35240-e2d9dc87-2f93-4150-8a87-bac06e80c44a" }, { "id": "06cbb4ed-c87f-4c01-82c0-02c0d84623d0", "name": "Bad request error response", "originalRequest": { "method": "POST", "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/groups/batches/moveContacts?from=&to=", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "accounts", ":accountId", "groups", "batches", "moveContacts" ], "query": [ { "description": "(Required) Identifier of the source group", "key": "from", "value": "" }, { "description": "(Required) Identifier of the destination group", "key": "to", "value": "" } ], "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 \"errorId\": \"\",\n \"timestamp\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-07-28T00:28:34.000Z", "updatedAt": "2026-07-28T00:28:34.000Z", "uid": "35240-06cbb4ed-c87f-4c01-82c0-02c0d84623d0" } ], "createdAt": "2026-07-28T00:28:34.000Z", "updatedAt": "2026-07-28T00:28:34.000Z", "uid": "35240-a3629dd1-88c3-4d27-953b-aee317370ff8" } ], "id": "a96c7bf0-83dc-4a33-8f6e-086e3977e86f", "createdAt": "2026-07-28T00:28:34.000Z", "updatedAt": "2026-07-28T00:28:34.000Z", "uid": "35240-a96c7bf0-83dc-4a33-8f6e-086e3977e86f" }, { "name": "deleteGroups", "item": [ { "name": "Batch delete groups", "id": "25335eda-cc1f-4a37-9bf2-f022bfe3b123", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"ids\": [\n \"\",\n \"\"\n ],\n \"deleteContacts\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v1/accounts/:accountId/groups/batches/deleteGroups", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "accounts", ":accountId", "groups", "batches", "deleteGroups" ], "variable": [ { "id": "27535dd0-4e6a-4cec-9cae-93fb5a653ac7", "key": "accountId", "value": "c06f25f2a7ff-B3a496aD-AB1B0CcbC7de", "description": "(Required) You must replace *{accountId}* with the accountid that you want to use." } ] }, "description": "Batch delete groups" }, "response": [ { "id": "314ccfab-1afc-4009-a803-89703f7e4012", "name": "Accepted", "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 \"ids\": [\n \"\",\n \"\"\n ],\n \"deleteContacts\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v1/accounts/:accountId/groups/batches/deleteGroups", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "accounts", ":accountId", "groups", "batches", "deleteGroups" ], "variable": [ { "key": "accountId" } ] } }, "status": "Accepted", "code": 202, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"id\": \"\",\n \"type\": \"deleteGroups\",\n \"status\": \"queued\",\n \"createdAt\": \"\"\n}", "createdAt": "2026-07-28T00:28:34.000Z", "updatedAt": "2026-07-28T00:28:34.000Z", "uid": "35240-314ccfab-1afc-4009-a803-89703f7e4012" }, { "id": "89a6ed19-343f-476d-ad53-b3ea6a6a68cb", "name": "Bad request error response", "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 \"ids\": [\n \"\",\n \"\"\n ],\n \"deleteContacts\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v1/accounts/:accountId/groups/batches/deleteGroups", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "accounts", ":accountId", "groups", "batches", "deleteGroups" ], "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 \"errorId\": \"\",\n \"timestamp\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-07-28T00:28:34.000Z", "updatedAt": "2026-07-28T00:28:34.000Z", "uid": "35240-89a6ed19-343f-476d-ad53-b3ea6a6a68cb" } ], "createdAt": "2026-07-28T00:28:34.000Z", "updatedAt": "2026-07-28T00:28:34.000Z", "uid": "35240-25335eda-cc1f-4a37-9bf2-f022bfe3b123" } ], "id": "528e3ffc-07fb-4e79-85cd-1263bce93f8e", "createdAt": "2026-07-28T00:28:34.000Z", "updatedAt": "2026-07-28T00:28:34.000Z", "uid": "35240-528e3ffc-07fb-4e79-85cd-1263bce93f8e" } ], "id": "8a95f581-7c31-4ab9-ba88-8f5c9ef98b3e", "createdAt": "2026-07-28T00:28:34.000Z", "updatedAt": "2026-07-28T00:28:34.000Z", "uid": "35240-8a95f581-7c31-4ab9-ba88-8f5c9ef98b3e" }, { "name": "Search for groups", "id": "3e6410f0-3fc3-4461-8739-a0b8c02a458f", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/accounts/:accountId/groups?limit=20&offset=&name=", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "accounts", ":accountId", "groups" ], "query": [ { "description": "Number of items to include in the response", "key": "limit", "value": "20" }, { "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": "" }, { "description": "Group name to search for", "key": "name", "value": "" } ], "variable": [ { "id": "0bcc612e-6248-4a98-90f7-0efb4a8e8b10", "key": "accountId", "value": "c06f25f2a7ff-B3a496aD-AB1B0CcbC7de", "description": "(Required) You must replace *{accountId}* with the accountid that you want to use." } ] }, "description": "Search for groups" }, "response": [ { "id": "2d476d6c-411e-4d2c-a3fc-c602a504eee4", "name": "OK", "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/groups?limit=20&offset=&name=", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "accounts", ":accountId", "groups" ], "query": [ { "description": "Number of items to include in the response", "key": "limit", "value": "20" }, { "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": "" }, { "description": "Group name to search for", "key": "name", "value": "" } ], "variable": [ { "key": "accountId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"items\": [\n {\n \"id\": \"\",\n \"contacts\": \"\",\n \"createdAt\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"isBlacklist\": \"\"\n },\n {\n \"id\": \"\",\n \"contacts\": \"\",\n \"createdAt\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"isBlacklist\": \"\"\n }\n ],\n \"page\": \"\",\n \"totalPages\": \"\",\n \"totalCount\": \"\",\n \"totalFiltered\": \"\",\n \"hasPreviousPage\": \"\",\n \"hasNextPage\": \"\"\n}", "createdAt": "2026-07-28T00:28:34.000Z", "updatedAt": "2026-07-28T00:28:34.000Z", "uid": "35240-2d476d6c-411e-4d2c-a3fc-c602a504eee4" }, { "id": "7b457e5c-5ede-45b3-baf6-4e016650bf5b", "name": "Bad request error response", "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/groups?limit=20&offset=&name=", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "accounts", ":accountId", "groups" ], "query": [ { "description": "Number of items to include in the response", "key": "limit", "value": "20" }, { "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": "" }, { "description": "Group name to search for", "key": "name", "value": "" } ], "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 \"errorId\": \"\",\n \"timestamp\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-07-28T00:28:34.000Z", "updatedAt": "2026-07-28T00:28:34.000Z", "uid": "35240-7b457e5c-5ede-45b3-baf6-4e016650bf5b" } ], "createdAt": "2026-07-28T00:28:34.000Z", "updatedAt": "2026-07-28T00:28:34.000Z", "uid": "35240-3e6410f0-3fc3-4461-8739-a0b8c02a458f" }, { "name": "Create a group", "id": "eedef7a4-4cb1-431b-9a38-ec488246bd00", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"isBlacklist\": false\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v1/accounts/:accountId/groups", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "accounts", ":accountId", "groups" ], "variable": [ { "id": "d3d73680-3200-466d-9907-cca3ea5b7c48", "key": "accountId", "value": "c06f25f2a7ff-B3a496aD-AB1B0CcbC7de", "description": "(Required) You must replace *{accountId}* with the accountid that you want to use." } ] }, "description": "Create a group" }, "response": [ { "id": "b429e724-1d07-4878-8e5b-e0280743590a", "name": "Created", "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 \"name\": \"\",\n \"description\": \"\",\n \"isBlacklist\": false\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v1/accounts/:accountId/groups", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "accounts", ":accountId", "groups" ], "variable": [ { "key": "accountId" } ] } }, "status": "Created", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"id\": \"\",\n \"contacts\": \"\",\n \"createdAt\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"isBlacklist\": \"\"\n}", "createdAt": "2026-07-28T00:28:34.000Z", "updatedAt": "2026-07-28T00:28:34.000Z", "uid": "35240-b429e724-1d07-4878-8e5b-e0280743590a" }, { "id": "3efbe8eb-c8bf-4de5-991a-b1c2cb6844b6", "name": "Bad request error response", "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 \"name\": \"\",\n \"description\": \"\",\n \"isBlacklist\": false\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v1/accounts/:accountId/groups", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "accounts", ":accountId", "groups" ], "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 \"errorId\": \"\",\n \"timestamp\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-07-28T00:28:34.000Z", "updatedAt": "2026-07-28T00:28:34.000Z", "uid": "35240-3efbe8eb-c8bf-4de5-991a-b1c2cb6844b6" }, { "id": "ef7be615-ff50-4839-b8ae-1d185dd8e8de", "name": "Conflict: the group with the same name already exists", "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 \"name\": \"\",\n \"description\": \"\",\n \"isBlacklist\": false\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v1/accounts/:accountId/groups", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "accounts", ":accountId", "groups" ], "variable": [ { "key": "accountId" } ] } }, "status": "Conflict", "code": 409, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"code\": \"\",\n \"errorId\": \"\",\n \"timestamp\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-07-28T00:28:34.000Z", "updatedAt": "2026-07-28T00:28:34.000Z", "uid": "35240-ef7be615-ff50-4839-b8ae-1d185dd8e8de" } ], "createdAt": "2026-07-28T00:28:34.000Z", "updatedAt": "2026-07-28T00:28:34.000Z", "uid": "35240-eedef7a4-4cb1-431b-9a38-ec488246bd00" } ], "id": "a4f35ae7-2116-4bce-b5f6-45d07026e8c5", "createdAt": "2026-07-28T00:28:34.000Z", "updatedAt": "2026-07-28T00:28:34.000Z", "uid": "35240-a4f35ae7-2116-4bce-b5f6-45d07026e8c5" }, { "name": "batches", "item": [ { "name": "{batchId}", "item": [ { "name": "Get batch information by id", "id": "ce9f4e78-d3ee-4280-9f20-17e9e24fff05", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/accounts/:accountId/batches/:batchId", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "accounts", ":accountId", "batches", ":batchId" ], "variable": [ { "id": "d8c8a914-d92b-46af-86f7-f0216711f3c7", "key": "accountId", "value": "c06f25f2a7ff-B3a496aD-AB1B0CcbC7de", "description": "(Required) You must replace *{accountId}* with the accountid that you want to use." }, { "id": "09941b6a-1d96-4b3e-a0a7-af067da69e8f", "key": "batchId", "value": "", "description": "(Required) Batch Id" } ] }, "description": "Get batch information by id" }, "response": [ { "id": "791ca643-3d2c-428d-90d6-1709a4864d35", "name": "OK", "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/batches/:batchId", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "accounts", ":accountId", "batches", ":batchId" ], "variable": [ { "key": "accountId" }, { "key": "batchId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"id\": \"\",\n \"type\": \"deleteGroups\",\n \"status\": \"queued\",\n \"createdAt\": \"\"\n}", "createdAt": "2026-07-28T00:28:34.000Z", "updatedAt": "2026-07-28T00:28:34.000Z", "uid": "35240-791ca643-3d2c-428d-90d6-1709a4864d35" }, { "id": "882d6c5d-5c19-4534-8b2a-507f39370225", "name": "The entity doesn't exist", "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/batches/:batchId", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "accounts", ":accountId", "batches", ":batchId" ], "variable": [ { "key": "accountId" }, { "key": "batchId" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"code\": \"\",\n \"errorId\": \"\",\n \"timestamp\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-07-28T00:28:34.000Z", "updatedAt": "2026-07-28T00:28:34.000Z", "uid": "35240-882d6c5d-5c19-4534-8b2a-507f39370225" } ], "createdAt": "2026-07-28T00:28:34.000Z", "updatedAt": "2026-07-28T00:28:34.000Z", "uid": "35240-ce9f4e78-d3ee-4280-9f20-17e9e24fff05" } ], "id": "b0a9ef52-e46a-4ae9-a62b-6af914a06119", "createdAt": "2026-07-28T00:28:34.000Z", "updatedAt": "2026-07-28T00:28:34.000Z", "uid": "35240-b0a9ef52-e46a-4ae9-a62b-6af914a06119" }, { "name": "Get batch job list", "id": "f487b061-00cb-4299-a030-edc969430542", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/accounts/:accountId/batches?limit=20&offset=&type=deleteContacts", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "accounts", ":accountId", "batches" ], "query": [ { "description": "Number of items to include in the response", "key": "limit", "value": "20" }, { "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": "" }, { "description": "Use this parameter to filter by batch type", "key": "type", "value": "deleteContacts" } ], "variable": [ { "id": "51514263-0ae1-412a-9700-ecc5634b4a58", "key": "accountId", "value": "c06f25f2a7ff-B3a496aD-AB1B0CcbC7de", "description": "(Required) You must replace *{accountId}* with the accountid that you want to use." } ] }, "description": "Get batch job list" }, "response": [ { "id": "7fe18884-40fe-422c-b0fb-1be14732f69b", "name": "OK", "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/batches?limit=20&offset=&type=deleteContacts", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "accounts", ":accountId", "batches" ], "query": [ { "description": "Number of items to include in the response", "key": "limit", "value": "20" }, { "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": "" }, { "description": "Use this parameter to filter by batch type", "key": "type", "value": "deleteContacts" } ], "variable": [ { "key": "accountId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"items\": [\n {\n \"id\": \"\",\n \"type\": \"createContacts\",\n \"status\": \"failed\",\n \"createdAt\": \"\"\n }\n ],\n \"page\": \"\",\n \"totalPages\": \"\",\n \"totalCount\": \"\",\n \"totalFiltered\": \"\",\n \"hasPreviousPage\": \"\",\n \"hasNextPage\": \"\"\n}", "createdAt": "2026-07-28T00:28:34.000Z", "updatedAt": "2026-07-28T00:28:34.000Z", "uid": "35240-7fe18884-40fe-422c-b0fb-1be14732f69b" }, { "id": "cfbf2bba-7654-4c75-8bac-ea75a1063e9c", "name": "Bad request error response", "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/batches?limit=20&offset=&type=deleteContacts", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "accounts", ":accountId", "batches" ], "query": [ { "description": "Number of items to include in the response", "key": "limit", "value": "20" }, { "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": "" }, { "description": "Use this parameter to filter by batch type", "key": "type", "value": "deleteContacts" } ], "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 \"errorId\": \"\",\n \"timestamp\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-07-28T00:28:34.000Z", "updatedAt": "2026-07-28T00:28:34.000Z", "uid": "35240-cfbf2bba-7654-4c75-8bac-ea75a1063e9c" } ], "createdAt": "2026-07-28T00:28:34.000Z", "updatedAt": "2026-07-28T00:28:34.000Z", "uid": "35240-f487b061-00cb-4299-a030-edc969430542" } ], "id": "7949a224-23ed-41c0-baa0-fdff72baa76d", "createdAt": "2026-07-28T00:28:34.000Z", "updatedAt": "2026-07-28T00:28:34.000Z", "uid": "35240-7949a224-23ed-41c0-baa0-fdff72baa76d" } ], "id": "224822af-a735-430d-b322-bbc94ffe1bd7", "createdAt": "2026-07-28T00:28:34.000Z", "updatedAt": "2026-07-28T00:28:34.000Z", "uid": "35240-224822af-a735-430d-b322-bbc94ffe1bd7" } ], "id": "883dd263-72ff-4f4a-b751-a90ebd114154", "createdAt": "2026-07-28T00:28:34.000Z", "updatedAt": "2026-07-28T00:28:34.000Z", "uid": "35240-883dd263-72ff-4f4a-b751-a90ebd114154" } ], "id": "b7ba4d78-2b32-4181-9579-8d79b7f384b9", "createdAt": "2026-07-28T00:28:34.000Z", "updatedAt": "2026-07-28T00:28:34.000Z", "uid": "35240-b7ba4d78-2b32-4181-9579-8d79b7f384b9" } ], "id": "a9270ee2-7870-406d-8b9e-eb30ef85edf7", "createdAt": "2026-07-28T00:28:34.000Z", "updatedAt": "2026-07-28T00:28:34.000Z", "uid": "35240-a9270ee2-7870-406d-8b9e-eb30ef85edf7" } ], "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}", "type": "string" } ] }, "variable": [ { "key": "baseUrl", "value": "https://contacts.8x8.com" } ] }