{
"info": {
"_postman_id": "d06aed5c-9875-3f20-8c76-301600f7cbfd",
"name": "MessengerPeople API (Version 17)",
"description": "The collection of all API endpoints of the MessengerPeople API",
"version": 17,
"schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json"
},
"item": [
{
"id": "ddf3ac61-415b-3099-9f82-9b4d1e10f903",
"name": "[20] user",
"description": "",
"item": [
{
"id": "7e6dc0d2-1c2b-3cd4-8873-b9960b1fa3a7",
"name": "[00] Profile",
"description": {
"content": "Get profile information about one or multiple users. If the id is omitted users can be listed using various filters.",
"type": "text/markdown"
},
"request": {
"url": {
"protocol": "https",
"host": "{{api_url}}",
"path": [
"v{{api_version}}",
"user",
":id"
],
"variable": [
{
"id": "6423e116-658a-397b-9fe3-0f47ccc39eee",
"key": "id",
"name": "id",
"type": "mixed",
"description": "The user ID, number or secret hash code. Multiple ids can be separated by comma."
}
],
"query": [
{
"key": "apikey",
"value": "{{apikey}}",
"disabled": false,
"description": "The API key"
},
{
"key": "limit",
"value": "500",
"disabled": false,
"description": "The maximum number of results."
},
{
"key": "status",
"value": null,
"disabled": false,
"description": "Active and inactive users are listed per default. Use 1 for listing only active users and 0 for listing only inactive users."
},
{
"key": "offset",
"value": "0",
"disabled": false,
"description": "The number of skipped results."
},
{
"key": "blocked",
"value": null,
"disabled": false,
"description": "Set to 1 for listing only blocked users"
},
{
"key": "unreachable",
"value": null,
"disabled": false,
"description": "Set to 1 for listing only unreachable users"
},
{
"key": "targeting_id",
"value": "0",
"disabled": false,
"description": "List only active users of this targeting group."
},
{
"key": "search",
"value": null,
"disabled": false,
"description": "Users can be searched by id/phone number (if the search attribute is numeric) or by parts of their name or referral info."
},
{
"key": "order",
"value": "created",
"disabled": false,
"description": "User lists are ordered by creation date per default. stopped, id, name, messenger, blocked or last_chat can be specified to order by those attributes."
},
{
"key": "order",
"value": "created",
"disabled": false,
"description": "User lists are ordered by creation date per default. stopped, id, name, messenger, blocked, last_chat, last_in or last_out can be specified to order by those attributes."
},
{
"key": "asc",
"value": "0",
"disabled": false,
"description": "Normally user lists are sorted descending which means latest first."
},
{
"key": "last_chat",
"value": "0",
"disabled": false,
"description": "Set if the time of the last user chat (incoming) should be included.\nRetrieving the information costs more time."
},
{
"key": "last_chat",
"value": "0",
"disabled": false,
"description": "Set if the time of the last user chat (incoming or outgoing) should be included.\nRetrieving the information costs more time."
},
{
"key": "last_in",
"value": "0",
"disabled": false,
"description": "Set if the time of the last user chat (incoming) should be included.\nRetrieving the information costs more time."
},
{
"key": "last_out",
"value": "0",
"disabled": false,
"description": "Set if the time of the last user chat (outgoing) should be included.\nRetrieving the information costs more time."
},
{
"key": "last_message",
"value": "0",
"disabled": false,
"description": "Set if the last message (incoming or outgoing) should be included.\nNot available when using tickets."
},
{
"key": "unread",
"value": "0",
"disabled": false,
"description": "Set if the number of unread incoming chat messages should be included.\nNot available when using tickets."
},
{
"key": "customfields",
"value": "0",
"disabled": false,
"description": "Set if custom fields should be included."
},
{
"key": "filter",
"value": null,
"disabled": false,
"description": "A JSON array of user filter. If multiple filters are specified, all are applied. Each filter element can have the following elements: \n\ntype: mandatory type of the filter. Possible value is created or customfield \nafter: UNIX timestamp of created or last update of a customfield \nbefore: UNIX timestamp of created or last update of a customfield \nname: name of a custom field (default all) \nvalue: Value of a custom field\n"
},
{
"key": "inbotchat",
"value": null,
"disabled": false,
"description": "List only users whose latest chats have been with the chatbot without a ticket"
},
{
"key": "output_format",
"value": "json",
"disabled": false,
"description": "Possible values json or csv. Only applies for listing users."
}
]
},
"method": "GET",
"header": [
{
"key": "Content-Type",
"value": "application/json",
"disabled": false,
"description": "Enable JSON requests"
}
],
"body": null,
"description": {
"content": "Get profile information about one or multiple users. If the id is omitted users can be listed using various filters.",
"type": "text/markdown"
}
}
},
{
"id": "caacba9e-4af5-3db6-b31b-aaf4c049bb31",
"name": "[00] Update",
"description": {
"content": "Update properties of a user",
"type": "text/markdown"
},
"request": {
"url": {
"protocol": "https",
"host": "{{api_url}}",
"path": [
"v{{api_version}}",
"user",
":id"
],
"variable": [
{
"id": "88f97284-6d0d-338e-99e5-b648991cd375",
"key": "id",
"name": "id",
"type": "mixed",
"description": "The user ID, number or secret hash code. Multiple ids can be separated by comma."
}
],
"query": []
},
"method": "PUT",
"header": [
{
"key": "Content-Type",
"value": "application/json",
"disabled": false,
"description": "Enable JSON requests"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"apikey\": \"{{apikey}}\",\n \"fields\": \"\",\n \"unread\": 0\n}"
},
"description": {
"content": "Update properties of a user",
"type": "text/markdown"
}
}
},
{
"id": "7c5e7d95-2a1e-307a-b248-8e5da572a6d2",
"name": "[00] Upload CSV",
"description": {
"content": "Bulk update users by uploading a csv file.
\nWhatsApp, Facebook and Telegram user can be created with the upload as well.
\nThis is not a JSON Request, please use the default HTTP Multi Part Request",
"type": "text/markdown"
},
"request": {
"url": {
"protocol": "https",
"host": "{{api_url}}",
"path": [
"v{{api_version}}",
"user",
"csv"
],
"variable": [],
"query": []
},
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json",
"disabled": false,
"description": "Enable JSON requests"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"apikey\": \"{{apikey}}\",\n \"file\": null\n}"
},
"description": {
"content": "Bulk update users by uploading a csv file.
\nWhatsApp, Facebook and Telegram user can be created with the upload as well.
\nThis is not a JSON Request, please use the default HTTP Multi Part Request",
"type": "text/markdown"
}
}
},
{
"id": "5d636b49-2016-301c-b112-a1bfc1726ecb",
"name": "[00] Delete",
"description": {
"content": "Delete the user and his chats. Chats and information about the user are deleted immediately after this call.",
"type": "text/markdown"
},
"request": {
"url": {
"protocol": "https",
"host": "{{api_url}}",
"path": [
"v{{api_version}}",
"user",
":id"
],
"variable": [
{
"id": "1b1d11fc-5a22-3baa-8be4-fb73758e611d",
"key": "id",
"name": "id",
"type": "mixed",
"description": "The user ID, number or secret hash code. Multiple IDs can be separated by comma."
}
],
"query": [
{
"key": "apikey",
"value": "{{apikey}}",
"disabled": false,
"description": "The API key"
}
]
},
"method": "DELETE",
"header": [
{
"key": "Content-Type",
"value": "application/json",
"disabled": false,
"description": "Enable JSON requests"
}
],
"body": null,
"description": {
"content": "Delete the user and his chats. Chats and information about the user are deleted immediately after this call.",
"type": "text/markdown"
}
}
},
{
"id": "961beb2d-db12-3abd-8da8-c6375622e22d",
"name": "[00] Start",
"description": {
"content": "Activate a user for newsletters.",
"type": "text/markdown"
},
"request": {
"url": {
"protocol": "https",
"host": "{{api_url}}",
"path": [
"v{{api_version}}",
"user",
":id",
"start"
],
"variable": [
{
"id": "1b997c9e-51d2-3d57-9f17-5c78a01c8b3c",
"key": "id",
"name": "id",
"type": "mixed",
"description": "The user ID, number or secret hash code. Multiple IDs can be separated by comma."
}
],
"query": []
},
"method": "PUT",
"header": [
{
"key": "Content-Type",
"value": "application/json",
"disabled": false,
"description": "Enable JSON requests"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"apikey\": \"{{apikey}}\"\n}"
},
"description": {
"content": "Activate a user for newsletters.",
"type": "text/markdown"
}
}
},
{
"id": "601dc9d9-b21b-39e3-ab41-f75b2866a7fb",
"name": "[00] Stop",
"description": {
"content": "Deactivate a user for newsletters.",
"type": "text/markdown"
},
"request": {
"url": {
"protocol": "https",
"host": "{{api_url}}",
"path": [
"v{{api_version}}",
"user",
":id",
"stop"
],
"variable": [
{
"id": "a98153a0-8f52-3efb-9bfb-f0fccfa5e0a5",
"key": "id",
"name": "id",
"type": "mixed",
"description": "The user ID, number or secret hash code. Multiple IDs can be separated by comma."
}
],
"query": []
},
"method": "PUT",
"header": [
{
"key": "Content-Type",
"value": "application/json",
"disabled": false,
"description": "Enable JSON requests"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"apikey\": \"{{apikey}}\"\n}"
},
"description": {
"content": "Deactivate a user for newsletters.",
"type": "text/markdown"
}
}
},
{
"id": "55a87291-29b5-3042-946a-a777533a7c3b",
"name": "[00] Block",
"description": {
"content": "Block a user.",
"type": "text/markdown"
},
"request": {
"url": {
"protocol": "https",
"host": "{{api_url}}",
"path": [
"v{{api_version}}",
"user",
":id",
"block"
],
"variable": [
{
"id": "78547105-e41f-323f-becd-bf8d327a2d3a",
"key": "id",
"name": "id",
"type": "mixed",
"description": "The user ID, number or secret hash code. Multiple IDs can be separated by comma."
}
],
"query": []
},
"method": "PUT",
"header": [
{
"key": "Content-Type",
"value": "application/json",
"disabled": false,
"description": "Enable JSON requests"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"apikey\": \"{{apikey}}\"\n}"
},
"description": {
"content": "Block a user.",
"type": "text/markdown"
}
}
},
{
"id": "315e701f-eda8-3b2c-a10c-0bb7bd14c984",
"name": "[00] Unblock",
"description": {
"content": "Unblock a user that was previously blocked.",
"type": "text/markdown"
},
"request": {
"url": {
"protocol": "https",
"host": "{{api_url}}",
"path": [
"v{{api_version}}",
"user",
":id",
"unblock"
],
"variable": [
{
"id": "a11171b8-e931-3f99-b9a1-f9a094029bfd",
"key": "id",
"name": "id",
"type": "mixed",
"description": "The user ID, number or secret hash code. Multiple IDs can be separated by comma."
}
],
"query": []
},
"method": "PUT",
"header": [
{
"key": "Content-Type",
"value": "application/json",
"disabled": false,
"description": "Enable JSON requests"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"apikey\": \"{{apikey}}\"\n}"
},
"description": {
"content": "Unblock a user that was previously blocked.",
"type": "text/markdown"
}
}
},
{
"id": "ee1e5b27-00d6-3a62-a3fc-cb5e0c6f6c64",
"name": "[00] Categories",
"description": {
"content": "Get subscribed categories (Newsletter topics) of a user",
"type": "text/markdown"
},
"request": {
"url": {
"protocol": "https",
"host": "{{api_url}}",
"path": [
"v{{api_version}}",
"user",
":id",
"categories"
],
"variable": [
{
"id": "404a5e2f-8f75-393e-8e7d-6fc3e495f754",
"key": "id",
"name": "id",
"type": "mixed",
"description": "The user ID, number or secret hash code. Multiple IDs can be separated by comma."
}
],
"query": [
{
"key": "apikey",
"value": "{{apikey}}",
"disabled": false,
"description": "The API key"
}
]
},
"method": "GET",
"header": [
{
"key": "Content-Type",
"value": "application/json",
"disabled": false,
"description": "Enable JSON requests"
}
],
"body": null,
"description": {
"content": "Get subscribed categories (Newsletter topics) of a user",
"type": "text/markdown"
}
}
},
{
"id": "2e7dd834-ce2a-3279-b83d-8d6b90ec12b9",
"name": "[00] Categories",
"description": {
"content": "Set categories (Newsletter topics) of a user",
"type": "text/markdown"
},
"request": {
"url": {
"protocol": "https",
"host": "{{api_url}}",
"path": [
"v{{api_version}}",
"user",
":id",
"categories"
],
"variable": [
{
"id": "2d37073d-dfa7-31fb-96b7-f5de96b4e227",
"key": "id",
"name": "id",
"type": "mixed",
"description": "The user ID, number or secret hash code. Multiple IDs can be separated by comma."
}
],
"query": []
},
"method": "PUT",
"header": [
{
"key": "Content-Type",
"value": "application/json",
"disabled": false,
"description": "Enable JSON requests"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"apikey\": \"{{apikey}}\",\n \"category_id\": 0,\n \"status\": false\n}"
},
"description": {
"content": "Set categories (Newsletter topics) of a user",
"type": "text/markdown"
}
}
},
{
"id": "644e5064-ea60-3570-97d6-f04b247b3f7c",
"name": "[00] Note",
"description": {
"content": "Add a note to the user",
"type": "text/markdown"
},
"request": {
"url": {
"protocol": "https",
"host": "{{api_url}}",
"path": [
"v{{api_version}}",
"user",
":id",
"note"
],
"variable": [
{
"id": "b2e5416a-3d66-3dc2-9821-86cc19db6580",
"key": "id",
"name": "id",
"type": "mixed",
"description": "The user ID, number or secret hash code. Multiple IDs can be separated by comma."
}
],
"query": []
},
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json",
"disabled": false,
"description": "Enable JSON requests"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"apikey\": \"{{apikey}}\",\n \"note\": \"\"\n}"
},
"description": {
"content": "Add a note to the user",
"type": "text/markdown"
}
}
},
{
"id": "7da97f92-d5bb-3f69-a7b0-b88c2446b8e4",
"name": "[00] Create",
"description": {
"content": "Create a new user for the specified messenger",
"type": "text/markdown"
},
"request": {
"url": {
"protocol": "https",
"host": "{{api_url}}",
"path": [
"v{{api_version}}",
"user"
],
"variable": [],
"query": []
},
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json",
"disabled": false,
"description": "Enable JSON requests"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"apikey\": \"{{apikey}}\",\n \"id\": \"\",\n \"messenger\": \"\",\n \"name\": \"\",\n \"status\": 0\n}"
},
"description": {
"content": "Create a new user for the specified messenger",
"type": "text/markdown"
}
}
},
{
"id": "3a6caba0-d250-3ed9-8d02-d9d3c9ddb8fd",
"name": "[00] Property",
"description": {
"content": "Get a user property for a list of users",
"type": "text/markdown"
},
"request": {
"url": {
"protocol": "https",
"host": "{{api_url}}",
"path": [
"v{{api_version}}",
"user",
"property"
],
"variable": [],
"query": [
{
"key": "apikey",
"value": "{{apikey}}",
"disabled": false,
"description": "The API key"
},
{
"key": "id",
"value": null,
"disabled": false,
"description": "A comma-separated list of user numbers. Leave empty to list all users with the property."
},
{
"key": "name",
"value": null,
"disabled": false,
"description": "The name of the user property"
}
]
},
"method": "GET",
"header": [
{
"key": "Content-Type",
"value": "application/json",
"disabled": false,
"description": "Enable JSON requests"
}
],
"body": null,
"description": {
"content": "Get a user property for a list of users",
"type": "text/markdown"
}
}
},
{
"id": "3dd95a57-1b76-3d47-8bbe-9dab83deef29",
"name": "[00] Property",
"description": {
"content": "Update a user property of a list of users",
"type": "text/markdown"
},
"request": {
"url": {
"protocol": "https",
"host": "{{api_url}}",
"path": [
"v{{api_version}}",
"user",
"property"
],
"variable": [],
"query": []
},
"method": "PUT",
"header": [
{
"key": "Content-Type",
"value": "application/json",
"disabled": false,
"description": "Enable JSON requests"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"apikey\": \"{{apikey}}\",\n \"id\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n}"
},
"description": {
"content": "Update a user property of a list of users",
"type": "text/markdown"
}
}
}
]
},
{
"id": "7b0f8fbf-7a8a-3080-8746-edbe21705e3e",
"name": "[30] User properties",
"description": "",
"item": [
{
"id": "b30ce932-7dbf-3af4-9e1c-da01af9f0b7e",
"name": "[00] Properties",
"description": {
"content": "Get all user properties",
"type": "text/markdown"
},
"request": {
"url": {
"protocol": "https",
"host": "{{api_url}}",
"path": [
"v{{api_version}}",
"custom",
":id"
],
"variable": [
{
"id": "ff700fc5-44dc-387b-a31e-cd75628fa7cd",
"key": "id",
"name": "id",
"type": "mixed",
"description": "The field ID or name"
}
],
"query": [
{
"key": "apikey",
"value": "{{apikey}}",
"disabled": false,
"description": "The API key"
},
{
"key": "hidden",
"value": null,
"disabled": false,
"description": "Set to 1 if hidden fields should be included."
}
]
},
"method": "GET",
"header": [
{
"key": "Content-Type",
"value": "application/json",
"disabled": false,
"description": "Enable JSON requests"
}
],
"body": null,
"description": {
"content": "Get all user properties",
"type": "text/markdown"
}
}
},
{
"id": "7ea45ab9-5f3a-37ce-a084-23daf0eb5dea",
"name": "[00] Create",
"description": {
"content": "Create a new user property",
"type": "text/markdown"
},
"request": {
"url": {
"protocol": "https",
"host": "{{api_url}}",
"path": [
"v{{api_version}}",
"custom"
],
"variable": [],
"query": []
},
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json",
"disabled": false,
"description": "Enable JSON requests"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"apikey\": \"{{apikey}}\",\n \"name\": \"\",\n \"type\": \"\",\n \"values\": \"\",\n \"expiration\": 0,\n \"user_visible\": false,\n \"label\": \"\",\n \"position\": 0,\n \"limited_access\": \"0\",\n \"agent_visible\": \"1\",\n \"agent_readonly\": \"0\",\n \"hidden\": \"0\",\n \"default_value\": \"\"\n}"
},
"description": {
"content": "Create a new user property",
"type": "text/markdown"
}
}
},
{
"id": "70862df2-7492-3f2c-a54a-c21fe16f0404",
"name": "[00] Update",
"description": {
"content": "Update a user property",
"type": "text/markdown"
},
"request": {
"url": {
"protocol": "https",
"host": "{{api_url}}",
"path": [
"v{{api_version}}",
"custom"
],
"variable": [],
"query": []
},
"method": "PUT",
"header": [
{
"key": "Content-Type",
"value": "application/json",
"disabled": false,
"description": "Enable JSON requests"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"apikey\": \"{{apikey}}\",\n \"id\": null,\n \"name\": \"\",\n \"type\": \"\",\n \"values\": \"\",\n \"expiration\": 0,\n \"user_visible\": false,\n \"label\": \"\",\n \"position\": 0,\n \"limited_access\": \"0\",\n \"agent_visible\": \"1\",\n \"agent_readonly\": \"0\",\n \"hidden\": \"0\",\n \"default_value\": \"\"\n}"
},
"description": {
"content": "Update a user property",
"type": "text/markdown"
}
}
},
{
"id": "46ed8085-2613-38f9-963d-8f2070224cf9",
"name": "[00] Delete",
"description": {
"content": "Delete a user property",
"type": "text/markdown"
},
"request": {
"url": {
"protocol": "https",
"host": "{{api_url}}",
"path": [
"v{{api_version}}",
"custom"
],
"variable": [],
"query": [
{
"key": "apikey",
"value": "{{apikey}}",
"disabled": false,
"description": "The API key"
},
{
"key": "id",
"value": null,
"disabled": false,
"description": "The property ID or name"
}
]
},
"method": "DELETE",
"header": [
{
"key": "Content-Type",
"value": "application/json",
"disabled": false,
"description": "Enable JSON requests"
}
],
"body": null,
"description": {
"content": "Delete a user property",
"type": "text/markdown"
}
}
}
]
},
{
"id": "50a76922-30c8-3933-beda-a85b57dfdcd3",
"name": "[40] User-Chat",
"description": "",
"item": [
{
"id": "a19fd295-09a3-312c-b14a-7892c1c6b7d2",
"name": "[00] Chat Messages",
"description": {
"content": "Get the chat messages of a user ordered by chat time latest first. \nThe result includes the send_status with the following possible values (availability depending on the messenger):
\n0 = sending in progress
1 = sent (in WhatsApp and Viber
2 = delivered)
3 = read
-1 = failed
-2 = user rejected, left the channel or 24 hour window is exceeded
",
"type": "text/markdown"
},
"request": {
"url": {
"protocol": "https",
"host": "{{api_url}}",
"path": [
"v{{api_version}}",
"chat"
],
"variable": [],
"query": [
{
"key": "apikey",
"value": "{{apikey}}",
"disabled": false,
"description": "The API key"
},
{
"key": "id",
"value": null,
"disabled": false,
"description": "The user ID, number or secret hash code. Multiple ids can be separated by comma."
},
{
"key": "limit",
"value": "50",
"disabled": false,
"description": "This maximum number of results."
},
{
"key": "showstartstop",
"value": "0",
"disabled": false,
"description": "Show newsletter start and stop messages of users."
}
]
},
"method": "GET",
"header": [
{
"key": "Content-Type",
"value": "application/json",
"disabled": false,
"description": "Enable JSON requests"
}
],
"body": null,
"description": {
"content": "Get the chat messages of a user ordered by chat time latest first. \nThe result includes the send_status with the following possible values (availability depending on the messenger):
\n0 = sending in progress
1 = sent (in WhatsApp and Viber
2 = delivered)
3 = read
-1 = failed
-2 = user rejected, left the channel or 24 hour window is exceeded
",
"type": "text/markdown"
}
}
},
{
"id": "5f7e60b3-1038-3c54-9e0b-d18892ce4580",
"name": "[00] Send Message",
"description": {
"content": "Send a message to a user or to multiple users",
"type": "text/markdown"
},
"request": {
"url": {
"protocol": "https",
"host": "{{api_url}}",
"path": [
"v{{api_version}}",
"chat"
],
"variable": [],
"query": []
},
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json",
"disabled": false,
"description": "Enable JSON requests"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"apikey\": \"{{apikey}}\",\n \"id\": null,\n \"message\": \"\",\n \"attachment\": \"\",\n \"filename\": \"\",\n \"conversation_status\": false,\n \"buttons\": \"\",\n \"meta\": null,\n \"batch_ids\": null,\n \"user_filter\": \"\",\n \"schedule\": 0\n}"
},
"description": {
"content": "Send a message to a user or to multiple users",
"type": "text/markdown"
}
}
},
{
"id": "9600a6a3-9612-38bd-8e11-d0342edc7b97",
"name": "[00] Send Notification",
"description": {
"content": "Send a notification to a user or to multiple users in WhatsApp Business",
"type": "text/markdown"
},
"request": {
"url": {
"protocol": "https",
"host": "{{api_url}}",
"path": [
"v{{api_version}}",
"chat",
"notification"
],
"variable": [],
"query": []
},
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json",
"disabled": false,
"description": "Enable JSON requests"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"apikey\": \"{{apikey}}\",\n \"id\": null,\n \"notification\": \"\",\n \"parameters\": \"\",\n \"language\": \"\",\n \"batch_ids\": null,\n \"user_filter\": \"\",\n \"notification_template\": \"\",\n \"notification_body_variables\": \"\",\n \"notification_header_media\": \"\",\n \"notification_header_variable\": \"\",\n \"notification_button_variable\": \"\",\n \"notification_language\": \"\",\n \"schedule\": 0\n}"
},
"description": {
"content": "Send a notification to a user or to multiple users in WhatsApp Business",
"type": "text/markdown"
}
}
},
{
"id": "87588e82-9671-3ca1-bf2b-7effcc4c1896",
"name": "[00] Bot Chat",
"description": {
"content": "Start a bot conversation with a user by sending a botchat. The bot_active flag of an associated ticket will be set and the bot topic will be activated for the user.",
"type": "text/markdown"
},
"request": {
"url": {
"protocol": "https",
"host": "{{api_url}}",
"path": [
"v{{api_version}}",
"chat",
"bot"
],
"variable": [],
"query": []
},
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json",
"disabled": false,
"description": "Enable JSON requests"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"apikey\": \"{{apikey}}\",\n \"id\": null,\n \"topic_id\": 0,\n \"chat_id\": 0,\n \"customfields\": \"\",\n \"user_filter\": \"\"\n}"
},
"description": {
"content": "Start a bot conversation with a user by sending a botchat. The bot_active flag of an associated ticket will be set and the bot topic will be activated for the user.",
"type": "text/markdown"
}
}
},
{
"id": "c556eb65-5809-3b59-99be-ec893a36aa59",
"name": "[00] Typing",
"description": {
"content": "Send a start or end typing event to a user. Currently only supported for Apple Messages for Business.",
"type": "text/markdown"
},
"request": {
"url": {
"protocol": "https",
"host": "{{api_url}}",
"path": [
"v{{api_version}}",
"chat",
"typing"
],
"variable": [],
"query": []
},
"method": "PUT",
"header": [
{
"key": "Content-Type",
"value": "application/json",
"disabled": false,
"description": "Enable JSON requests"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"apikey\": \"{{apikey}}\",\n \"id\": null,\n \"start\": \"1\"\n}"
},
"description": {
"content": "Send a start or end typing event to a user. Currently only supported for Apple Messages for Business.",
"type": "text/markdown"
}
}
},
{
"id": "4155774c-439b-3c72-82c1-cf55187d6fb3",
"name": "[00] Delete",
"description": {
"content": "Delete a single incoming chat by overwriting its text with \"_chat_deleted\" and removing all attachments",
"type": "text/markdown"
},
"request": {
"url": {
"protocol": "https",
"host": "{{api_url}}",
"path": [
"v{{api_version}}",
"chat"
],
"variable": [],
"query": [
{
"key": "apikey",
"value": "{{apikey}}",
"disabled": false,
"description": "The API key"
},
{
"key": "id",
"value": null,
"disabled": false,
"description": "The id of the chat that should be deleted"
}
]
},
"method": "DELETE",
"header": [
{
"key": "Content-Type",
"value": "application/json",
"disabled": false,
"description": "Enable JSON requests"
}
],
"body": null,
"description": {
"content": "Delete a single incoming chat by overwriting its text with \"_chat_deleted\" and removing all attachments",
"type": "text/markdown"
}
}
}
]
},
{
"id": "b1854957-8c3f-3f84-a938-60b02bea41a4",
"name": "[50] channel",
"description": "",
"item": [
{
"id": "7c7653d7-8e6a-317a-adfc-4c57e765d31f",
"name": "[00] Properties",
"description": {
"content": "Get a list of all channels an agent has access to (also the ones that are not assigned)",
"type": "text/markdown"
},
"request": {
"url": {
"protocol": "https",
"host": "{{api_url}}",
"path": [
"v{{api_version}}",
"channel",
"list"
],
"variable": [],
"query": [
{
"key": "apikey",
"value": "{{apikey}}",
"disabled": false,
"description": "The API key"
}
]
},
"method": "GET",
"header": [
{
"key": "Content-Type",
"value": "application/json",
"disabled": false,
"description": "Enable JSON requests"
}
],
"body": null,
"description": {
"content": "Get a list of all channels an agent has access to (also the ones that are not assigned)",
"type": "text/markdown"
}
}
},
{
"id": "30f9d9c7-e5c1-3c6e-aba1-a9cddde24b15",
"name": "[10] Properties",
"description": {
"content": "Get properties of the channel",
"type": "text/markdown"
},
"request": {
"url": {
"protocol": "https",
"host": "{{api_url}}",
"path": [
"v{{api_version}}",
"channel"
],
"variable": [],
"query": [
{
"key": "apikey",
"value": "{{apikey}}",
"disabled": false,
"description": "The API key"
}
]
},
"method": "GET",
"header": [
{
"key": "Content-Type",
"value": "application/json",
"disabled": false,
"description": "Enable JSON requests"
}
],
"body": null,
"description": {
"content": "Get properties of the channel",
"type": "text/markdown"
}
}
},
{
"id": "a86cd3b6-696b-3c1b-9b52-c7142c2c6237",
"name": "[20] Update",
"description": {
"content": "Update properties of the channel",
"type": "text/markdown"
},
"request": {
"url": {
"protocol": "https",
"host": "{{api_url}}",
"path": [
"v{{api_version}}",
"channel"
],
"variable": [],
"query": []
},
"method": "PUT",
"header": [
{
"key": "Content-Type",
"value": "application/json",
"disabled": false,
"description": "Enable JSON requests"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"apikey\": \"{{apikey}}\",\n \"name\": \"\",\n \"statusmessage\": \"\",\n \"welcomemessage\": \"\",\n \"new_ticket_message\": \"\",\n \"read_confirmation\": false,\n \"linkpreview\": false,\n \"every_word_starts\": false,\n \"startword\": \"\",\n \"timezone\": \"\",\n \"inactive_delete_timeout\": 0,\n \"language\": \"\",\n \"image\": \"\",\n \"ticket_overdue_time\": 0,\n \"ticket_critical_time\": 0,\n \"ticket_open_if_bot\": false,\n \"ticket_reopen_period\": 0,\n \"ticket_auto_close_time\": 0,\n \"ticket_use_autoroutes\": false,\n \"ticket_auto_assign\": false,\n \"ticket_assign_last_agent\": false,\n \"ticket_deactivate_bot\": 0,\n \"ui_settings\": \"\",\n \"ticket_max_per_agent\": 0,\n \"ticket_assign_online_agent\": false,\n \"ticket_assign_by_keywords\": false,\n \"ticket_for_instagram_story\": \"1\",\n \"applepay_settings\": \"\",\n \"enable_urltracking\": false,\n \"urltracking_parameters\": \"\",\n \"categories_info_in_welcome\": false,\n \"categories_info\": \"\",\n \"use_content_notifications\": false,\n \"content_pull_num\": \"1\",\n \"content_pull_time\": 0,\n \"content_notifications\": \"\",\n \"content_pulled_all\": \"\",\n \"content_pull_hint\": \"\",\n \"notify_installed\": \"\",\n \"notify_image\": \"\",\n \"notify_description\": \"\",\n \"notify_chat\": false,\n \"notify_status\": \"\",\n \"promo\": \"\",\n \"welcomemessage_mia\": \"\",\n \"welcomemessage_mia_notify\": \"\",\n \"goodbye_message\": \"\",\n \"privacy_link\": \"\",\n \"mia_push\": false,\n \"deallocate_on_reopen\": false,\n \"facebook_stop_timeout\": 0,\n \"notify_stop_timeout\": 0,\n \"use_menu\": false,\n \"delete_chat\": false,\n \"mandatory_note_on_ticket_close \": \" 0\",\n \"webchat_availability\": \"\",\n \"multi_channel_events \": \" 0\"\n}"
},
"description": {
"content": "Update properties of the channel",
"type": "text/markdown"
}
}
},
{
"id": "af9d3da1-568a-30a5-8648-948b447da058",
"name": "[30] Chats",
"description": {
"content": "Get all chat messages of the channel ordered by chat time latest first.
\nThe result includes the send_status with the following possible values (availability depending on the messenger):
\n0 = sending in progress, 1 = sent (in WhatsApp and Viber 2 = delivered), 3 = read, -1 = failed, -2 = user rejected, left the channel or 24 hour window is exceeded, \n
Sent notifications are marked with notification: true",
"type": "text/markdown"
},
"request": {
"url": {
"protocol": "https",
"host": "{{api_url}}",
"path": [
"v{{api_version}}",
"channel",
"chats"
],
"variable": [],
"query": [
{
"key": "apikey",
"value": "{{apikey}}",
"disabled": false,
"description": "The API key"
},
{
"key": "limit",
"value": "50",
"disabled": false,
"description": "The maximum number of results."
},
{
"key": "start",
"value": null,
"disabled": false,
"description": "List only chat messages with a larger ID ordered by ID ascending."
},
{
"key": "start",
"value": null,
"disabled": false,
"description": "List only chat messages with a smaller ID."
},
{
"key": "start",
"value": null,
"disabled": false,
"description": "List only chat messages with a smaller or bigger ID, depending on the sorting."
},
{
"key": "chattime",
"value": null,
"disabled": false,
"description": "List only chat messages with a chattime that is later."
},
{
"key": "incoming",
"value": "1",
"disabled": false,
"description": "Show incoming messages."
},
{
"key": "outgoing",
"value": "1",
"disabled": false,
"description": "Show outgoing messages."
},
{
"key": "chatmeta",
"value": "0",
"disabled": false,
"description": "Include chat meta information"
},
{
"key": "search_string",
"value": null,
"disabled": false,
"description": "Only messages that contain this substring will be returned ."
},
{
"key": "bot",
"value": "0",
"disabled": false,
"description": "Show automated / bot messages if bot = 1. If bot = 2 include also welcome and stop messages."
},
{
"key": "asc",
"value": "0",
"disabled": false,
"description": "Sort list with earliest first."
}
]
},
"method": "GET",
"header": [
{
"key": "Content-Type",
"value": "application/json",
"disabled": false,
"description": "Enable JSON requests"
}
],
"body": null,
"description": {
"content": "Get all chat messages of the channel ordered by chat time latest first.
\nThe result includes the send_status with the following possible values (availability depending on the messenger):
\n0 = sending in progress, 1 = sent (in WhatsApp and Viber 2 = delivered), 3 = read, -1 = failed, -2 = user rejected, left the channel or 24 hour window is exceeded, \n
Sent notifications are marked with notification: true",
"type": "text/markdown"
}
}
},
{
"id": "d2c98b30-fcd9-3bb0-9243-ff27cf8b0890",
"name": "[40] Teams",
"description": {
"content": "Get the teams of the channel",
"type": "text/markdown"
},
"request": {
"url": {
"protocol": "https",
"host": "{{api_url}}",
"path": [
"v{{api_version}}",
"channel",
"teams"
],
"variable": [],
"query": [
{
"key": "apikey",
"value": "{{apikey}}",
"disabled": false,
"description": "The API key"
}
]
},
"method": "GET",
"header": [
{
"key": "Content-Type",
"value": "application/json",
"disabled": false,
"description": "Enable JSON requests"
}
],
"body": null,
"description": {
"content": "Get the teams of the channel",
"type": "text/markdown"
}
}
},
{
"id": "ce180703-7623-3bc4-8b8f-14a645b1bb0d",
"name": "[50] Teams",
"description": {
"content": "Create a new team for a channel",
"type": "text/markdown"
},
"request": {
"url": {
"protocol": "https",
"host": "{{api_url}}",
"path": [
"v{{api_version}}",
"channel",
"teams"
],
"variable": [],
"query": []
},
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json",
"disabled": false,
"description": "Enable JSON requests"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"apikey\": \"{{apikey}}\",\n \"name\": \"\",\n \"add_agent\": null\n}"
},
"description": {
"content": "Create a new team for a channel",
"type": "text/markdown"
}
}
},
{
"id": "a0b071a2-6b45-3876-a88b-7acddabe4469",
"name": "[60] Teams",
"description": {
"content": "Update teams of a channel",
"type": "text/markdown"
},
"request": {
"url": {
"protocol": "https",
"host": "{{api_url}}",
"path": [
"v{{api_version}}",
"channel",
"teams"
],
"variable": [],
"query": []
},
"method": "PUT",
"header": [
{
"key": "Content-Type",
"value": "application/json",
"disabled": false,
"description": "Enable JSON requests"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"apikey\": \"{{apikey}}\",\n \"id\": null,\n \"name\": \"\",\n \"add_agent\": null,\n \"remove_agent\": null\n}"
},
"description": {
"content": "Update teams of a channel",
"type": "text/markdown"
}
}
},
{
"id": "46fba337-a966-3577-89a5-c3cfab512c5f",
"name": "[70] Teams",
"description": {
"content": "Delete teams of a channel",
"type": "text/markdown"
},
"request": {
"url": {
"protocol": "https",
"host": "{{api_url}}",
"path": [
"v{{api_version}}",
"channel",
"teams"
],
"variable": [],
"query": [
{
"key": "apikey",
"value": "{{apikey}}",
"disabled": false,
"description": "The API key"
},
{
"key": "id",
"value": null,
"disabled": false,
"description": "The team ID. Multiple IDs can be separated by comma."
}
]
},
"method": "DELETE",
"header": [
{
"key": "Content-Type",
"value": "application/json",
"disabled": false,
"description": "Enable JSON requests"
}
],
"body": null,
"description": {
"content": "Delete teams of a channel",
"type": "text/markdown"
}
}
},
{
"id": "96962e81-bcb9-3d94-af23-006d19164654",
"name": "[80] Agents",
"description": {
"content": "Get the agents of the channel",
"type": "text/markdown"
},
"request": {
"url": {
"protocol": "https",
"host": "{{api_url}}",
"path": [
"v{{api_version}}",
"channel",
"agents"
],
"variable": [],
"query": [
{
"key": "apikey",
"value": "{{apikey}}",
"disabled": false,
"description": "The API key"
}
]
},
"method": "GET",
"header": [
{
"key": "Content-Type",
"value": "application/json",
"disabled": false,
"description": "Enable JSON requests"
}
],
"body": null,
"description": {
"content": "Get the agents of the channel",
"type": "text/markdown"
}
}
},
{
"id": "2b20e2b8-124b-33d0-9344-a71462c8b06a",
"name": "[85] Online agent IDs",
"description": {
"content": "Get a list of ids of online agents of the channel",
"type": "text/markdown"
},
"request": {
"url": {
"protocol": "https",
"host": "{{api_url}}",
"path": [
"v{{api_version}}",
"channel",
"online_agents"
],
"variable": [],
"query": [
{
"key": "apikey",
"value": "{{apikey}}",
"disabled": false,
"description": "The API key"
},
{
"key": "other_channels",
"value": "0",
"disabled": false,
"description": "Get online agents from other channels of this account"
}
]
},
"method": "GET",
"header": [
{
"key": "Content-Type",
"value": "application/json",
"disabled": false,
"description": "Enable JSON requests"
}
],
"body": null,
"description": {
"content": "Get a list of ids of online agents of the channel",
"type": "text/markdown"
}
}
},
{
"id": "d0a7cc57-5722-354c-a844-38c0e0f36779",
"name": "[90] Labels",
"description": {
"content": "Get the labels (tags) of the channel",
"type": "text/markdown"
},
"request": {
"url": {
"protocol": "https",
"host": "{{api_url}}",
"path": [
"v{{api_version}}",
"channel",
"labels"
],
"variable": [],
"query": [
{
"key": "apikey",
"value": "{{apikey}}",
"disabled": false,
"description": "The API key"
}
]
},
"method": "GET",
"header": [
{
"key": "Content-Type",
"value": "application/json",
"disabled": false,
"description": "Enable JSON requests"
}
],
"body": null,
"description": {
"content": "Get the labels (tags) of the channel",
"type": "text/markdown"
}
}
},
{
"id": "ccb631b0-6fbc-3e14-9f66-33b2079a4499",
"name": "[100] Labels",
"description": {
"content": "Create a label (tag) for a channel",
"type": "text/markdown"
},
"request": {
"url": {
"protocol": "https",
"host": "{{api_url}}",
"path": [
"v{{api_version}}",
"channel",
"labels"
],
"variable": [],
"query": []
},
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json",
"disabled": false,
"description": "Enable JSON requests"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"apikey\": \"{{apikey}}\",\n \"name\": \"\",\n \"color_bg\": \"\",\n \"color_tx\": \"\"\n}"
},
"description": {
"content": "Create a label (tag) for a channel",
"type": "text/markdown"
}
}
},
{
"id": "0575f304-0fd1-3632-b764-b01a03ddb55b",
"name": "[110] Labels",
"description": {
"content": "Update a label (tag) of a channel",
"type": "text/markdown"
},
"request": {
"url": {
"protocol": "https",
"host": "{{api_url}}",
"path": [
"v{{api_version}}",
"channel",
"labels"
],
"variable": [],
"query": []
},
"method": "PUT",
"header": [
{
"key": "Content-Type",
"value": "application/json",
"disabled": false,
"description": "Enable JSON requests"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"apikey\": \"{{apikey}}\",\n \"id\": null,\n \"name\": \"\",\n \"color_bg\": \"\",\n \"color_tx\": \"\"\n}"
},
"description": {
"content": "Update a label (tag) of a channel",
"type": "text/markdown"
}
}
},
{
"id": "c8850a12-b9e8-3653-af13-c06c6a84c82a",
"name": "[120] Labels",
"description": {
"content": "Delete labels (tags) of a channel",
"type": "text/markdown"
},
"request": {
"url": {
"protocol": "https",
"host": "{{api_url}}",
"path": [
"v{{api_version}}",
"channel",
"labels"
],
"variable": [],
"query": [
{
"key": "apikey",
"value": "{{apikey}}",
"disabled": false,
"description": "The API key"
},
{
"key": "id",
"value": null,
"disabled": false,
"description": "The label ID. Multiple IDs can be separated by comma."
}
]
},
"method": "DELETE",
"header": [
{
"key": "Content-Type",
"value": "application/json",
"disabled": false,
"description": "Enable JSON requests"
}
],
"body": null,
"description": {
"content": "Delete labels (tags) of a channel",
"type": "text/markdown"
}
}
},
{
"id": "a863024d-5f96-3276-a5b8-446863655ab9",
"name": "[130] Facebook",
"description": {
"content": "Get Facebook connection info of the channel",
"type": "text/markdown"
},
"request": {
"url": {
"protocol": "https",
"host": "{{api_url}}",
"path": [
"v{{api_version}}",
"channel",
"facebook"
],
"variable": [],
"query": [
{
"key": "apikey",
"value": "{{apikey}}",
"disabled": false,
"description": "The API key"
}
]
},
"method": "GET",
"header": [
{
"key": "Content-Type",
"value": "application/json",
"disabled": false,
"description": "Enable JSON requests"
}
],
"body": null,
"description": {
"content": "Get Facebook connection info of the channel",
"type": "text/markdown"
}
}
},
{
"id": "e31e000d-5b62-3bd3-ba55-7a1c9d971286",
"name": "[140] Facebook",
"description": {
"content": "Update Facebook confirmation and get-started information or (dis)connect to the Facebook page",
"type": "text/markdown"
},
"request": {
"url": {
"protocol": "https",
"host": "{{api_url}}",
"path": [
"v{{api_version}}",
"channel",
"facebook"
],
"variable": [],
"query": []
},
"method": "PUT",
"header": [
{
"key": "Content-Type",
"value": "application/json",
"disabled": false,
"description": "Enable JSON requests"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"apikey\": \"{{apikey}}\",\n \"confirm\": \"0\",\n \"confirm_text\": \"\",\n \"get_started\": \"0\",\n \"get_started_text\": \"\",\n \"access_token\": \"\",\n \"page_id\": 0,\n \"page_name\": \"\"\n}"
},
"description": {
"content": "Update Facebook confirmation and get-started information or (dis)connect to the Facebook page",
"type": "text/markdown"
}
}
},
{
"id": "6a9be151-aa42-3965-83d8-6834674a9c98",
"name": "[150] Facebook",
"description": {
"content": "Delete Facebook connection of a channel",
"type": "text/markdown"
},
"request": {
"url": {
"protocol": "https",
"host": "{{api_url}}",
"path": [
"v{{api_version}}",
"channel",
"facebook"
],
"variable": [],
"query": [
{
"key": "apikey",
"value": "{{apikey}}",
"disabled": false,
"description": "The API key"
}
]
},
"method": "DELETE",
"header": [
{
"key": "Content-Type",
"value": "application/json",
"disabled": false,
"description": "Enable JSON requests"
}
],
"body": null,
"description": {
"content": "Delete Facebook connection of a channel",
"type": "text/markdown"
}
}
},
{
"id": "1efdb4ca-b54b-35e0-b647-55b8cdcb235a",
"name": "[160] Webhook",
"description": {
"content": "Get current webhook settings",
"type": "text/markdown"
},
"request": {
"url": {
"protocol": "https",
"host": "{{api_url}}",
"path": [
"v{{api_version}}",
"channel",
"webhook"
],
"variable": [],
"query": [
{
"key": "apikey",
"value": "{{apikey}}",
"disabled": false,
"description": "The API key"
}
]
},
"method": "GET",
"header": [
{
"key": "Content-Type",
"value": "application/json",
"disabled": false,
"description": "Enable JSON requests"
}
],
"body": null,
"description": {
"content": "Get current webhook settings",
"type": "text/markdown"
}
}
},
{
"id": "441b3c00-62ac-3121-9397-1f0e0aaddb30",
"name": "[170] Webhook",
"description": {
"content": "Activate / Deactivate / Test Webhook \nAn active WebHook will be used to inform an external system whenever a new chat message is sent from a user to a channel.",
"type": "text/markdown"
},
"request": {
"url": {
"protocol": "https",
"host": "{{api_url}}",
"path": [
"v{{api_version}}",
"channel",
"webhook"
],
"variable": [],
"query": []
},
"method": "PUT",
"header": [
{
"key": "Content-Type",
"value": "application/json",
"disabled": false,
"description": "Enable JSON requests"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"apikey\": \"{{apikey}}\",\n \"webhook_url\": \"\",\n \"status\": false,\n \"webhook_email\": \"\",\n \"webhook_fields\": \"\",\n \"send_test\": false\n}"
},
"description": {
"content": "Activate / Deactivate / Test Webhook \nAn active WebHook will be used to inform an external system whenever a new chat message is sent from a user to a channel.",
"type": "text/markdown"
}
}
},
{
"id": "d0e510d8-75ab-3954-b708-279bdbebaa1d",
"name": "[180] APIkey",
"description": {
"content": "Get the channel specific API key. This API key is valid until a new one is generated.",
"type": "text/markdown"
},
"request": {
"url": {
"protocol": "https",
"host": "{{api_url}}",
"path": [
"v{{api_version}}",
"channel",
"apikey"
],
"variable": [],
"query": [
{
"key": "apikey",
"value": "{{apikey}}",
"disabled": false,
"description": "The API key"
}
]
},
"method": "GET",
"header": [
{
"key": "Content-Type",
"value": "application/json",
"disabled": false,
"description": "Enable JSON requests"
}
],
"body": null,
"description": {
"content": "Get the channel specific API key. This API key is valid until a new one is generated.",
"type": "text/markdown"
}
}
},
{
"id": "d216c1b6-eb07-30b1-a787-e538031f00dd",
"name": "[190] APIkey",
"description": {
"content": "Generate a new API key. The previous API key is automatically invalidated.",
"type": "text/markdown"
},
"request": {
"url": {
"protocol": "https",
"host": "{{api_url}}",
"path": [
"v{{api_version}}",
"channel",
"apikey"
],
"variable": [],
"query": []
},
"method": "PUT",
"header": [
{
"key": "Content-Type",
"value": "application/json",
"disabled": false,
"description": "Enable JSON requests"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"apikey\": \"{{apikey}}\"\n}"
},
"description": {
"content": "Generate a new API key. The previous API key is automatically invalidated.",
"type": "text/markdown"
}
}
},
{
"id": "3ff4608c-52b3-3059-ba2d-a9dc32b1c452",
"name": "[200] Invoices",
"description": {
"content": "Get all invoices and payment URLs of the customer the channel belongs to.",
"type": "text/markdown"
},
"request": {
"url": {
"protocol": "https",
"host": "{{api_url}}",
"path": [
"v{{api_version}}",
"channel",
"invoices"
],
"variable": [],
"query": [
{
"key": "apikey",
"value": "{{apikey}}",
"disabled": false,
"description": "The API key"
}
]
},
"method": "GET",
"header": [
{
"key": "Content-Type",
"value": "application/json",
"disabled": false,
"description": "Enable JSON requests"
}
],
"body": null,
"description": {
"content": "Get all invoices and payment URLs of the customer the channel belongs to.",
"type": "text/markdown"
}
}
},
{
"id": "dddd2734-4f00-3ffa-8831-04dbd9bf7a5c",
"name": "[900] Features",
"description": {
"content": "Get the info whether the channel uses content and the ticket system for customer support.",
"type": "text/markdown"
},
"request": {
"url": {
"protocol": "https",
"host": "{{api_url}}",
"path": [
"v{{api_version}}",
"channel",
"features"
],
"variable": [],
"query": [
{
"key": "apikey",
"value": "{{apikey}}",
"disabled": false,
"description": "The API key"
}
]
},
"method": "GET",
"header": [
{
"key": "Content-Type",
"value": "application/json",
"disabled": false,
"description": "Enable JSON requests"
}
],
"body": null,
"description": {
"content": "Get the info whether the channel uses content and the ticket system for customer support.",
"type": "text/markdown"
}
}
}
]
},
{
"id": "3dcc06b9-4c72-3ca9-9457-4e49b3e45314",
"name": "[60] newsletter",
"description": "",
"item": [
{
"id": "0c29a23a-1779-3524-a2ce-1cd2fb40b06c",
"name": "[00] History",
"description": {
"content": "Get your recent newsletters",
"type": "text/markdown"
},
"request": {
"url": {
"protocol": "https",
"host": "{{api_url}}",
"path": [
"v{{api_version}}",
"newsletter"
],
"variable": [],
"query": [
{
"key": "apikey",
"value": "{{apikey}}",
"disabled": false,
"description": "The API key"
},
{
"key": "limit",
"value": "50",
"disabled": false,
"description": "This is the amount of results that is returned."
}
]
},
"method": "GET",
"header": [
{
"key": "Content-Type",
"value": "application/json",
"disabled": false,
"description": "Enable JSON requests"
}
],
"body": null,
"description": {
"content": "Get your recent newsletters",
"type": "text/markdown"
}
}
},
{
"id": "2ea1e2a9-0cc6-3ba9-96bb-9241d4b7cb58",
"name": "[00] Send",
"description": {
"content": "Send a newsletter to users",
"type": "text/markdown"
},
"request": {
"url": {
"protocol": "https",
"host": "{{api_url}}",
"path": [
"v{{api_version}}",
"newsletter"
],
"variable": [],
"query": []
},
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json",
"disabled": false,
"description": "Enable JSON requests"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"apikey\": \"{{apikey}}\",\n \"message\": \"\",\n \"attachment\": \"\",\n \"date\": null,\n \"category\": 0,\n \"targeting_id\": 0,\n \"buttons\": \"\"\n}"
},
"description": {
"content": "Send a newsletter to users",
"type": "text/markdown"
}
}
},
{
"id": "0c58a509-1623-3591-aa60-84ff9e95bb20",
"name": "[00] Scheduled",
"description": {
"content": "Delete a scheduled newsletter by ID",
"type": "text/markdown"
},
"request": {
"url": {
"protocol": "https",
"host": "{{api_url}}",
"path": [
"v{{api_version}}",
"newsletter"
],
"variable": [],
"query": [
{
"key": "apikey",
"value": "{{apikey}}",
"disabled": false,
"description": "The API key"
},
{
"key": "id",
"value": null,
"disabled": false,
"description": "The ID of the newsletter that should be deleted. Only scheduled newsletter can be deleted when sending hasn't started yet."
}
]
},
"method": "DELETE",
"header": [
{
"key": "Content-Type",
"value": "application/json",
"disabled": false,
"description": "Enable JSON requests"
}
],
"body": null,
"description": {
"content": "Delete a scheduled newsletter by ID",
"type": "text/markdown"
}
}
},
{
"id": "de914d5b-adc8-35b0-a858-4c5522dca111",
"name": "[00] Targeting List",
"description": {
"content": "Get all targeting lists - For targeting setup please use the endpoint \"Targeting\"",
"type": "text/markdown"
},
"request": {
"url": {
"protocol": "https",
"host": "{{api_url}}",
"path": [
"v{{api_version}}",
"newsletter",
"targeting"
],
"variable": [],
"query": [
{
"key": "apikey",
"value": "{{apikey}}",
"disabled": false,
"description": "The API key"
},
{
"key": "id",
"value": null,
"disabled": false,
"description": "The ID of a targeting list. Filter for getting only this targeting information in the result."
},
{
"key": "count",
"value": "0",
"disabled": false,
"description": "Set if count of users for the targeting list should be calculated. From version 11, this only works if requesting a specific targeting (id > 0)."
},
{
"key": "content",
"value": "0",
"disabled": false,
"description": "Set if the targeting should include categories for content sending. From version 11, this only works if id not set."
}
]
},
"method": "GET",
"header": [
{
"key": "Content-Type",
"value": "application/json",
"disabled": false,
"description": "Enable JSON requests"
}
],
"body": null,
"description": {
"content": "Get all targeting lists - For targeting setup please use the endpoint \"Targeting\"",
"type": "text/markdown"
}
}
},
{
"id": "572b976d-a151-3e16-9e23-c7839ee44c9e",
"name": "[00] Category",
"description": {
"content": "Get all categories",
"type": "text/markdown"
},
"request": {
"url": {
"protocol": "https",
"host": "{{api_url}}",
"path": [
"v{{api_version}}",
"newsletter",
"category"
],
"variable": [],
"query": [
{
"key": "apikey",
"value": "{{apikey}}",
"disabled": false,
"description": "The API key"
}
]
},
"method": "GET",
"header": [
{
"key": "Content-Type",
"value": "application/json",
"disabled": false,
"description": "Enable JSON requests"
}
],
"body": null,
"description": {
"content": "Get all categories",
"type": "text/markdown"
}
}
},
{
"id": "f19c1a6d-42aa-3224-a462-d8ad098d0e3a",
"name": "[00] Category",
"description": {
"content": "Rename category",
"type": "text/markdown"
},
"request": {
"url": {
"protocol": "https",
"host": "{{api_url}}",
"path": [
"v{{api_version}}",
"newsletter",
"category"
],
"variable": [],
"query": []
},
"method": "PUT",
"header": [
{
"key": "Content-Type",
"value": "application/json",
"disabled": false,
"description": "Enable JSON requests"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"apikey\": \"{{apikey}}\",\n \"id\": 0,\n \"name\": \"\"\n}"
},
"description": {
"content": "Rename category",
"type": "text/markdown"
}
}
},
{
"id": "0df409f3-36ff-3a4a-99f2-58d95a0c5cd6",
"name": "[00] Category",
"description": {
"content": "Create a new category. Users are assigned if categories_auto_assign is enabled at the channel",
"type": "text/markdown"
},
"request": {
"url": {
"protocol": "https",
"host": "{{api_url}}",
"path": [
"v{{api_version}}",
"newsletter",
"category"
],
"variable": [],
"query": []
},
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json",
"disabled": false,
"description": "Enable JSON requests"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"apikey\": \"{{apikey}}\",\n \"name\": \"\"\n}"
},
"description": {
"content": "Create a new category. Users are assigned if categories_auto_assign is enabled at the channel",
"type": "text/markdown"
}
}
},
{
"id": "3c0839f8-f16e-3ecf-9a23-22a8483fa385",
"name": "[00] Category",
"description": {
"content": "Delete a category",
"type": "text/markdown"
},
"request": {
"url": {
"protocol": "https",
"host": "{{api_url}}",
"path": [
"v{{api_version}}",
"newsletter",
"category"
],
"variable": [],
"query": [
{
"key": "apikey",
"value": "{{apikey}}",
"disabled": false,
"description": "The API key"
},
{
"key": "id",
"value": null,
"disabled": false,
"description": "The ID 1-10 of a category"
}
]
},
"method": "DELETE",
"header": [
{
"key": "Content-Type",
"value": "application/json",
"disabled": false,
"description": "Enable JSON requests"
}
],
"body": null,
"description": {
"content": "Delete a category",
"type": "text/markdown"
}
}
}
]
},
{
"id": "e0c4933f-1485-3be4-acd7-e11dc3e7656f",
"name": "[65] Notification Templates",
"description": "",
"item": [
{
"id": "a59d847a-8b11-3fb6-9e40-d5cf1bfe5ee6",
"name": "[00] Details",
"description": {
"content": "Get a single template. If the name is omitted all templates are listed.",
"type": "text/markdown"
},
"request": {
"url": {
"protocol": "https",
"host": "{{api_url}}",
"path": [
"v{{api_version}}",
"templates",
":name"
],
"variable": [
{
"id": "8433972f-a6a6-3da5-a82c-918fb5513ae0",
"key": "name",
"name": "name",
"type": "string",
"description": "The name of the template"
}
],
"query": [
{
"key": "apikey",
"value": "{{apikey}}",
"disabled": false,
"description": "The API key"
},
{
"key": "synchronize",
"value": "false",
"disabled": false,
"description": "Synchronize templates with WhatsApp before listing"
}
]
},
"method": "GET",
"header": [
{
"key": "Content-Type",
"value": "application/json",
"disabled": false,
"description": "Enable JSON requests"
}
],
"body": null,
"description": {
"content": "Get a single template. If the name is omitted all templates are listed.",
"type": "text/markdown"
}
}
},
{
"id": "e55b683f-d23d-353e-903a-70ff34236e1e",
"name": "[00] Post",
"description": {
"content": "Create a new template",
"type": "text/markdown"
},
"request": {
"url": {
"protocol": "https",
"host": "{{api_url}}",
"path": [
"v{{api_version}}",
"templates"
],
"variable": [],
"query": []
},
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json",
"disabled": false,
"description": "Enable JSON requests"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"apikey\": \"{{apikey}}\",\n \"name\": \"\",\n \"category\": \"\",\n \"translations\": null,\n \"visible_for_agents\": null\n}"
},
"description": {
"content": "Create a new template",
"type": "text/markdown"
}
}
},
{
"id": "26d0ec5b-41f8-3fcb-b77a-97b7d7733a03",
"name": "[00] Update",
"description": {
"content": "Update a template",
"type": "text/markdown"
},
"request": {
"url": {
"protocol": "https",
"host": "{{api_url}}",
"path": [
"v{{api_version}}",
"templates",
":name"
],
"variable": [
{
"id": "683b7ba9-63cc-393c-9dd7-a0a68ce9b561",
"key": "name",
"name": "name",
"type": "string",
"description": "The name of the template. Can only be changed if all translations are still in status DRAFT."
}
],
"query": []
},
"method": "PUT",
"header": [
{
"key": "Content-Type",
"value": "application/json",
"disabled": false,
"description": "Enable JSON requests"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"apikey\": \"{{apikey}}\",\n \"id\": 0,\n \"category\": \"\",\n \"translations\": null,\n \"visible_for_agents\": null\n}"
},
"description": {
"content": "Update a template",
"type": "text/markdown"
}
}
},
{
"id": "6b545a01-9c75-3575-a6b9-ae28bf800440",
"name": "[00] Validate template name",
"description": {
"content": "Check if a template name is not in use",
"type": "text/markdown"
},
"request": {
"url": {
"protocol": "https",
"host": "{{api_url}}",
"path": [
"v{{api_version}}",
"templates",
":name",
"validate-name"
],
"variable": [
{
"id": "f05db354-d6a8-31a8-83f2-8dfe0eaab170",
"key": "name",
"name": "name",
"type": "string",
"description": "The name of the template"
}
],
"query": [
{
"key": "apikey",
"value": "{{apikey}}",
"disabled": false,
"description": "The API key"
}
]
},
"method": "GET",
"header": [
{
"key": "Content-Type",
"value": "application/json",
"disabled": false,
"description": "Enable JSON requests"
}
],
"body": null,
"description": {
"content": "Check if a template name is not in use",
"type": "text/markdown"
}
}
},
{
"id": "82aefed2-e2cd-36f6-af05-08048f1ddbab",
"name": "[00] Get template status",
"description": {
"content": "Get the review status for each language of the template",
"type": "text/markdown"
},
"request": {
"url": {
"protocol": "https",
"host": "{{api_url}}",
"path": [
"v{{api_version}}",
"templates",
":name",
"review"
],
"variable": [
{
"id": "70d904d1-5b84-32e0-94a7-86b2f5c28780",
"key": "name",
"name": "name",
"type": "string",
"description": "The name of the template"
}
],
"query": [
{
"key": "apikey",
"value": "{{apikey}}",
"disabled": false,
"description": "The API key"
}
]
},
"method": "GET",
"header": [
{
"key": "Content-Type",
"value": "application/json",
"disabled": false,
"description": "Enable JSON requests"
}
],
"body": null,
"description": {
"content": "Get the review status for each language of the template",
"type": "text/markdown"
}
}
},
{
"id": "91fef301-b6a8-3329-a10f-397df2f5d806",
"name": "[00] Submit for Review",
"description": {
"content": "Submit all translations in status DRAFT to WhatsApp for review. Except those which are marked as skipped",
"type": "text/markdown"
},
"request": {
"url": {
"protocol": "https",
"host": "{{api_url}}",
"path": [
"v{{api_version}}",
"templates",
":name",
"review"
],
"variable": [
{
"id": "7102728d-77aa-3f5d-8068-b9e6e89e0359",
"key": "name",
"name": "name",
"type": "string",
"description": "The name of the template. Can only be changed if all translations are still in status DRAFT."
}
],
"query": []
},
"method": "PUT",
"header": [
{
"key": "Content-Type",
"value": "application/json",
"disabled": false,
"description": "Enable JSON requests"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"apikey\": \"{{apikey}}\",\n \"id\": 0,\n \"category\": \"\",\n \"translations\": null,\n \"visible_for_agents\": null\n}"
},
"description": {
"content": "Submit all translations in status DRAFT to WhatsApp for review. Except those which are marked as skipped",
"type": "text/markdown"
}
}
},
{
"id": "2b759711-6c12-3b67-8c3d-bf1bcd87fc9c",
"name": "[00] Get translation",
"description": {
"content": "Get the definition of a template translation",
"type": "text/markdown"
},
"request": {
"url": {
"protocol": "https",
"host": "{{api_url}}",
"path": [
"v{{api_version}}",
"templates",
":name",
"translations",
":lang"
],
"variable": [
{
"id": "e86f68a6-67c5-3a01-9756-81ad3534235a",
"key": "name",
"name": "name",
"type": "string",
"description": "The name of the template"
},
{
"id": "c23cf5bb-6c10-3550-8334-45d0cdb46add",
"key": "lang",
"name": "lang",
"type": "string",
"description": "The language of the translation"
}
],
"query": [
{
"key": "apikey",
"value": "{{apikey}}",
"disabled": false,
"description": "The API key"
}
]
},
"method": "GET",
"header": [
{
"key": "Content-Type",
"value": "application/json",
"disabled": false,
"description": "Enable JSON requests"
}
],
"body": null,
"description": {
"content": "Get the definition of a template translation",
"type": "text/markdown"
}
}
},
{
"id": "68adec55-c7ec-34b6-ac81-7db7ecd6e049",
"name": "[00] Get translation status",
"description": {
"content": "Get the review status for a single translation of a template",
"type": "text/markdown"
},
"request": {
"url": {
"protocol": "https",
"host": "{{api_url}}",
"path": [
"v{{api_version}}",
"templates",
":name",
"translations",
":lang",
"review"
],
"variable": [
{
"id": "03401b42-47f1-3592-a210-7eb010311f53",
"key": "name",
"name": "name",
"type": "string",
"description": "The name of the template"
},
{
"id": "4edc8096-95ab-3480-8a25-1e0f129f855f",
"key": "lang",
"name": "lang",
"type": "string",
"description": "The language of the translation"
}
],
"query": [
{
"key": "apikey",
"value": "{{apikey}}",
"disabled": false,
"description": "The API key"
}
]
},
"method": "GET",
"header": [
{
"key": "Content-Type",
"value": "application/json",
"disabled": false,
"description": "Enable JSON requests"
}
],
"body": null,
"description": {
"content": "Get the review status for a single translation of a template",
"type": "text/markdown"
}
}
},
{
"id": "f1d2c83e-6426-3b5b-a4b7-ef67f583b99e",
"name": "[00] Delete",
"description": {
"content": "Delete a template with all its translations. \nNote: You can not use the name of the deleted template to create a new one until the deletion is processed by WhatsApp.",
"type": "text/markdown"
},
"request": {
"url": {
"protocol": "https",
"host": "{{api_url}}",
"path": [
"v{{api_version}}",
"templates",
":name"
],
"variable": [
{
"id": "8678e187-ad11-3817-bcff-0e0a19dd13fe",
"key": "name",
"name": "name",
"type": "string",
"description": "The name of the template"
}
],
"query": [
{
"key": "apikey",
"value": "{{apikey}}",
"disabled": false,
"description": "The API key"
},
{
"key": "lang",
"value": null,
"disabled": false,
"description": "The language of the translation"
}
]
},
"method": "DELETE",
"header": [
{
"key": "Content-Type",
"value": "application/json",
"disabled": false,
"description": "Enable JSON requests"
}
],
"body": null,
"description": {
"content": "Delete a template with all its translations. \nNote: You can not use the name of the deleted template to create a new one until the deletion is processed by WhatsApp.",
"type": "text/markdown"
}
}
}
]
},
{
"id": "ee2b60b3-a670-3376-8df5-c153329afd29",
"name": "[65] Content (Newsletters/Campaigns)",
"description": "",
"item": [
{
"id": "56eb318e-bd21-3522-bdeb-009464c84436",
"name": "[00] List",
"description": {
"content": "List content",
"type": "text/markdown"
},
"request": {
"url": {
"protocol": "https",
"host": "{{api_url}}",
"path": [
"v{{api_version}}",
"content"
],
"variable": [],
"query": [
{
"key": "apikey",
"value": "{{apikey}}",
"disabled": false,
"description": "The API key"
},
{
"key": "id",
"value": null,
"disabled": false,
"description": "The ID of a single content."
},
{
"key": "filter",
"value": null,
"disabled": false,
"description": "List only drafts if filter = "draft", scheduled if filter = "scheduled", content that is already published if filter = "published", or published and scheduled content of today (timezone Europe/Berlin) if filter = "today"."
},
{
"key": "limit",
"value": "50",
"disabled": false,
"description": "The maximum number of results."
},
{
"key": "offset",
"value": "0",
"disabled": false,
"description": "The number of results skipped in the result set."
},
{
"key": "order",
"value": null,
"disabled": false,
"description": "Content lists are ordered by published date per default (creation date for drafts). created can be specified to order by this attribute."
},
{
"key": "asc",
"value": "0",
"disabled": false,
"description": "Normally content lists are sorted descending which means latest first."
},
{
"key": "clicks",
"value": "0",
"disabled": false,
"description": "Specifies whether click statistics should be returned for URLs in contents. Requires enabled click tracking in the channel.\nThe result shows the total number of clicks and the number of clicks for each messenger."
},
{
"key": "detailed_reach_stats",
"value": "0",
"disabled": false,
"description": "Specifies whether reach statistics should be additionally split up in 'pulled from' and 'pushed to' for each messenger separately."
},
{
"key": "external_content",
"value": "0",
"disabled": false,
"description": "Specifies whether external content should be included."
},
{
"key": "detailed_user_stats",
"value": "0",
"disabled": false,
"description": "Specifies whether error statistics for targeted users should be displayed. For each content the errors and the failed users are listed"
}
]
},
"method": "GET",
"header": [
{
"key": "Content-Type",
"value": "application/json",
"disabled": false,
"description": "Enable JSON requests"
}
],
"body": null,
"description": {
"content": "List content",
"type": "text/markdown"
}
}
},
{
"id": "b7ab0e20-0d3c-39d6-a47c-cf3785e055dc",
"name": "[00] Targeting Groups",
"description": {
"content": "Get all targeting groups that can be used for sending content. This includes all users, newsletter topics and targeting groups with active users.",
"type": "text/markdown"
},
"request": {
"url": {
"protocol": "https",
"host": "{{api_url}}",
"path": [
"v{{api_version}}",
"content",
"targeting"
],
"variable": [],
"query": [
{
"key": "apikey",
"value": "{{apikey}}",
"disabled": false,
"description": "The API key"
}
]
},
"method": "GET",
"header": [
{
"key": "Content-Type",
"value": "application/json",
"disabled": false,
"description": "Enable JSON requests"
}
],
"body": null,
"description": {
"content": "Get all targeting groups that can be used for sending content. This includes all users, newsletter topics and targeting groups with active users.",
"type": "text/markdown"
}
}
},
{
"id": "640a2cbc-bb28-3548-8efc-83a06d71462e",
"name": "[00] External Content",
"description": {
"content": "Store external content that is sent already",
"type": "text/markdown"
},
"request": {
"url": {
"protocol": "https",
"host": "{{api_url}}",
"path": [
"v{{api_version}}",
"content",
"external"
],
"variable": [],
"query": []
},
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json",
"disabled": false,
"description": "Enable JSON requests"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"apikey\": \"{{apikey}}\",\n \"text\": \"\",\n \"media\": \"\",\n \"media_filename\": \"\",\n \"users\": \"\",\n \"notification_template\": \"\",\n \"notification_body_variables\": \"\",\n \"notification_header_media\": \"\",\n \"notification_header_variable\": \"\",\n \"notification_button_variable\": \"\",\n \"notification_language\": \"\"\n}"
},
"description": {
"content": "Store external content that is sent already",
"type": "text/markdown"
}
}
},
{
"id": "284cf086-66cc-3bdc-953e-f1e3b1ae0b42",
"name": "[00] Create",
"description": {
"content": "Create a new content",
"type": "text/markdown"
},
"request": {
"url": {
"protocol": "https",
"host": "{{api_url}}",
"path": [
"v{{api_version}}",
"content"
],
"variable": [],
"query": []
},
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json",
"disabled": false,
"description": "Enable JSON requests"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"apikey\": \"{{apikey}}\",\n \"text\": \"\",\n \"media\": \"\",\n \"media_filename\": \"\",\n \"draft\": false,\n \"published\": 0,\n \"notification\": \"\",\n \"promo\": \"\",\n \"weblink\": \"\",\n \"buttons\": \"\",\n \"targeting\": 0,\n \"lifetime\": 0,\n \"pull_keyword\": 0,\n \"wb_notification\": \"\",\n \"wb_notification_parameters\": \"\",\n \"wb_notification_language\": \"\",\n \"notification_template\": \"\",\n \"notification_body_variables\": \"\",\n \"notification_header_media\": \"\",\n \"notification_header_variable\": \"\",\n \"notification_button_variable\": \"\",\n \"notification_language\": \"\",\n \"targeting_query\": \"\",\n \"resend_id\": 0,\n \"campaign_tag\": \"\"\n}"
},
"description": {
"content": "Create a new content",
"type": "text/markdown"
}
}
},
{
"id": "831c5329-8ebf-3dc5-9df8-44e107094da5",
"name": "[00] Update",
"description": {
"content": "Update an existing content. For published content only the lifetime can be changed.",
"type": "text/markdown"
},
"request": {
"url": {
"protocol": "https",
"host": "{{api_url}}",
"path": [
"v{{api_version}}",
"content"
],
"variable": [],
"query": []
},
"method": "PUT",
"header": [
{
"key": "Content-Type",
"value": "application/json",
"disabled": false,
"description": "Enable JSON requests"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"apikey\": \"{{apikey}}\",\n \"id\": 0,\n \"text\": \"\",\n \"media\": \"\",\n \"media_filename\": \"\",\n \"draft\": false,\n \"published\": 0,\n \"notification\": \"\",\n \"promo\": \"\",\n \"weblink\": \"\",\n \"buttons\": \"\",\n \"targeting\": 0,\n \"lifetime\": 0,\n \"pull_keyword\": 0,\n \"wb_notification\": \"\",\n \"wb_notification_parameters\": \"\",\n \"wb_notification_language\": \"\",\n \"notification_template\": \"\",\n \"notification_body_variables\": \"\",\n \"notification_header_media\": \"\",\n \"notification_header_variable\": \"\",\n \"notification_button_variable\": \"\",\n \"notification_language\": \"\",\n \"targeting_query\": \"\",\n \"campaign_tag\": \"\"\n}"
},
"description": {
"content": "Update an existing content. For published content only the lifetime can be changed.",
"type": "text/markdown"
}
}
},
{
"id": "eb34e5b5-a233-305c-9570-3c245ecfde35",
"name": "[00] Stop Interaction",
"description": {
"content": "Interactions are no longer supported",
"type": "text/markdown"
},
"request": {
"url": {
"protocol": "https",
"host": "{{api_url}}",
"path": [
"v{{api_version}}",
"content",
"stopinteraction"
],
"variable": [],
"query": []
},
"method": "PUT",
"header": [
{
"key": "Content-Type",
"value": "application/json",
"disabled": false,
"description": "Enable JSON requests"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"apikey\": \"{{apikey}}\",\n \"id\": 0\n}"
},
"description": {
"content": "Interactions are no longer supported",
"type": "text/markdown"
}
}
},
{
"id": "ec3b5066-d999-330f-aa0d-e0653db8b398",
"name": "[00] Delete",
"description": {
"content": "Delete an existing content that is not yet published",
"type": "text/markdown"
},
"request": {
"url": {
"protocol": "https",
"host": "{{api_url}}",
"path": [
"v{{api_version}}",
"content"
],
"variable": [],
"query": [
{
"key": "apikey",
"value": "{{apikey}}",
"disabled": false,
"description": "The API key"
},
{
"key": "id",
"value": null,
"disabled": false,
"description": "The ID of the content."
}
]
},
"method": "DELETE",
"header": [
{
"key": "Content-Type",
"value": "application/json",
"disabled": false,
"description": "Enable JSON requests"
}
],
"body": null,
"description": {
"content": "Delete an existing content that is not yet published",
"type": "text/markdown"
}
}
}
]
},
{
"id": "f89988a2-ca01-3739-886c-9c2f8689d80d",
"name": "[65] Targeting Groups",
"description": "",
"item": [
{
"id": "521aeea3-35e8-3509-a96a-c68fc3101307",
"name": "[00] List",
"description": {
"content": "Get information about the available targeting groups",
"type": "text/markdown"
},
"request": {
"url": {
"protocol": "https",
"host": "{{api_url}}",
"path": [
"v{{api_version}}",
"targeting"
],
"variable": [],
"query": [
{
"key": "apikey",
"value": "{{apikey}}",
"disabled": false,
"description": "The API key"
},
{
"key": "id",
"value": null,
"disabled": false,
"description": "The ID of a single targeting group"
},
{
"key": "status",
"value": null,
"disabled": false,
"description": "Status Filter. Use 1 for listing only targeting groups that dont use a status filter and 0 for listing targeting groups that filter inactive users."
}
]
},
"method": "GET",
"header": [
{
"key": "Content-Type",
"value": "application/json",
"disabled": false,
"description": "Enable JSON requests"
}
],
"body": null,
"description": {
"content": "Get information about the available targeting groups",
"type": "text/markdown"
}
}
},
{
"id": "9f956e41-2534-3ae8-9379-fa1b023cf0d9",
"name": "[00] Update",
"description": {
"content": "Update an existing targeting group",
"type": "text/markdown"
},
"request": {
"url": {
"protocol": "https",
"host": "{{api_url}}",
"path": [
"v{{api_version}}",
"targeting"
],
"variable": [],
"query": []
},
"method": "PUT",
"header": [
{
"key": "Content-Type",
"value": "application/json",
"disabled": false,
"description": "Enable JSON requests"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"apikey\": \"{{apikey}}\",\n \"id\": 0,\n \"name\": \"\",\n \"query\": \"\"\n}"
},
"description": {
"content": "Update an existing targeting group",
"type": "text/markdown"
}
}
},
{
"id": "5cecca87-5e80-35e7-8119-8cf828be3b3d",
"name": "[00] Create",
"description": {
"content": "Create a new targeting group",
"type": "text/markdown"
},
"request": {
"url": {
"protocol": "https",
"host": "{{api_url}}",
"path": [
"v{{api_version}}",
"targeting"
],
"variable": [],
"query": []
},
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json",
"disabled": false,
"description": "Enable JSON requests"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"apikey\": \"{{apikey}}\",\n \"name\": \"\",\n \"query\": \"\"\n}"
},
"description": {
"content": "Create a new targeting group",
"type": "text/markdown"
}
}
},
{
"id": "ae455218-31ed-3360-bd38-9f3efb572179",
"name": "[00] Delete",
"description": {
"content": "Delete an existing targeting group",
"type": "text/markdown"
},
"request": {
"url": {
"protocol": "https",
"host": "{{api_url}}",
"path": [
"v{{api_version}}",
"targeting"
],
"variable": [],
"query": [
{
"key": "apikey",
"value": "{{apikey}}",
"disabled": false,
"description": "The API key"
},
{
"key": "id",
"value": null,
"disabled": false,
"description": "The ID of the targeting group"
}
]
},
"method": "DELETE",
"header": [
{
"key": "Content-Type",
"value": "application/json",
"disabled": false,
"description": "Enable JSON requests"
}
],
"body": null,
"description": {
"content": "Delete an existing targeting group",
"type": "text/markdown"
}
}
},
{
"id": "6ff76be8-2288-3d17-83a2-56d335866daf",
"name": "[00] Configuration",
"description": {
"content": "Get the targeting configuration values",
"type": "text/markdown"
},
"request": {
"url": {
"protocol": "https",
"host": "{{api_url}}",
"path": [
"v{{api_version}}",
"targeting",
"config"
],
"variable": [],
"query": [
{
"key": "apikey",
"value": "{{apikey}}",
"disabled": false,
"description": "The API key"
}
]
},
"method": "GET",
"header": [
{
"key": "Content-Type",
"value": "application/json",
"disabled": false,
"description": "Enable JSON requests"
}
],
"body": null,
"description": {
"content": "Get the targeting configuration values",
"type": "text/markdown"
}
}
},
{
"id": "857907fe-3349-35d9-8d8c-df26742b7385",
"name": "[00] Count",
"description": {
"content": "Get number of users for a targeting group. To be used with one of the two parameters.",
"type": "text/markdown"
},
"request": {
"url": {
"protocol": "https",
"host": "{{api_url}}",
"path": [
"v{{api_version}}",
"targeting",
"count"
],
"variable": [],
"query": [
{
"key": "apikey",
"value": "{{apikey}}",
"disabled": false,
"description": "The API key"
},
{
"key": "id",
"value": null,
"disabled": false,
"description": "The targeting id"
},
{
"key": "query",
"value": null,
"disabled": false,
"description": "The targeting query.\nSchema:\n{"query": {\n"condition": "OR",\n"rules": [{\n"id": "messenger",\n"field": "messenger",\n"type": "string",\n"input": "select",\n"operator": "equal",\n"value": "FB"\n}]}}"
}
]
},
"method": "GET",
"header": [
{
"key": "Content-Type",
"value": "application/json",
"disabled": false,
"description": "Enable JSON requests"
}
],
"body": null,
"description": {
"content": "Get number of users for a targeting group. To be used with one of the two parameters.",
"type": "text/markdown"
}
}
},
{
"id": "1f7b5d16-608f-3d37-9dd8-110eb8415cf8",
"name": "[00] User",
"description": {
"content": "Get user IDs of a targeting group by id or by query optionally grouped by messenger.",
"type": "text/markdown"
},
"request": {
"url": {
"protocol": "https",
"host": "{{api_url}}",
"path": [
"v{{api_version}}",
"targeting",
"user"
],
"variable": [],
"query": [
{
"key": "apikey",
"value": "{{apikey}}",
"disabled": false,
"description": "The API key"
},
{
"key": "id",
"value": null,
"disabled": false,
"description": "The targeting id"
},
{
"key": "by_messenger",
"value": "0",
"disabled": false,
"description": "Group the result by messenger"
},
{
"key": "query",
"value": null,
"disabled": false,
"description": "The targeting query.\nSchema:\n{"query": {\n"condition": "OR",\n"rules": [{\n"id": "messenger",\n"field": "messenger",\n"type": "string",\n"input": "select",\n"operator": "equal",\n"value": "FB"\n}]}}"
}
]
},
"method": "GET",
"header": [
{
"key": "Content-Type",
"value": "application/json",
"disabled": false,
"description": "Enable JSON requests"
}
],
"body": null,
"description": {
"content": "Get user IDs of a targeting group by id or by query optionally grouped by messenger.",
"type": "text/markdown"
}
}
}
]
},
{
"id": "996976c2-76f5-339e-8e28-d7144f0f93a4",
"name": "[70] Statistics",
"description": "",
"item": [
{
"id": "0f0fb900-5f27-3c55-b55d-000e77dc8f42",
"name": "[00] KPI Rules",
"description": {
"content": "Get KPI access control rules defined for the channel",
"type": "text/markdown"
},
"request": {
"url": {
"protocol": "https",
"host": "{{api_url}}",
"path": [
"v{{api_version}}",
"statistics",
"kpi_rules"
],
"variable": [],
"query": [
{
"key": "apikey",
"value": "{{apikey}}",
"disabled": false,
"description": "The API key"
}
]
},
"method": "GET",
"header": [
{
"key": "Content-Type",
"value": "application/json",
"disabled": false,
"description": "Enable JSON requests"
}
],
"body": null,
"description": {
"content": "Get KPI access control rules defined for the channel",
"type": "text/markdown"
}
}
},
{
"id": "4fe2b3be-40ac-3158-b2f7-822a1b3b1ccb",
"name": "[00] Chat",
"description": {
"content": "Get overall statistics of chat messages",
"type": "text/markdown"
},
"request": {
"url": {
"protocol": "https",
"host": "{{api_url}}",
"path": [
"v{{api_version}}",
"statistics",
"chats"
],
"variable": [],
"query": [
{
"key": "apikey",
"value": "{{apikey}}",
"disabled": false,
"description": "The API key"
},
{
"key": "from",
"value": "0",
"disabled": false,
"description": "UNIX timestamp of the start of the period, defaults to the last 30 days"
},
{
"key": "to",
"value": "0",
"disabled": false,
"description": "UNIX timestamp of the end of the period, defaults to now"
},
{
"key": "output_format",
"value": "json",
"disabled": false,
"description": "Possible values json or csv."
}
]
},
"method": "GET",
"header": [
{
"key": "Content-Type",
"value": "application/json",
"disabled": false,
"description": "Enable JSON requests"
}
],
"body": null,
"description": {
"content": "Get overall statistics of chat messages",
"type": "text/markdown"
}
}
},
{
"id": "510a0211-2ac7-3bb4-8566-f0bdc8951b96",
"name": "[00] Chatblocks",
"description": {
"content": "Get usage statistics of chatblocks including number of user answers",
"type": "text/markdown"
},
"request": {
"url": {
"protocol": "https",
"host": "{{api_url}}",
"path": [
"v{{api_version}}",
"statistics",
"chat_blocks"
],
"variable": [],
"query": [
{
"key": "apikey",
"value": "{{apikey}}",
"disabled": false,
"description": "The API key"
},
{
"key": "from",
"value": "0",
"disabled": false,
"description": "UNIX timestamp of the start of the period, defaults to the last 30 days"
},
{
"key": "to",
"value": "0",
"disabled": false,
"description": "UNIX timestamp of the end of the period, defaults to now"
},
{
"key": "output_format",
"value": "json",
"disabled": false,
"description": "Possible values json or csv."
}
]
},
"method": "GET",
"header": [
{
"key": "Content-Type",
"value": "application/json",
"disabled": false,
"description": "Enable JSON requests"
}
],
"body": null,
"description": {
"content": "Get usage statistics of chatblocks including number of user answers",
"type": "text/markdown"
}
}
},
{
"id": "62a72499-78e9-33bd-bccd-9d21789f1728",
"name": "[00] Tickets",
"description": {
"content": "Get statistics of ticket usage",
"type": "text/markdown"
},
"request": {
"url": {
"protocol": "https",
"host": "{{api_url}}",
"path": [
"v{{api_version}}",
"statistics",
"tickets"
],
"variable": [],
"query": [
{
"key": "apikey",
"value": "{{apikey}}",
"disabled": false,
"description": "The API key"
},
{
"key": "from",
"value": "0",
"disabled": false,
"description": "UNIX timestamp of the start of the period, defaults to the last 30 days"
},
{
"key": "to",
"value": "0",
"disabled": false,
"description": "UNIX timestamp of the end of the period, defaults to now"
},
{
"key": "output_format",
"value": "json",
"disabled": false,
"description": "Possible values json or csv."
}
]
},
"method": "GET",
"header": [
{
"key": "Content-Type",
"value": "application/json",
"disabled": false,
"description": "Enable JSON requests"
}
],
"body": null,
"description": {
"content": "Get statistics of ticket usage",
"type": "text/markdown"
}
}
},
{
"id": "4d676ac9-351c-3aee-a41a-ac64fa7225fc",
"name": "[00] Custom",
"description": {
"content": "Get detailed statistics of different KPIs for tickets and chats",
"type": "text/markdown"
},
"request": {
"url": {
"protocol": "https",
"host": "{{api_url}}",
"path": [
"v{{api_version}}",
"statistics",
"custom"
],
"variable": [],
"query": [
{
"key": "apikey",
"value": "{{apikey}}",
"disabled": false,
"description": "The API key"
},
{
"key": "from",
"value": "0",
"disabled": false,
"description": "UNIX timestamp of the start of the period, defaults to the last 30 days"
},
{
"key": "to",
"value": "0",
"disabled": false,
"description": "UNIX timestamp of the end of the period, defaults to now"
},
{
"key": "kpi",
"value": null,
"disabled": false,
"description": "Return only the given KPI, run without to see all KPIs"
},
{
"key": "source",
"value": null,
"disabled": false,
"description": "Specify the source of the statistics, expected values: chats, tickets"
},
{
"key": "interval",
"value": null,
"disabled": false,
"description": "Unit of period interval, expected values: hours, days, weeks"
},
{
"key": "output_format",
"value": "json",
"disabled": false,
"description": "Possible values json or csv."
}
]
},
"method": "GET",
"header": [
{
"key": "Content-Type",
"value": "application/json",
"disabled": false,
"description": "Enable JSON requests"
}
],
"body": null,
"description": {
"content": "Get detailed statistics of different KPIs for tickets and chats",
"type": "text/markdown"
}
}
},
{
"id": "02bbbf37-27c6-32d7-8e06-fbbab46a4e34",
"name": "[00] Bot",
"description": {
"content": "Get statistics on incoming messages that are answered by the bot.",
"type": "text/markdown"
},
"request": {
"url": {
"protocol": "https",
"host": "{{api_url}}",
"path": [
"v{{api_version}}",
"statistics",
"bot"
],
"variable": [],
"query": [
{
"key": "apikey",
"value": "{{apikey}}",
"disabled": false,
"description": "The API key"
},
{
"key": "from",
"value": "0",
"disabled": false,
"description": "UNIX timestamp of the start of the period, defaults to the last 30 days"
},
{
"key": "to",
"value": "0",
"disabled": false,
"description": "UNIX timestamp of the end of the period, defaults to now"
},
{
"key": "output_format",
"value": "json",
"disabled": false,
"description": "Possible values json or csv."
}
]
},
"method": "GET",
"header": [
{
"key": "Content-Type",
"value": "application/json",
"disabled": false,
"description": "Enable JSON requests"
}
],
"body": null,
"description": {
"content": "Get statistics on incoming messages that are answered by the bot.",
"type": "text/markdown"
}
}
},
{
"id": "00aff9c1-ccae-3415-9af3-83358bce4c98",
"name": "[00] MAU",
"description": {
"content": "Get statistics of monthly active users optionally grouped by messenger.",
"type": "text/markdown"
},
"request": {
"url": {
"protocol": "https",
"host": "{{api_url}}",
"path": [
"v{{api_version}}",
"statistics",
"mau"
],
"variable": [],
"query": [
{
"key": "apikey",
"value": "{{apikey}}",
"disabled": false,
"description": "The API key"
},
{
"key": "from",
"value": "0",
"disabled": false,
"description": "UNIX timestamp of the start of the period, defaults to the last 30 days"
},
{
"key": "to",
"value": "0",
"disabled": false,
"description": "UNIX timestamp of the end of the period, defaults to now"
},
{
"key": "period",
"value": "invoicing_period",
"disabled": false,
"description": "Period of invoice, expected values: invoicing_period, last_invoicing_period\nIf set, this will overrule the parameters 'from' and 'to'"
},
{
"key": "by_messenger",
"value": "false",
"disabled": false,
"description": "Group monthly active users by messenger"
},
{
"key": "output_format",
"value": "json",
"disabled": false,
"description": "Possible values json or csv."
}
]
},
"method": "GET",
"header": [
{
"key": "Content-Type",
"value": "application/json",
"disabled": false,
"description": "Enable JSON requests"
}
],
"body": null,
"description": {
"content": "Get statistics of monthly active users optionally grouped by messenger.",
"type": "text/markdown"
}
}
},
{
"id": "08fd7d5a-48be-3f64-b546-b130a62997ba",
"name": "[00] MAU Details",
"description": {
"content": "Get detailed statistics of monthly active users including time of first and last chat of each user in the period.",
"type": "text/markdown"
},
"request": {
"url": {
"protocol": "https",
"host": "{{api_url}}",
"path": [
"v{{api_version}}",
"statistics",
"mau_details"
],
"variable": [],
"query": [
{
"key": "apikey",
"value": "{{apikey}}",
"disabled": false,
"description": "The API key"
},
{
"key": "from",
"value": "0",
"disabled": false,
"description": "UNIX timestamp of the start of the period, defaults to the last 30 days"
},
{
"key": "to",
"value": "0",
"disabled": false,
"description": "UNIX timestamp of the end of the period, defaults to now"
},
{
"key": "period",
"value": "invoicing_period",
"disabled": false,
"description": "Period of invoice, expected values: invoicing_period, last_invoicing_period\nIf set, this will overrule the parameters 'from' and 'to'"
},
{
"key": "output_format",
"value": "json",
"disabled": false,
"description": "Possible values json or csv."
}
]
},
"method": "GET",
"header": [
{
"key": "Content-Type",
"value": "application/json",
"disabled": false,
"description": "Enable JSON requests"
}
],
"body": null,
"description": {
"content": "Get detailed statistics of monthly active users including time of first and last chat of each user in the period.",
"type": "text/markdown"
}
}
},
{
"id": "757a9f28-7827-3001-8561-62b4bab145aa",
"name": "[00] Content",
"description": {
"content": "Get statistics about the number of reached users starting December 7th 2019. The numbers are unique \nusers per interval.",
"type": "text/markdown"
},
"request": {
"url": {
"protocol": "https",
"host": "{{api_url}}",
"path": [
"v{{api_version}}",
"statistics",
"content"
],
"variable": [],
"query": [
{
"key": "apikey",
"value": "{{apikey}}",
"disabled": false,
"description": "The API key"
},
{
"key": "from",
"value": "0",
"disabled": false,
"description": "UNIX timestamp of the start of the period, defaults to the last 30 days"
},
{
"key": "to",
"value": "0",
"disabled": false,
"description": "UNIX timestamp of the end of the period, defaults to now"
},
{
"key": "interval",
"value": null,
"disabled": false,
"description": "Unit of period interval, expected values: days, weeks, months"
},
{
"key": "output_format",
"value": "json",
"disabled": false,
"description": "Possible values json or csv."
}
]
},
"method": "GET",
"header": [
{
"key": "Content-Type",
"value": "application/json",
"disabled": false,
"description": "Enable JSON requests"
}
],
"body": null,
"description": {
"content": "Get statistics about the number of reached users starting December 7th 2019. The numbers are unique \nusers per interval.",
"type": "text/markdown"
}
}
},
{
"id": "17cc61c4-a727-3624-948e-e3055a29a425",
"name": "[00] Agents",
"description": {
"content": "Get statistics about all agents starting January 1st 2020. \n
This feature must be activated by MessengerPeople. \n
The output contains for each agent: \n- \"Agent Id\"
- \"absolute_tickets_closed\"
Number of closed tickets \n- \"absolute_tickets_involved\"
Number of tickets where the agent was involved \n- \"outgoing_chats_in_ticket\"
Number of sent chat messages in the tickets \n- \"average_time_active_in_ticket\"
Average time spent for answering the tickets
",
"type": "text/markdown"
},
"request": {
"url": {
"protocol": "https",
"host": "{{api_url}}",
"path": [
"v{{api_version}}",
"statistics",
"agents"
],
"variable": [],
"query": [
{
"key": "apikey",
"value": "{{apikey}}",
"disabled": false,
"description": "The API key"
},
{
"key": "from",
"value": "0",
"disabled": false,
"description": "UNIX timestamp of the start of the period, defaults to the last 30 days"
},
{
"key": "to",
"value": "0",
"disabled": false,
"description": "UNIX timestamp of the end of the period, defaults to now"
},
{
"key": "output_format",
"value": "json",
"disabled": false,
"description": "Possible values json or csv."
}
]
},
"method": "GET",
"header": [
{
"key": "Content-Type",
"value": "application/json",
"disabled": false,
"description": "Enable JSON requests"
}
],
"body": null,
"description": {
"content": "Get statistics about all agents starting January 1st 2020. \n
This feature must be activated by MessengerPeople. \n
The output contains for each agent: \n- \"Agent Id\"
- \"absolute_tickets_closed\"
Number of closed tickets \n- \"absolute_tickets_involved\"
Number of tickets where the agent was involved \n- \"outgoing_chats_in_ticket\"
Number of sent chat messages in the tickets \n- \"average_time_active_in_ticket\"
Average time spent for answering the tickets
",
"type": "text/markdown"
}
}
},
{
"id": "083bdd80-f2aa-3744-a14f-4e486bb75b92",
"name": "[00] Notifications",
"description": {
"content": "Get statistics of all sent notifications. \nThe output contains: \n- template
Name of the notification template \n- total
Number of notification sent (regardless of the status) \n- total_sent
Number of notifications sent (without failures) \n- total_failed
Number of notifications failed sending \n- total_undelivered
Number of notifications sent, but not jet received by the recipient \n- total_delivered
Number of notifications sent and received by the recipient \n- total_read
Number of notifications sent and read by the recipient
",
"type": "text/markdown"
},
"request": {
"url": {
"protocol": "https",
"host": "{{api_url}}",
"path": [
"v{{api_version}}",
"statistics",
"notifications"
],
"variable": [],
"query": [
{
"key": "apikey",
"value": "{{apikey}}",
"disabled": false,
"description": "The API key"
},
{
"key": "from",
"value": "0",
"disabled": false,
"description": "UNIX timestamp of the start of the period, defaults to the last 30 days"
},
{
"key": "to",
"value": "0",
"disabled": false,
"description": "UNIX timestamp of the end of the period, defaults to now"
},
{
"key": "output_format",
"value": "json",
"disabled": false,
"description": "Possible values json or csv."
}
]
},
"method": "GET",
"header": [
{
"key": "Content-Type",
"value": "application/json",
"disabled": false,
"description": "Enable JSON requests"
}
],
"body": null,
"description": {
"content": "Get statistics of all sent notifications. \nThe output contains: \n- template
Name of the notification template \n- total
Number of notification sent (regardless of the status) \n- total_sent
Number of notifications sent (without failures) \n- total_failed
Number of notifications failed sending \n- total_undelivered
Number of notifications sent, but not jet received by the recipient \n- total_delivered
Number of notifications sent and received by the recipient \n- total_read
Number of notifications sent and read by the recipient
",
"type": "text/markdown"
}
}
},
{
"id": "d3d78be8-f850-308b-8e46-6e5cc4f7390d",
"name": "[00] Labels",
"description": {
"content": "Get statistics about labels (tags) assigned to tickets.
\nOutput example (note that an entry can have an empty body if no labels where used in this period): \n{ \n \"1606076985\": { <- timestamp \n \"9482\": { <- label id \n \"id\": 9482, <- label id \n \"label\": \"example_label\", <- label name \n \"color\": \"FF9300\", <- label color HEX value \n \"count\": 42 <- usage count for this period \n }, ... \n } \n}",
"type": "text/markdown"
},
"request": {
"url": {
"protocol": "https",
"host": "{{api_url}}",
"path": [
"v{{api_version}}",
"statistics",
"labels"
],
"variable": [],
"query": [
{
"key": "apikey",
"value": "{{apikey}}",
"disabled": false,
"description": "The API key"
},
{
"key": "from",
"value": "0",
"disabled": false,
"description": "UNIX timestamp of the start of the period, defaults to the last 30 days"
},
{
"key": "to",
"value": "0",
"disabled": false,
"description": "UNIX timestamp of the end of the period, defaults to now"
},
{
"key": "interval",
"value": "days",
"disabled": false,
"description": "Unit of period interval, expected values: days, weeks"
},
{
"key": "output_format",
"value": "json",
"disabled": false,
"description": "Possible values json or csv."
}
]
},
"method": "GET",
"header": [
{
"key": "Content-Type",
"value": "application/json",
"disabled": false,
"description": "Enable JSON requests"
}
],
"body": null,
"description": {
"content": "Get statistics about labels (tags) assigned to tickets.
\nOutput example (note that an entry can have an empty body if no labels where used in this period): \n{ \n \"1606076985\": { <- timestamp \n \"9482\": { <- label id \n \"id\": 9482, <- label id \n \"label\": \"example_label\", <- label name \n \"color\": \"FF9300\", <- label color HEX value \n \"count\": 42 <- usage count for this period \n }, ... \n } \n}",
"type": "text/markdown"
}
}
},
{
"id": "0cb6460d-012c-3b72-bf54-e4c6d9d6a980",
"name": "[00] Automation",
"description": {
"content": "Get statistics about automation effects like chatbot usage and the amount of time saved by those",
"type": "text/markdown"
},
"request": {
"url": {
"protocol": "https",
"host": "{{api_url}}",
"path": [
"v{{api_version}}",
"statistics",
"automation"
],
"variable": [],
"query": [
{
"key": "apikey",
"value": "{{apikey}}",
"disabled": false,
"description": "The API key"
},
{
"key": "from",
"value": "0",
"disabled": false,
"description": "UNIX timestamp of the start of the period, defaults to the last 30 days"
},
{
"key": "to",
"value": "0",
"disabled": false,
"description": "UNIX timestamp of the end of the period, defaults to now"
},
{
"key": "output_format",
"value": "json",
"disabled": false,
"description": "Possible values json or csv."
}
]
},
"method": "GET",
"header": [
{
"key": "Content-Type",
"value": "application/json",
"disabled": false,
"description": "Enable JSON requests"
}
],
"body": null,
"description": {
"content": "Get statistics about automation effects like chatbot usage and the amount of time saved by those",
"type": "text/markdown"
}
}
},
{
"id": "44397d90-cab7-3049-bd5b-a7610b316a85",
"name": "[00] Clicks",
"description": {
"content": "Get statistics about clicks on URLs. Click tracking must be activated",
"type": "text/markdown"
},
"request": {
"url": {
"protocol": "https",
"host": "{{api_url}}",
"path": [
"v{{api_version}}",
"statistics",
"clicks"
],
"variable": [],
"query": [
{
"key": "apikey",
"value": "{{apikey}}",
"disabled": false,
"description": "The API key"
},
{
"key": "from",
"value": "0",
"disabled": false,
"description": "UNIX timestamp of the start of the period, defaults to the last 30 days"
},
{
"key": "to",
"value": "0",
"disabled": false,
"description": "UNIX timestamp of the end of the period, defaults to now"
},
{
"key": "source",
"value": null,
"disabled": false,
"description": "Filter the source of the URLS used for the clicks. Possible values: chats, content"
},
{
"key": "order",
"value": "time",
"disabled": false,
"description": "Output order of the click information in descending order. Possible values: time, clicks"
},
{
"key": "output_format",
"value": "json",
"disabled": false,
"description": "Possible values json or csv."
}
]
},
"method": "GET",
"header": [
{
"key": "Content-Type",
"value": "application/json",
"disabled": false,
"description": "Enable JSON requests"
}
],
"body": null,
"description": {
"content": "Get statistics about clicks on URLs. Click tracking must be activated",
"type": "text/markdown"
}
}
},
{
"id": "cc9544bd-7d41-3004-b273-7a14318ca59e",
"name": "[00] KPI Translations",
"description": {
"content": "Get mapping of KPI names to understandable names in the language of the channel (or English if translation not available)",
"type": "text/markdown"
},
"request": {
"url": {
"protocol": "https",
"host": "{{api_url}}",
"path": [
"v{{api_version}}",
"statistics",
"kpi_translations"
],
"variable": [],
"query": [
{
"key": "apikey",
"value": "{{apikey}}",
"disabled": false,
"description": "The API key"
}
]
},
"method": "GET",
"header": [
{
"key": "Content-Type",
"value": "application/json",
"disabled": false,
"description": "Enable JSON requests"
}
],
"body": null,
"description": {
"content": "Get mapping of KPI names to understandable names in the language of the channel (or English if translation not available)",
"type": "text/markdown"
}
}
},
{
"id": "f605e21a-f129-35e3-a236-96c2fc5ab246",
"name": "[00] WhatsApp Conversations",
"description": {
"content": "Get information about monthly WhatsApp conversations and costs since February 2022. \nCosts of the current month are updated every night",
"type": "text/markdown"
},
"request": {
"url": {
"protocol": "https",
"host": "{{api_url}}",
"path": [
"v{{api_version}}",
"statistics",
"whatsapp_conversations"
],
"variable": [],
"query": [
{
"key": "apikey",
"value": "{{apikey}}",
"disabled": false,
"description": "The API key"
},
{
"key": "from",
"value": "0",
"disabled": false,
"description": "UNIX timestamp of the start of the period, defaults to the beginning of the current month"
},
{
"key": "to",
"value": "0",
"disabled": false,
"description": "UNIX timestamp of the end of the period, defaults to now"
},
{
"key": "output_format",
"value": "json",
"disabled": false,
"description": "Possible values json or csv."
}
]
},
"method": "GET",
"header": [
{
"key": "Content-Type",
"value": "application/json",
"disabled": false,
"description": "Enable JSON requests"
}
],
"body": null,
"description": {
"content": "Get information about monthly WhatsApp conversations and costs since February 2022. \nCosts of the current month are updated every night",
"type": "text/markdown"
}
}
},
{
"id": "567ac17a-d988-30d7-be56-c5cd3d660bb4",
"name": "[00] RCS provider",
"description": {
"content": "Get statistics about the number of RCS user grouped by provider",
"type": "text/markdown"
},
"request": {
"url": {
"protocol": "https",
"host": "{{api_url}}",
"path": [
"v{{api_version}}",
"statistics",
"rcs_provider"
],
"variable": [],
"query": [
{
"key": "apikey",
"value": "{{apikey}}",
"disabled": false,
"description": "The API key"
},
{
"key": "from",
"value": "0",
"disabled": false,
"description": "UNIX timestamp of the start of the period, defaults to the timestamp of 2021-09-01"
},
{
"key": "to",
"value": "0",
"disabled": false,
"description": "UNIX timestamp of the end of the period, defaults to now"
},
{
"key": "output_format",
"value": "json",
"disabled": false,
"description": "Possible values json or csv."
}
]
},
"method": "GET",
"header": [
{
"key": "Content-Type",
"value": "application/json",
"disabled": false,
"description": "Enable JSON requests"
}
],
"body": null,
"description": {
"content": "Get statistics about the number of RCS user grouped by provider",
"type": "text/markdown"
}
}
},
{
"id": "7d625806-5bce-3e98-9bb2-9c246779b367",
"name": "[00] Conversations",
"description": {
"content": "Gets statistics of conversations by messenger",
"type": "text/markdown"
},
"request": {
"url": {
"protocol": "https",
"host": "{{api_url}}",
"path": [
"v{{api_version}}",
"statistics",
"conversations"
],
"variable": [],
"query": [
{
"key": "apikey",
"value": "{{apikey}}",
"disabled": false,
"description": "The API key"
},
{
"key": "from",
"value": "0",
"disabled": false,
"description": "UNIX timestamp of the start of the period, defaults to the last 30 days"
},
{
"key": "to",
"value": "0",
"disabled": false,
"description": "UNIX timestamp of the end of the period, defaults to now"
},
{
"key": "interval",
"value": null,
"disabled": false,
"description": "Unit of period interval, expected values: days, months"
},
{
"key": "output_format",
"value": "json",
"disabled": false,
"description": "Possible values json or csv."
}
]
},
"method": "GET",
"header": [
{
"key": "Content-Type",
"value": "application/json",
"disabled": false,
"description": "Enable JSON requests"
}
],
"body": null,
"description": {
"content": "Gets statistics of conversations by messenger",
"type": "text/markdown"
}
}
},
{
"id": "fa119da3-f887-3398-8a42-1f08be9b91f1",
"name": "[00] Registered Agents",
"description": {
"content": "Get statistics of monthly registered agents and their login days",
"type": "text/markdown"
},
"request": {
"url": {
"protocol": "https",
"host": "{{api_url}}",
"path": [
"v{{api_version}}",
"statistics",
"registered_agents"
],
"variable": [],
"query": [
{
"key": "apikey",
"value": "{{apikey}}",
"disabled": false,
"description": "The API key"
},
{
"key": "from",
"value": "0",
"disabled": false,
"description": "UNIX timestamp of the start of the period, defaults to the last 30 days"
},
{
"key": "to",
"value": "0",
"disabled": false,
"description": "UNIX timestamp of the end of the period, defaults to now"
},
{
"key": "period",
"value": "invoicing_period",
"disabled": false,
"description": "Period of invoice, expected values: invoicing_period, last_invoicing_period\nIf set, this will overrule the parameters 'from' and 'to'"
},
{
"key": "output_format",
"value": "json",
"disabled": false,
"description": "Possible values json or csv."
}
]
},
"method": "GET",
"header": [
{
"key": "Content-Type",
"value": "application/json",
"disabled": false,
"description": "Enable JSON requests"
}
],
"body": null,
"description": {
"content": "Get statistics of monthly registered agents and their login days",
"type": "text/markdown"
}
}
}
]
},
{
"id": "6a25c153-7077-381a-bd10-bd8c3a647aba",
"name": "[71] Statistics (old)",
"description": "",
"item": [
{
"id": "fdfde8f0-7400-34e6-ae45-ddeca5082763",
"name": "[00] Ticket",
"description": {
"content": "Get overall statistics about tickets",
"type": "text/markdown"
},
"request": {
"url": {
"protocol": "https",
"host": "{{api_url}}",
"path": [
"v{{api_version}}",
"stats",
"ticket"
],
"variable": [],
"query": [
{
"key": "apikey",
"value": "{{apikey}}",
"disabled": false,
"description": "The API key"
},
{
"key": "current",
"value": "0",
"disabled": false,
"description": "Specifies whether only current values tickets_unassigned_total, tickets_open_total, tickets_open_answered and tickets_open_unanswered are listed which makes the call much faster."
}
]
},
"method": "GET",
"header": [
{
"key": "Content-Type",
"value": "application/json",
"disabled": false,
"description": "Enable JSON requests"
}
],
"body": null,
"description": {
"content": "Get overall statistics about tickets",
"type": "text/markdown"
}
}
},
{
"id": "939fd2ef-6377-3e46-8b70-435e994b77d2",
"name": "[00] Ticket Details",
"description": {
"content": "Get detailed statistics about tickets.
The following statistics data is provided for each time period: \n- opened: the number of opened tickets \n
- closed: the number of closed tickets \n
- average_opened: the average number of open tickets during the whole period \n
- average_answer_time: the average response time for answers sent \n
- average_close_time: the average time until a ticket is closed \n
- average_answers: the average number of answers in closed tickets \n
\nThe maximum number of listed tickets is 10000",
"type": "text/markdown"
},
"request": {
"url": {
"protocol": "https",
"host": "{{api_url}}",
"path": [
"v{{api_version}}",
"stats",
"ticketdetails"
],
"variable": [],
"query": [
{
"key": "apikey",
"value": "{{apikey}}",
"disabled": false,
"description": "The API key"
},
{
"key": "unit",
"value": "days",
"disabled": false,
"description": "Specifies the unit of the result. Possible values are hours, days, weeks."
},
{
"key": "start",
"value": null,
"disabled": false,
"description": "UNIX timestamp of the day/hour at which to start the statistics.\nDefault: Current day for hour statistics, 30 days ago for days or weeks"
},
{
"key": "end",
"value": null,
"disabled": false,
"description": "UNIX timestamp at which to end the statistics.\nDefault: current time"
},
{
"key": "output_format",
"value": "json",
"disabled": false,
"description": "Possible values json or csv."
}
]
},
"method": "GET",
"header": [
{
"key": "Content-Type",
"value": "application/json",
"disabled": false,
"description": "Enable JSON requests"
}
],
"body": null,
"description": {
"content": "Get detailed statistics about tickets.
The following statistics data is provided for each time period: \n- opened: the number of opened tickets \n
- closed: the number of closed tickets \n
- average_opened: the average number of open tickets during the whole period \n
- average_answer_time: the average response time for answers sent \n
- average_close_time: the average time until a ticket is closed \n
- average_answers: the average number of answers in closed tickets \n
\nThe maximum number of listed tickets is 10000",
"type": "text/markdown"
}
}
},
{
"id": "5b7b39fc-7840-3961-9d21-c07cc0e5b281",
"name": "[00] User",
"description": {
"content": "Get user statistics with newsletter activation information for each period. Also for all used messenger.",
"type": "text/markdown"
},
"request": {
"url": {
"protocol": "https",
"host": "{{api_url}}",
"path": [
"v{{api_version}}",
"stats",
"user"
],
"variable": [],
"query": [
{
"key": "apikey",
"value": "{{apikey}}",
"disabled": false,
"description": "The API key"
},
{
"key": "days",
"value": "1",
"disabled": false,
"description": "Specifies whether day statistics should be returned.\nDefault: 1 unless hour is set."
},
{
"key": "hours",
"value": "0",
"disabled": false,
"description": "Specifies whether hour statistics should be returned."
},
{
"key": "start",
"value": null,
"disabled": false,
"description": "UNIX timestamp of the day/hour at which to start the statistics.\nDefault: Current day for hour statistics, 30 days ago for days"
},
{
"key": "end",
"value": null,
"disabled": false,
"description": "UNIX timestamp at which to end the statistics.\nDefault: current time"
},
{
"key": "output_format",
"value": "json",
"disabled": false,
"description": "Possible values json or csv."
}
]
},
"method": "GET",
"header": [
{
"key": "Content-Type",
"value": "application/json",
"disabled": false,
"description": "Enable JSON requests"
}
],
"body": null,
"description": {
"content": "Get user statistics with newsletter activation information for each period. Also for all used messenger.",
"type": "text/markdown"
}
}
},
{
"id": "40b2e436-c575-3cdf-8947-e67506219594",
"name": "[00] Newsletter",
"description": {
"content": "Get newsletter statistics of the channel (since 2021-01-11 newsletters are no longer sent)",
"type": "text/markdown"
},
"request": {
"url": {
"protocol": "https",
"host": "{{api_url}}",
"path": [
"v{{api_version}}",
"stats",
"newsletter"
],
"variable": [],
"query": [
{
"key": "apikey",
"value": "{{apikey}}",
"disabled": false,
"description": "The API key"
},
{
"key": "days",
"value": "1",
"disabled": false,
"description": "Specifies whether day statistics should be returned.\nDefault: 1 unless hour is set."
},
{
"key": "hours",
"value": "0",
"disabled": false,
"description": "Specifies whether hour statistics should be returned."
},
{
"key": "start",
"value": null,
"disabled": false,
"description": "UNIX timestamp of the day/hour at which to start the statistics.\nDefault: Current day for hour statistics, 30 days ago for days"
},
{
"key": "end",
"value": null,
"disabled": false,
"description": "UNIX timestamp at which to end the statistics.\nDefault: current time"
},
{
"key": "clicks",
"value": "0",
"disabled": false,
"description": "Specifies whether click statistics should be returned for URLs in the newsletters. Requires enabled click tracking in the channel.\nThe result shows the total number of clicks and the number of clicks for each messenger."
}
]
},
"method": "GET",
"header": [
{
"key": "Content-Type",
"value": "application/json",
"disabled": false,
"description": "Enable JSON requests"
}
],
"body": null,
"description": {
"content": "Get newsletter statistics of the channel (since 2021-01-11 newsletters are no longer sent)",
"type": "text/markdown"
}
}
},
{
"id": "9b8b37f0-e7aa-3f2d-b06b-5f7b4d7a4f91",
"name": "[00] Chat",
"description": {
"content": "Get chat statistics with number of incoming and outgoing messages and number of chatting users for each period",
"type": "text/markdown"
},
"request": {
"url": {
"protocol": "https",
"host": "{{api_url}}",
"path": [
"v{{api_version}}",
"stats",
"chat"
],
"variable": [],
"query": [
{
"key": "apikey",
"value": "{{apikey}}",
"disabled": false,
"description": "The API key"
},
{
"key": "days",
"value": "1",
"disabled": false,
"description": "Specifies whether day statistics should be returned.\nDefault: 1 unless hour is set."
},
{
"key": "hours",
"value": "0",
"disabled": false,
"description": "Specifies whether hour statistics should be returned."
},
{
"key": "start",
"value": null,
"disabled": false,
"description": "UNIX timestamp of the day/hour at which to start the statistics.\nDefault: Current day for hour statistics, 30 days ago for days"
},
{
"key": "end",
"value": null,
"disabled": false,
"description": "UNIX timestamp at which to end the statistics.\nDefault: current time"
},
{
"key": "bot",
"value": "0",
"disabled": false,
"description": "Include bot statistics."
},
{
"key": "weeks",
"value": "0",
"disabled": false,
"description": "Include additional week statistics."
}
]
},
"method": "GET",
"header": [
{
"key": "Content-Type",
"value": "application/json",
"disabled": false,
"description": "Enable JSON requests"
}
],
"body": null,
"description": {
"content": "Get chat statistics with number of incoming and outgoing messages and number of chatting users for each period",
"type": "text/markdown"
}
}
},
{
"id": "d58aded5-f1d3-3d82-937f-8ac25061ff06",
"name": "[00] Bot",
"description": {
"content": "Get bot statistics of the channel.",
"type": "text/markdown"
},
"request": {
"url": {
"protocol": "https",
"host": "{{api_url}}",
"path": [
"v{{api_version}}",
"stats",
"bot"
],
"variable": [],
"query": [
{
"key": "apikey",
"value": "{{apikey}}",
"disabled": false,
"description": "The API key"
},
{
"key": "days",
"value": "1",
"disabled": false,
"description": "Specifies whether day statistics should be returned.\nDefault: 1 unless hour is set."
},
{
"key": "hours",
"value": "0",
"disabled": false,
"description": "Specifies whether hour statistics should be returned."
},
{
"key": "start",
"value": null,
"disabled": false,
"description": "UNIX timestamp of the day/hour at which to start the statistics.\nDefault: Current day for hour statistics, 30 days ago for days"
},
{
"key": "end",
"value": null,
"disabled": false,
"description": "UNIX timestamp at which to end the statistics.\nDefault: current time"
}
]
},
"method": "GET",
"header": [
{
"key": "Content-Type",
"value": "application/json",
"disabled": false,
"description": "Enable JSON requests"
}
],
"body": null,
"description": {
"content": "Get bot statistics of the channel.",
"type": "text/markdown"
}
}
},
{
"id": "fb052fa0-755f-3c3b-82d4-168bd2db40af",
"name": "[00] Content",
"description": {
"content": "Get statistics about number of reached users. The numbers are unique users per unit or during last 30 days. \nUse /statistics/content instead.",
"type": "text/markdown"
},
"request": {
"url": {
"protocol": "https",
"host": "{{api_url}}",
"path": [
"v{{api_version}}",
"stats",
"content"
],
"variable": [],
"query": [
{
"key": "apikey",
"value": "{{apikey}}",
"disabled": false,
"description": "The API key"
},
{
"key": "start",
"value": null,
"disabled": false,
"description": "UNIX timestamp of the day/hour at which to start the statistics.\nDefault: Current day for hour statistics, 30 days ago for days"
},
{
"key": "end",
"value": null,
"disabled": false,
"description": "UNIX timestamp at which to end the statistics.\nDefault: current time"
},
{
"key": "unit",
"value": null,
"disabled": false,
"description": "The unit of the returned statistics. Possible values are days, weeks or months.\nIf the unit is omitted, only current_push and last_30days are returned."
}
]
},
"method": "GET",
"header": [
{
"key": "Content-Type",
"value": "application/json",
"disabled": false,
"description": "Enable JSON requests"
}
],
"body": null,
"description": {
"content": "Get statistics about number of reached users. The numbers are unique users per unit or during last 30 days. \nUse /statistics/content instead.",
"type": "text/markdown"
}
}
}
]
},
{
"id": "e3d01b8b-774e-366c-ab25-13c9f00f4ffa",
"name": "[80] Entities",
"description": "",
"item": [
{
"id": "f78f17e2-94b2-30b5-a1c6-e1ae7a3c2b0d",
"name": "[00] Entity",
"description": {
"content": "Get ID, name and attributes of entities.",
"type": "text/markdown"
},
"request": {
"url": {
"protocol": "https",
"host": "{{api_url}}",
"path": [
"v{{api_version}}",
"entity",
":id"
],
"variable": [
{
"id": "892bfd7d-cad5-3b20-8418-070a7a47b673",
"key": "id",
"name": "id",
"type": "integer",
"description": "The entity ID."
}
],
"query": [
{
"key": "apikey",
"value": "{{apikey}}",
"disabled": false,
"description": "The API key"
}
]
},
"method": "GET",
"header": [
{
"key": "Content-Type",
"value": "application/json",
"disabled": false,
"description": "Enable JSON requests"
}
],
"body": null,
"description": {
"content": "Get ID, name and attributes of entities.",
"type": "text/markdown"
}
}
},
{
"id": "ade8d5d3-6611-3a0e-8e2f-bf708dabb84c",
"name": "[00] Data",
"description": {
"content": "Get entity data instances",
"type": "text/markdown"
},
"request": {
"url": {
"protocol": "https",
"host": "{{api_url}}",
"path": [
"v{{api_version}}",
"entity",
":id",
"data",
":data_id"
],
"variable": [
{
"id": "a35e7e0b-94dc-3975-a850-3ea29c47c14c",
"key": "id",
"name": "id",
"type": "integer",
"description": "The entity ID"
},
{
"id": "011a2f2f-dd25-36e3-834e-cd5ffb209184",
"key": "data_id",
"name": "data_id",
"type": "integer",
"description": "The entity data instance ID"
}
],
"query": [
{
"key": "apikey",
"value": "{{apikey}}",
"disabled": false,
"description": "The API key"
}
]
},
"method": "GET",
"header": [
{
"key": "Content-Type",
"value": "application/json",
"disabled": false,
"description": "Enable JSON requests"
}
],
"body": null,
"description": {
"content": "Get entity data instances",
"type": "text/markdown"
}
}
},
{
"id": "93252e39-743c-336d-b37d-64c43432c29e",
"name": "[00] Data",
"description": {
"content": "Update or create an entity data instance",
"type": "text/markdown"
},
"request": {
"url": {
"protocol": "https",
"host": "{{api_url}}",
"path": [
"v{{api_version}}",
"entity",
":id",
"data",
":data_id"
],
"variable": [
{
"id": "bb979492-dc90-3394-af99-adcabe547cd6",
"key": "id",
"name": "id",
"type": "integer",
"description": "The entity ID"
},
{
"id": "fa444c39-7d37-3e09-877e-c939f0c5acad",
"key": "data_id",
"name": "data_id",
"type": "integer",
"description": "The entity data instance ID, if the id is missing a new instance is created."
}
],
"query": []
},
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json",
"disabled": false,
"description": "Enable JSON requests"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"apikey\": \"{{apikey}}\",\n \"data\": \"\"\n}"
},
"description": {
"content": "Update or create an entity data instance",
"type": "text/markdown"
}
}
},
{
"id": "b70a49f2-ddd3-3a13-9531-c7e3a42aaf0c",
"name": "[00] Data",
"description": {
"content": "Delete an entity data instance",
"type": "text/markdown"
},
"request": {
"url": {
"protocol": "https",
"host": "{{api_url}}",
"path": [
"v{{api_version}}",
"entity",
":id",
"data",
":data_id"
],
"variable": [
{
"id": "8d7437b3-e004-3e7f-a0c0-603256193336",
"key": "id",
"name": "id",
"type": "integer",
"description": "The entity ID"
},
{
"id": "457ad14b-45ae-3ddb-b11d-3a8a61ac89bc",
"key": "data_id",
"name": "data_id",
"type": "integer",
"description": "The entity data instance ID"
}
],
"query": [
{
"key": "apikey",
"value": "{{apikey}}",
"disabled": false,
"description": "The API key"
}
]
},
"method": "DELETE",
"header": [
{
"key": "Content-Type",
"value": "application/json",
"disabled": false,
"description": "Enable JSON requests"
}
],
"body": null,
"description": {
"content": "Delete an entity data instance",
"type": "text/markdown"
}
}
}
]
},
{
"id": "594f0bb6-35a8-3245-b265-9d7ddf164100",
"name": "[90] widget",
"description": "",
"item": [
{
"id": "5c42a4dc-fe5c-32f2-8fcc-fd5b32036a7b",
"name": "[00] Details",
"description": {
"content": "Get the currently available WhatsApp numbers for customized widgets.",
"type": "text/markdown"
},
"request": {
"url": {
"protocol": "https",
"host": "{{api_url}}",
"path": [
"v{{api_version}}",
"widget"
],
"variable": [],
"query": [
{
"key": "apikey",
"value": "{{apikey}}",
"disabled": false,
"description": "The API key"
}
]
},
"method": "GET",
"header": [
{
"key": "Content-Type",
"value": "application/json",
"disabled": false,
"description": "Enable JSON requests"
}
],
"body": null,
"description": {
"content": "Get the currently available WhatsApp numbers for customized widgets.",
"type": "text/markdown"
}
}
}
]
},
{
"id": "fe9ae521-a7a0-34c8-a3f8-6eacd22e9137",
"name": "[110] ticket",
"description": "",
"item": [
{
"id": "91acad21-a26a-3c70-952a-27a025362e3a",
"name": "[00] Details",
"description": {
"content": "Get information about a ticket or list all tickets",
"type": "text/markdown"
},
"request": {
"url": {
"protocol": "https",
"host": "{{api_url}}",
"path": [
"v{{api_version}}",
"ticket",
":id"
],
"variable": [
{
"id": "f88ed24d-77e9-3227-9fbc-b8df56465721",
"key": "id",
"name": "id",
"type": "mixed",
"description": "The ticket ID or user_id. Multiple ids can be separated by comma. If a user_id is specified the last ticket of that user is returned."
}
],
"query": [
{
"key": "apikey",
"value": "{{apikey}}",
"disabled": false,
"description": "The API key"
},
{
"key": "limit",
"value": "500",
"disabled": false,
"description": "The number of results. The maximum is 500 if chats of the tickets are listed or 5000 if no chats are listed."
},
{
"key": "offset",
"value": null,
"disabled": false,
"description": "The number of tickets skipped in the result set."
},
{
"key": "order",
"value": "id",
"disabled": false,
"description": "Order the results by that field. Valid fields are 'id', 'closed', 'created', 'status', 'messenger', 'waiting_since', 'label_names', 'agent', 'last_chat', 'last_in', 'last_out'."
},
{
"key": "asc",
"value": "1",
"disabled": false,
"description": "Define whether to order the resulting tickets descending or ascending."
},
{
"key": "status",
"value": null,
"disabled": false,
"description": "The status of the tickets. 0 for closed tickets, 1 for opened tickets"
},
{
"key": "my",
"value": "0",
"disabled": false,
"description": "List only tickets assigned to the calling agent or her team."
},
{
"key": "user_id",
"value": null,
"disabled": false,
"description": "The ID of a user or comma-separated list of IDs."
},
{
"key": "agent_id",
"value": null,
"disabled": false,
"description": "The ID of an agent or comma-separated list of IDs."
},
{
"key": "label",
"value": null,
"disabled": false,
"description": "The ID of a label or comma-separated list of IDs."
},
{
"key": "bot",
"value": "1",
"disabled": false,
"description": "List bot chat messages of the ticket."
},
{
"key": "search",
"value": null,
"disabled": false,
"description": "A filter for searching tickets. Searches can be performed for ticket numbers, user ids, text in chat and notes. Only tickets of users are listed that match the search filter."
},
{
"key": "messenger",
"value": null,
"disabled": false,
"description": "A filter for listing only tickets of users with this messenger. Valid values are 'WA', 'WB', 'FB', 'TG', 'IN', 'IM', 'VI', 'IG', 'RC. (WA and WB are synonyms)"
},
{
"key": "num_chats",
"value": "100000",
"disabled": false,
"description": "The maximum number of chats that are listed for each ticket ."
},
{
"key": "waiting_since",
"value": null,
"disabled": false,
"description": "A filter for listing only open tickets that are waiting since the specified time. Format: 0 for getting all answered, 1 for getting all unanswered tickets or from-to, e.g. 0-1552389233 or 1552389233-0 ."
},
{
"key": "notes",
"value": "1",
"disabled": false,
"description": "Set to 0 to avoid listing notes of the ticket(s) when ID is not specified."
},
{
"key": "new",
"value": "0",
"disabled": false,
"description": "List only new open tickets that have not been answered yet."
},
{
"key": "newsletter",
"value": "0",
"disabled": false,
"description": "Include newsletter content to the chat list of the tickets."
},
{
"key": "customfields",
"value": "0",
"disabled": false,
"description": "Include custom fields of the user to tickets."
},
{
"key": "closed_in",
"value": null,
"disabled": false,
"description": "A filter for listing only closed tickets that are closed within the specified time. Format: from-to, e.g. 0-1552389233 or 1552389233-0 ."
},
{
"key": "last_chat",
"value": "0",
"disabled": false,
"description": "Include timestamps (last_in/last_out) for last inbound and outbound chat"
},
{
"key": "postponed_only",
"value": "0",
"disabled": false,
"description": "Only show postponed tickets"
},
{
"key": "hide_postponed",
"value": "0",
"disabled": false,
"description": "Hide tickets that are postponed to the future"
},
{
"key": "output_format",
"value": null,
"disabled": false,
"description": "Set to 'csv' to export tickets as CSV file"
}
]
},
"method": "GET",
"header": [
{
"key": "Content-Type",
"value": "application/json",
"disabled": false,
"description": "Enable JSON requests"
}
],
"body": null,
"description": {
"content": "Get information about a ticket or list all tickets",
"type": "text/markdown"
}
}
},
{
"id": "63f1ce97-e9d8-3884-aae5-83d76b42a063",
"name": "[00] Get ticket history",
"description": {
"content": "Get all closed tickets of a given user",
"type": "text/markdown"
},
"request": {
"url": {
"protocol": "https",
"host": "{{api_url}}",
"path": [
"v{{api_version}}",
"ticket",
":user_id",
"ticket_history"
],
"variable": [
{
"id": "935d2cf5-9521-37fd-88c6-31a44044aa05",
"key": "user_id",
"name": "user_id",
"type": "mixed",
"description": "The ID of the user"
}
],
"query": [
{
"key": "apikey",
"value": "{{apikey}}",
"disabled": false,
"description": "The API key"
}
]
},
"method": "GET",
"header": [
{
"key": "Content-Type",
"value": "application/json",
"disabled": false,
"description": "Enable JSON requests"
}
],
"body": null,
"description": {
"content": "Get all closed tickets of a given user",
"type": "text/markdown"
}
}
},
{
"id": "c4fcab21-7ebd-357b-af29-b0dd2ed7e0e5",
"name": "[00] Channel Events",
"description": {
"content": "Get information about events in other channels that happened after logging into those channels. Events are information about new chat messages or ticket assignments. A dispatcher gets additional events about new un-assigned tickets. \nThe call is only available for logged-in agents or dispatchers.",
"type": "text/markdown"
},
"request": {
"url": {
"protocol": "https",
"host": "{{api_url}}",
"path": [
"v{{api_version}}",
"ticket",
"channel_events"
],
"variable": [],
"query": [
{
"key": "apikey",
"value": "{{apikey}}",
"disabled": false,
"description": "The API key"
}
]
},
"method": "GET",
"header": [
{
"key": "Content-Type",
"value": "application/json",
"disabled": false,
"description": "Enable JSON requests"
}
],
"body": null,
"description": {
"content": "Get information about events in other channels that happened after logging into those channels. Events are information about new chat messages or ticket assignments. A dispatcher gets additional events about new un-assigned tickets. \nThe call is only available for logged-in agents or dispatchers.",
"type": "text/markdown"
}
}
},
{
"id": "8b56a7c2-9187-3152-8188-30d8eb0d85fc",
"name": "[00] Open",
"description": {
"content": "Get the open ticket for a user or create and open a ticket for the user",
"type": "text/markdown"
},
"request": {
"url": {
"protocol": "https",
"host": "{{api_url}}",
"path": [
"v{{api_version}}",
"ticket",
":id",
"open"
],
"variable": [
{
"id": "73dbce7e-f159-3ade-81bd-d88ce5ab8d7b",
"key": "id",
"name": "id",
"type": "integer",
"description": "The ID of a user."
}
],
"query": []
},
"method": "PUT",
"header": [
{
"key": "Content-Type",
"value": "application/json",
"disabled": false,
"description": "Enable JSON requests"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"apikey\": \"{{apikey}}\",\n \"reopen\": \"1\"\n}"
},
"description": {
"content": "Get the open ticket for a user or create and open a ticket for the user",
"type": "text/markdown"
}
}
},
{
"id": "941db5f3-8c21-368f-8a09-9fc6457c9f44",
"name": "[00] Close",
"description": {
"content": "Close a ticket",
"type": "text/markdown"
},
"request": {
"url": {
"protocol": "https",
"host": "{{api_url}}",
"path": [
"v{{api_version}}",
"ticket",
":id",
"close"
],
"variable": [
{
"id": "8e505386-cbf9-33a0-a302-5b19c7734cff",
"key": "id",
"name": "id",
"type": "integer",
"description": "The ID of a ticket or a user."
}
],
"query": []
},
"method": "PUT",
"header": [
{
"key": "Content-Type",
"value": "application/json",
"disabled": false,
"description": "Enable JSON requests"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"apikey\": \"{{apikey}}\",\n \"note\": \"\",\n \"batch_ids\": null,\n \"label_ids\": null\n}"
},
"description": {
"content": "Close a ticket",
"type": "text/markdown"
}
}
},
{
"id": "9e179582-fd98-34c1-9df7-9a8f8bd0316c",
"name": "[00] Update",
"description": {
"content": "Assign an agent or team to a ticket or remove the assignment. Or postpone a ticket or mark as answered.",
"type": "text/markdown"
},
"request": {
"url": {
"protocol": "https",
"host": "{{api_url}}",
"path": [
"v{{api_version}}",
"ticket",
":id"
],
"variable": [
{
"id": "0f0b46dd-4844-3077-9fc8-da265e23f6c7",
"key": "id",
"name": "id",
"type": "integer",
"description": "The ID of a ticket or a user."
}
],
"query": []
},
"method": "PUT",
"header": [
{
"key": "Content-Type",
"value": "application/json",
"disabled": false,
"description": "Enable JSON requests"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"apikey\": \"{{apikey}}\",\n \"agent_id\": 0,\n \"team_id\": 0,\n \"agent_email\": \"\",\n \"bot_active\": false,\n \"waiting_since\": null,\n \"batch_ids\": null,\n \"postponed\": 0\n}"
},
"description": {
"content": "Assign an agent or team to a ticket or remove the assignment. Or postpone a ticket or mark as answered.",
"type": "text/markdown"
}
}
},
{
"id": "f3c7faa6-49a0-307d-a15c-61ca377157bd",
"name": "[00] Label",
"description": {
"content": "Assign a label to a ticket. \n
Since Version 13 you can update the label settings of multiple tickets by using batch_ids and label_ids instead of id and label_id.",
"type": "text/markdown"
},
"request": {
"url": {
"protocol": "https",
"host": "{{api_url}}",
"path": [
"v{{api_version}}",
"ticket",
":id",
"label",
":label_id"
],
"variable": [
{
"id": "1337aaed-1229-3aac-8dd6-0f44b60c444c",
"key": "id",
"name": "id",
"type": "integer",
"description": "The ID of a ticket or a user"
},
{
"id": "876bdfb9-da56-3e4e-a877-af77c30defb6",
"key": "label_id",
"name": "label_id",
"type": "integer",
"description": "The ID of a label"
}
],
"query": []
},
"method": "PUT",
"header": [
{
"key": "Content-Type",
"value": "application/json",
"disabled": false,
"description": "Enable JSON requests"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"apikey\": \"{{apikey}}\",\n \"batch_ids\": null,\n \"label_ids\": null\n}"
},
"description": {
"content": "Assign a label to a ticket. \n
Since Version 13 you can update the label settings of multiple tickets by using batch_ids and label_ids instead of id and label_id.",
"type": "text/markdown"
}
}
},
{
"id": "d01f7cd7-9d7e-304e-9703-6bbfd5ebe19a",
"name": "[00] Label",
"description": {
"content": "Delete assignment of a label to a ticket",
"type": "text/markdown"
},
"request": {
"url": {
"protocol": "https",
"host": "{{api_url}}",
"path": [
"v{{api_version}}",
"ticket",
":id",
"label",
":label_id"
],
"variable": [
{
"id": "072349ea-6521-3ffc-bf7a-b083e0666f5b",
"key": "id",
"name": "id",
"type": "integer",
"description": "The ID of a ticket or a user"
},
{
"id": "b4d92772-5560-39ec-b320-cdf7e5388b58",
"key": "label_id",
"name": "label_id",
"type": "integer",
"description": "The ID of a label"
}
],
"query": [
{
"key": "apikey",
"value": "{{apikey}}",
"disabled": false,
"description": "The API key"
}
]
},
"method": "DELETE",
"header": [
{
"key": "Content-Type",
"value": "application/json",
"disabled": false,
"description": "Enable JSON requests"
}
],
"body": null,
"description": {
"content": "Delete assignment of a label to a ticket",
"type": "text/markdown"
}
}
},
{
"id": "75b0f84e-47b7-35e6-948a-1a32fc9fa5ae",
"name": "[00] Note",
"description": {
"content": "Add a note to a ticket",
"type": "text/markdown"
},
"request": {
"url": {
"protocol": "https",
"host": "{{api_url}}",
"path": [
"v{{api_version}}",
"ticket",
":id",
"note"
],
"variable": [
{
"id": "7507df25-b1d1-372f-817a-e94a4a5d29e3",
"key": "id",
"name": "id",
"type": "integer",
"description": "The ID of a ticket"
}
],
"query": []
},
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json",
"disabled": false,
"description": "Enable JSON requests"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"apikey\": \"{{apikey}}\",\n \"note\": \"\",\n \"agent_id\": 0\n}"
},
"description": {
"content": "Add a note to a ticket",
"type": "text/markdown"
}
}
},
{
"id": "f1cd6a06-91e8-3685-bcb8-7e2e63153072",
"name": "[00] Note",
"description": {
"content": "Update a note of a ticket",
"type": "text/markdown"
},
"request": {
"url": {
"protocol": "https",
"host": "{{api_url}}",
"path": [
"v{{api_version}}",
"ticket",
":id",
"note",
":note_id"
],
"variable": [
{
"id": "b819903e-3b33-3e1d-9563-b9bb98d2f4f6",
"key": "id",
"name": "id",
"type": "integer",
"description": "The ID of a ticket"
},
{
"id": "7895777e-b145-31c0-821b-d550e09acb61",
"key": "note_id",
"name": "note_id",
"type": "integer",
"description": "The ID of a note to update"
}
],
"query": []
},
"method": "PUT",
"header": [
{
"key": "Content-Type",
"value": "application/json",
"disabled": false,
"description": "Enable JSON requests"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"apikey\": \"{{apikey}}\",\n \"note\": \"\"\n}"
},
"description": {
"content": "Update a note of a ticket",
"type": "text/markdown"
}
}
},
{
"id": "58ef2d77-fc54-34d1-bcb7-1d5833b67ee5",
"name": "[00] Note",
"description": {
"content": "Deletes a note of a ticket",
"type": "text/markdown"
},
"request": {
"url": {
"protocol": "https",
"host": "{{api_url}}",
"path": [
"v{{api_version}}",
"ticket",
":id",
"note",
":note_id"
],
"variable": [
{
"id": "ca1ccf91-b0ad-3ded-81fd-074dfd6a8f3e",
"key": "id",
"name": "id",
"type": "integer",
"description": "The ID of a ticket"
},
{
"id": "00f82337-af87-3d30-96a7-bead6da1a886",
"key": "note_id",
"name": "note_id",
"type": "integer",
"description": "The ID of a note to update"
}
],
"query": [
{
"key": "apikey",
"value": "{{apikey}}",
"disabled": false,
"description": "The API key"
}
]
},
"method": "DELETE",
"header": [
{
"key": "Content-Type",
"value": "application/json",
"disabled": false,
"description": "Enable JSON requests"
}
],
"body": null,
"description": {
"content": "Deletes a note of a ticket",
"type": "text/markdown"
}
}
},
{
"id": "0a929606-fa92-3797-86be-c9222ca0bc72",
"name": "[00] Statistics",
"description": {
"content": "Get detailed statistical information on the specified ticket or all tickets created in the specified range and return them in csv format \n- TicketID: the ticket number \n
- Username: the name of the user \n
- Agent: the name of the current assigned agent \n
- Created: the creation timestamp of the ticket \n
- Closed: the time when the ticket has been closed \n
- DurationUntilClosed: the number of seconds between ticket creation and ticket closing \n
- Usermessages: the number of user messages sent while the ticket was opened or before the ticket was opened if the bot answered \n
- Botmessages: the number of bot messages sent while the ticket was opened or before the ticket was opened \n
- Agentmessages: the number of agent messages sent while the ticket was opened \n
- DurationChatWithBot: the number of seconds the user chatted with the bot before the ticket was created \n
- DurationUntilAssigned: the number of seconds between ticket creation and assignment to the agent \n
- DurationUntilFirstResponse: the number of seconds until the agent first responded to the user \n
- AverageResponseTime: the average number of seconds until the agent sent a response to the user \n
- TotalResponseTime: the total number of seconds the user had to wait until he got a response from an agent \n
",
"type": "text/markdown"
},
"request": {
"url": {
"protocol": "https",
"host": "{{api_url}}",
"path": [
"v{{api_version}}",
"ticket",
"statistics"
],
"variable": [],
"query": [
{
"key": "apikey",
"value": "{{apikey}}",
"disabled": false,
"description": "The API key"
},
{
"key": "id",
"value": null,
"disabled": false,
"description": "ID of a ticket to get statistics from"
},
{
"key": "start",
"value": null,
"disabled": false,
"description": "UNIX timestamp of the day/hour after which tickets have been created. Default last 24 hours"
},
{
"key": "end",
"value": null,
"disabled": false,
"description": "UNIX timestamp of the day/hour before tickets have been created"
},
{
"key": "limit",
"value": "500",
"disabled": false,
"description": "This is the amount of results that is returned."
},
{
"key": "offset",
"value": "0",
"disabled": false,
"description": "This is the amount of results skipped in the result set."
},
{
"key": "details",
"value": "0",
"disabled": false,
"description": "If specified return one line for each ticket and each assigned agent"
}
]
},
"method": "GET",
"header": [
{
"key": "Content-Type",
"value": "application/json",
"disabled": false,
"description": "Enable JSON requests"
}
],
"body": null,
"description": {
"content": "Get detailed statistical information on the specified ticket or all tickets created in the specified range and return them in csv format \n- TicketID: the ticket number \n
- Username: the name of the user \n
- Agent: the name of the current assigned agent \n
- Created: the creation timestamp of the ticket \n
- Closed: the time when the ticket has been closed \n
- DurationUntilClosed: the number of seconds between ticket creation and ticket closing \n
- Usermessages: the number of user messages sent while the ticket was opened or before the ticket was opened if the bot answered \n
- Botmessages: the number of bot messages sent while the ticket was opened or before the ticket was opened \n
- Agentmessages: the number of agent messages sent while the ticket was opened \n
- DurationChatWithBot: the number of seconds the user chatted with the bot before the ticket was created \n
- DurationUntilAssigned: the number of seconds between ticket creation and assignment to the agent \n
- DurationUntilFirstResponse: the number of seconds until the agent first responded to the user \n
- AverageResponseTime: the average number of seconds until the agent sent a response to the user \n
- TotalResponseTime: the total number of seconds the user had to wait until he got a response from an agent \n
",
"type": "text/markdown"
}
}
},
{
"id": "d66bae93-6f93-32c0-b563-16d3b03a2e4e",
"name": "[00] Chat Statistics",
"description": {
"content": "Get detailed statistical information on chat messages of the specified ticket or all tickets created in the specified range and return them in csv format \n- TicketID: the ticket number \n
- Username: the name of the user \n
- Agent: the name of the current assigned agent \n
- Created: the creation timestamp of the ticket \n
- Closed: the time when the ticket has been closed \n
- Labels: the assigned label(s) of the ticket \n
- ChatTime: the Unix timestamp of the chat message \n
- ResponseTime: for outgoing messages the number of seconds since last incoming message \n
- Outgoing: 0 for incoming message, 1 for outgoing \n
- Bot: for outgoing messages 1 for bot messages, 0 for agent messages \n
- Text: the message text \n
- Media: the media file \n
",
"type": "text/markdown"
},
"request": {
"url": {
"protocol": "https",
"host": "{{api_url}}",
"path": [
"v{{api_version}}",
"ticket",
"chatstatistics"
],
"variable": [],
"query": [
{
"key": "apikey",
"value": "{{apikey}}",
"disabled": false,
"description": "The API key"
},
{
"key": "id",
"value": null,
"disabled": false,
"description": "ID of a ticket to get statistics from"
},
{
"key": "start",
"value": null,
"disabled": false,
"description": "UNIX timestamp of the day/hour after which tickets have been created. Default last 24 hours"
},
{
"key": "end",
"value": null,
"disabled": false,
"description": "UNIX timestamp of the day/hour before tickets have been created"
},
{
"key": "limit",
"value": "500",
"disabled": false,
"description": "This is the amount of results that is returned."
},
{
"key": "offset",
"value": "0",
"disabled": false,
"description": "This is the amount of results skipped in the result set."
},
{
"key": "technical",
"value": "0",
"disabled": false,
"description": "If 1 include technical messages like Satellite location updates or Satellite closed messages"
},
{
"key": "labels",
"value": "0",
"disabled": false,
"description": "If 1 include ticket labels"
},
{
"key": "outgoing_only",
"value": "0",
"disabled": false,
"description": "If 1 include only outgoing messages"
}
]
},
"method": "GET",
"header": [
{
"key": "Content-Type",
"value": "application/json",
"disabled": false,
"description": "Enable JSON requests"
}
],
"body": null,
"description": {
"content": "Get detailed statistical information on chat messages of the specified ticket or all tickets created in the specified range and return them in csv format \n- TicketID: the ticket number \n
- Username: the name of the user \n
- Agent: the name of the current assigned agent \n
- Created: the creation timestamp of the ticket \n
- Closed: the time when the ticket has been closed \n
- Labels: the assigned label(s) of the ticket \n
- ChatTime: the Unix timestamp of the chat message \n
- ResponseTime: for outgoing messages the number of seconds since last incoming message \n
- Outgoing: 0 for incoming message, 1 for outgoing \n
- Bot: for outgoing messages 1 for bot messages, 0 for agent messages \n
- Text: the message text \n
- Media: the media file \n
",
"type": "text/markdown"
}
}
}
]
},
{
"id": "3bee393f-e4b1-3a1c-8cc5-43f9b4b9ed98",
"name": "[111] Tickets",
"description": "",
"item": [
{
"id": "1a86e26a-0dd1-31e3-8c69-a836d95979a7",
"name": "[00] Export Ticket PDF",
"description": {
"content": "Export PDF file with all ticket relevant data",
"type": "text/markdown"
},
"request": {
"url": {
"protocol": "https",
"host": "{{api_url}}",
"path": [
"v{{api_version}}",
"tickets",
":id",
"pdf"
],
"variable": [
{
"id": "b652aa87-92ef-33b4-a0f9-ce8e6287a379",
"key": "id",
"name": "id",
"type": "number",
"description": "The id of the ticket"
}
],
"query": [
{
"key": "apikey",
"value": "{{apikey}}",
"disabled": false,
"description": "The API key"
},
{
"key": "language",
"value": "en",
"disabled": false,
"description": "The output language. Possible values: 'en', 'de'"
},
{
"key": "as_link",
"value": "0",
"disabled": false,
"description": "Result as JSON with the field pdf linking to an url"
},
{
"key": "hidden",
"value": "0",
"disabled": false,
"description": "Include internal hidden user properties"
},
{
"key": "no_images",
"value": "0",
"disabled": false,
"description": "Include image URLs instead of images"
}
]
},
"method": "GET",
"header": [
{
"key": "Content-Type",
"value": "application/json",
"disabled": false,
"description": "Enable JSON requests"
}
],
"body": null,
"description": {
"content": "Export PDF file with all ticket relevant data",
"type": "text/markdown"
}
}
}
]
},
{
"id": "cd41e667-9f06-3b2b-9a45-3f46ac85c4c2",
"name": "[120] agent",
"description": "",
"item": [
{
"id": "733f4062-c967-3b66-aa05-74cfa74432b4",
"name": "[00] Profile",
"description": {
"content": "Get profile information of an agent",
"type": "text/markdown"
},
"request": {
"url": {
"protocol": "https",
"host": "{{api_url}}",
"path": [
"v{{api_version}}",
"agent",
":id"
],
"variable": [
{
"id": "abbb9e3e-4221-3a0f-9729-ed686ffd56bd",
"key": "id",
"name": "id",
"type": "integer",
"description": "The ID of an agent. If omitted list all agents."
}
],
"query": [
{
"key": "apikey",
"value": "{{apikey}}",
"disabled": false,
"description": "The API key"
},
{
"key": "open_tickets",
"value": null,
"disabled": false,
"description": "Include all open ticket IDs of the agent(s) and their waiting_since status."
}
]
},
"method": "GET",
"header": [
{
"key": "Content-Type",
"value": "application/json",
"disabled": false,
"description": "Enable JSON requests"
}
],
"body": null,
"description": {
"content": "Get profile information of an agent",
"type": "text/markdown"
}
}
},
{
"id": "898fe1d2-5e14-3297-b5fa-c3b8610bc1bd",
"name": "[00] Create",
"description": {
"content": "Create a new agent",
"type": "text/markdown"
},
"request": {
"url": {
"protocol": "https",
"host": "{{api_url}}",
"path": [
"v{{api_version}}",
"agent"
],
"variable": [],
"query": []
},
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json",
"disabled": false,
"description": "Enable JSON requests"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"apikey\": \"{{apikey}}\",\n \"email\": \"\",\n \"roles\": \"\",\n \"firstname\": \"\",\n \"lastname\": \"\",\n \"chatname\": \"\",\n \"profile_image\": \"\",\n \"notification\": false,\n \"all_channels\": false,\n \"channels\": \"\",\n \"projects\": \"\",\n \"active\": false,\n \"cc_mail\": \"\",\n \"two_factor_userid\": \"\"\n}"
},
"description": {
"content": "Create a new agent",
"type": "text/markdown"
}
}
},
{
"id": "724e7fd4-d690-306f-bc17-f39defbac25e",
"name": "[00] Update",
"description": {
"content": "Update profile information of an agent",
"type": "text/markdown"
},
"request": {
"url": {
"protocol": "https",
"host": "{{api_url}}",
"path": [
"v{{api_version}}",
"agent",
":id"
],
"variable": [
{
"id": "c9481598-3bc0-340c-bd7a-ccdcf6244dbe",
"key": "id",
"name": "id",
"type": "integer",
"description": "The ID of an agent."
}
],
"query": []
},
"method": "PUT",
"header": [
{
"key": "Content-Type",
"value": "application/json",
"disabled": false,
"description": "Enable JSON requests"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"apikey\": \"{{apikey}}\",\n \"roles\": \"\",\n \"firstname\": \"\",\n \"lastname\": \"\",\n \"chatname\": \"\",\n \"profile_image\": \"\",\n \"notification\": false,\n \"notification_delay\": \"10\",\n \"active\": false,\n \"all_channels\": false,\n \"channels\": \"\",\n \"projects\": \"\",\n \"language\": \"\",\n \"settings\": \"\",\n \"skills\": \"\",\n \"two_factor_userid\": \"\"\n}"
},
"description": {
"content": "Update profile information of an agent",
"type": "text/markdown"
}
}
},
{
"id": "94c2e3ea-3007-3463-ad2f-d4d759c58ec1",
"name": "[00] Status",
"description": {
"content": "Set the status of the logged in agent",
"type": "text/markdown"
},
"request": {
"url": {
"protocol": "https",
"host": "{{api_url}}",
"path": [
"v{{api_version}}",
"agent",
"status"
],
"variable": [],
"query": []
},
"method": "PUT",
"header": [
{
"key": "Content-Type",
"value": "application/json",
"disabled": false,
"description": "Enable JSON requests"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"apikey\": \"{{apikey}}\",\n \"status\": 0\n}"
},
"description": {
"content": "Set the status of the logged in agent",
"type": "text/markdown"
}
}
},
{
"id": "f492c16b-df40-3f38-8877-9fae36d961c9",
"name": "[00] Temporary Token",
"description": {
"content": "Get a temporary token for logging in with a second device. The token is valid for 10 minutes. The method is only usable by logged in agents.",
"type": "text/markdown"
},
"request": {
"url": {
"protocol": "https",
"host": "{{api_url}}",
"path": [
"v{{api_version}}",
"agent",
"temporary",
"token"
],
"variable": [],
"query": [
{
"key": "apikey",
"value": "{{apikey}}",
"disabled": false,
"description": "The API key"
}
]
},
"method": "GET",
"header": [
{
"key": "Content-Type",
"value": "application/json",
"disabled": false,
"description": "Enable JSON requests"
}
],
"body": null,
"description": {
"content": "Get a temporary token for logging in with a second device. The token is valid for 10 minutes. The method is only usable by logged in agents.",
"type": "text/markdown"
}
}
},
{
"id": "15f61fc0-8a19-3e52-8c55-1018ccef6b78",
"name": "[00] Two Factor Authentication",
"description": {
"content": "Get Two Factor authentication setting of an agent",
"type": "text/markdown"
},
"request": {
"url": {
"protocol": "https",
"host": "{{api_url}}",
"path": [
"v{{api_version}}",
"agent",
":id",
"twoFactor"
],
"variable": [
{
"id": "145440e0-5957-313d-9b20-0231c3b3778a",
"key": "id",
"name": "id",
"type": "integer",
"description": "The ID of an agent."
}
],
"query": [
{
"key": "apikey",
"value": "{{apikey}}",
"disabled": false,
"description": "The API key"
}
]
},
"method": "GET",
"header": [
{
"key": "Content-Type",
"value": "application/json",
"disabled": false,
"description": "Enable JSON requests"
}
],
"body": null,
"description": {
"content": "Get Two Factor authentication setting of an agent",
"type": "text/markdown"
}
}
},
{
"id": "f073fa04-0e83-3577-8cf5-b4b886cfaad7",
"name": "[00] Two Factor Authentication",
"description": {
"content": "Activate Two Factor authentication of an agent",
"type": "text/markdown"
},
"request": {
"url": {
"protocol": "https",
"host": "{{api_url}}",
"path": [
"v{{api_version}}",
"agent",
":id",
"twoFactor"
],
"variable": [
{
"id": "0a6f1e39-606d-3254-8ace-368d7fc4b94b",
"key": "id",
"name": "id",
"type": "integer",
"description": "The ID of an agent."
}
],
"query": []
},
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json",
"disabled": false,
"description": "Enable JSON requests"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"apikey\": \"{{apikey}}\"\n}"
},
"description": {
"content": "Activate Two Factor authentication of an agent",
"type": "text/markdown"
}
}
},
{
"id": "9d50cc22-b15f-3ef4-b118-7ab226da0171",
"name": "[00] Two Factor Authentication",
"description": {
"content": "Reactivate Two Factor authentication of an agent",
"type": "text/markdown"
},
"request": {
"url": {
"protocol": "https",
"host": "{{api_url}}",
"path": [
"v{{api_version}}",
"agent",
":id",
"twoFactor"
],
"variable": [
{
"id": "cc3887ae-5257-37cb-be46-c8bacd3f5e6f",
"key": "id",
"name": "id",
"type": "integer",
"description": "The ID of an agent."
}
],
"query": []
},
"method": "PUT",
"header": [
{
"key": "Content-Type",
"value": "application/json",
"disabled": false,
"description": "Enable JSON requests"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"apikey\": \"{{apikey}}\"\n}"
},
"description": {
"content": "Reactivate Two Factor authentication of an agent",
"type": "text/markdown"
}
}
},
{
"id": "1380691f-2444-39b4-9121-297a3e0ea143",
"name": "[00] Two Factor Authentication",
"description": {
"content": "Deactivate Two Factor authentication of an agent",
"type": "text/markdown"
},
"request": {
"url": {
"protocol": "https",
"host": "{{api_url}}",
"path": [
"v{{api_version}}",
"agent",
":id",
"twoFactor"
],
"variable": [
{
"id": "d7fbcd23-93fe-333a-af87-dc1787c72387",
"key": "id",
"name": "id",
"type": "integer",
"description": "The ID of an agent."
}
],
"query": [
{
"key": "apikey",
"value": "{{apikey}}",
"disabled": false,
"description": "The API key"
}
]
},
"method": "DELETE",
"header": [
{
"key": "Content-Type",
"value": "application/json",
"disabled": false,
"description": "Enable JSON requests"
}
],
"body": null,
"description": {
"content": "Deactivate Two Factor authentication of an agent",
"type": "text/markdown"
}
}
},
{
"id": "b273d35c-89ff-3a29-a49e-e6ca9c72c6e0",
"name": "[60] Password",
"description": {
"content": "Change the password of the logged in agent",
"type": "text/markdown"
},
"request": {
"url": {
"protocol": "https",
"host": "{{api_url}}",
"path": [
"v{{api_version}}",
"agent",
"password"
],
"variable": [],
"query": []
},
"method": "PUT",
"header": [
{
"key": "Content-Type",
"value": "application/json",
"disabled": false,
"description": "Enable JSON requests"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"apikey\": \"{{apikey}}\",\n \"new_password\": null\n}"
},
"description": {
"content": "Change the password of the logged in agent",
"type": "text/markdown"
}
}
},
{
"id": "db23e645-996e-3648-9dca-184fdd810ef1",
"name": "[70] Delete",
"description": {
"content": "Delete an agent. The owner of a customer account cannot be deleted.",
"type": "text/markdown"
},
"request": {
"url": {
"protocol": "https",
"host": "{{api_url}}",
"path": [
"v{{api_version}}",
"agent",
":id"
],
"variable": [
{
"id": "462a1794-4667-3ee3-9256-82a6b8e74dd6",
"key": "id",
"name": "id",
"type": "integer",
"description": "The ID of an agent"
}
],
"query": [
{
"key": "apikey",
"value": "{{apikey}}",
"disabled": false,
"description": "The API key"
}
]
},
"method": "DELETE",
"header": [
{
"key": "Content-Type",
"value": "application/json",
"disabled": false,
"description": "Enable JSON requests"
}
],
"body": null,
"description": {
"content": "Delete an agent. The owner of a customer account cannot be deleted.",
"type": "text/markdown"
}
}
}
]
},
{
"id": "0f9d8fba-fec8-380d-9847-77ac18fe054d",
"name": "[210] Skills",
"description": "",
"item": [
{
"id": "b39f5cc4-1177-3c9c-87d7-93c5f939c593",
"name": "[00] Skills",
"description": {
"content": "Get all skills",
"type": "text/markdown"
},
"request": {
"url": {
"protocol": "https",
"host": "{{api_url}}",
"path": [
"v{{api_version}}",
"skill",
":id"
],
"variable": [
{
"id": "219be743-318f-3b48-8c98-82c135456520",
"key": "id",
"name": "id",
"type": "int",
"description": "ID of the skill"
}
],
"query": [
{
"key": "apikey",
"value": "{{apikey}}",
"disabled": false,
"description": "The API key"
}
]
},
"method": "GET",
"header": [
{
"key": "Content-Type",
"value": "application/json",
"disabled": false,
"description": "Enable JSON requests"
}
],
"body": null,
"description": {
"content": "Get all skills",
"type": "text/markdown"
}
}
},
{
"id": "607550ad-45d5-3fe9-9b8f-7056fee6c260",
"name": "[00] Skills",
"description": {
"content": "Create a new skill",
"type": "text/markdown"
},
"request": {
"url": {
"protocol": "https",
"host": "{{api_url}}",
"path": [
"v{{api_version}}",
"skill"
],
"variable": [],
"query": []
},
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json",
"disabled": false,
"description": "Enable JSON requests"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"apikey\": \"{{apikey}}\",\n \"name\": \"\"\n}"
},
"description": {
"content": "Create a new skill",
"type": "text/markdown"
}
}
},
{
"id": "78b14a3e-b7a2-3b29-9593-11a89269cfda",
"name": "[00] Skills",
"description": {
"content": "Update an existing skill",
"type": "text/markdown"
},
"request": {
"url": {
"protocol": "https",
"host": "{{api_url}}",
"path": [
"v{{api_version}}",
"skill",
":id"
],
"variable": [
{
"id": "f2cde33f-06d1-3579-aaf6-e9a7aeeaf05f",
"key": "id",
"name": "id",
"type": "int",
"description": "ID of the skill"
}
],
"query": []
},
"method": "PUT",
"header": [
{
"key": "Content-Type",
"value": "application/json",
"disabled": false,
"description": "Enable JSON requests"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"apikey\": \"{{apikey}}\",\n \"name\": \"\"\n}"
},
"description": {
"content": "Update an existing skill",
"type": "text/markdown"
}
}
},
{
"id": "3a5e3460-4fde-307b-8255-0d9740edffc0",
"name": "[00] Skills",
"description": {
"content": "Delete a skill",
"type": "text/markdown"
},
"request": {
"url": {
"protocol": "https",
"host": "{{api_url}}",
"path": [
"v{{api_version}}",
"skill",
":id"
],
"variable": [
{
"id": "a06251c9-e6a0-3a40-8f31-2f7015990e4d",
"key": "id",
"name": "id",
"type": "int",
"description": "ID of the skill"
}
],
"query": [
{
"key": "apikey",
"value": "{{apikey}}",
"disabled": false,
"description": "The API key"
}
]
},
"method": "DELETE",
"header": [
{
"key": "Content-Type",
"value": "application/json",
"disabled": false,
"description": "Enable JSON requests"
}
],
"body": null,
"description": {
"content": "Delete a skill",
"type": "text/markdown"
}
}
},
{
"id": "81407142-c59f-31e5-ae82-e7a6e0072e76",
"name": "[00] Skill Autoroutes",
"description": {
"content": "Get all skill autoroutes",
"type": "text/markdown"
},
"request": {
"url": {
"protocol": "https",
"host": "{{api_url}}",
"path": [
"v{{api_version}}",
"skill",
"autoroutes"
],
"variable": [],
"query": [
{
"key": "apikey",
"value": "{{apikey}}",
"disabled": false,
"description": "The API key"
}
]
},
"method": "GET",
"header": [
{
"key": "Content-Type",
"value": "application/json",
"disabled": false,
"description": "Enable JSON requests"
}
],
"body": null,
"description": {
"content": "Get all skill autoroutes",
"type": "text/markdown"
}
}
},
{
"id": "b00830a0-4205-372f-8963-319eb06140f8",
"name": "[00] Skill Autoroutes",
"description": {
"content": "Create a new skill autoroute",
"type": "text/markdown"
},
"request": {
"url": {
"protocol": "https",
"host": "{{api_url}}",
"path": [
"v{{api_version}}",
"skill",
"autoroutes"
],
"variable": [],
"query": []
},
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json",
"disabled": false,
"description": "Enable JSON requests"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"apikey\": \"{{apikey}}\",\n \"keywords\": \"\",\n \"skills_id\": 0,\n \"position\": 0\n}"
},
"description": {
"content": "Create a new skill autoroute",
"type": "text/markdown"
}
}
},
{
"id": "219f64b6-feb1-3031-8c7e-d9a9deb22601",
"name": "[00] Skill Autoroutes",
"description": {
"content": "Update an existing skill autoroute",
"type": "text/markdown"
},
"request": {
"url": {
"protocol": "https",
"host": "{{api_url}}",
"path": [
"v{{api_version}}",
"skill",
"autoroutes",
":id"
],
"variable": [
{
"id": "b29ad48b-1e21-3ad7-9e53-41f187c101d0",
"key": "id",
"name": "id",
"type": "int",
"description": "ID of the skill autoroute"
}
],
"query": []
},
"method": "PUT",
"header": [
{
"key": "Content-Type",
"value": "application/json",
"disabled": false,
"description": "Enable JSON requests"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"apikey\": \"{{apikey}}\",\n \"keywords\": \"\",\n \"skills_id\": 0,\n \"position\": 0\n}"
},
"description": {
"content": "Update an existing skill autoroute",
"type": "text/markdown"
}
}
},
{
"id": "467a8be4-a013-3aee-b97d-9e3bd551352d",
"name": "[00] Skill Autoroutes",
"description": {
"content": "Delete a skill autoroute",
"type": "text/markdown"
},
"request": {
"url": {
"protocol": "https",
"host": "{{api_url}}",
"path": [
"v{{api_version}}",
"skill",
"autoroutes",
":id"
],
"variable": [
{
"id": "d992f2cb-5b30-30cf-b8de-4596fe9b277d",
"key": "id",
"name": "id",
"type": "int",
"description": "ID of the skill autoroute"
}
],
"query": [
{
"key": "apikey",
"value": "{{apikey}}",
"disabled": false,
"description": "The API key"
}
]
},
"method": "DELETE",
"header": [
{
"key": "Content-Type",
"value": "application/json",
"disabled": false,
"description": "Enable JSON requests"
}
],
"body": null,
"description": {
"content": "Delete a skill autoroute",
"type": "text/markdown"
}
}
}
]
}
],
"variable": [
{
"id": "1bf20bbf-6607-3d08-862e-2dace1443c4b",
"key": "api_url",
"name": "API URL",
"type": "string",
"value": "rest.messengerpeople.com/api",
"description": "The public MessengerPeople API URL"
},
{
"id": "b35b4b4b-f2b8-3556-9b14-f44f9be68100",
"key": "api_version",
"name": "API Version",
"type": "integer",
"value": 17,
"description": "The MessengerPeople API version"
},
{
"id": "3208558c-4344-3f9f-9330-0513c25f77c4",
"key": "apikey",
"name": "API Key",
"type": "string",
"value": "Enter your API key here",
"description": "Your MessengerPeople API key"
}
]
}