{
"info": {
"_postman_id": "9af75936-7933-32bb-963d-7cdb24dfe25b",
"name": "MessengerPeople API (Version 13)",
"description": "The collection of all API endpoints of the MessengerPeople API",
"version": 13,
"schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json"
},
"item": [
{
"id": "a2a0cca2-e6c8-322f-952b-e4e75c25b1a9",
"name": "[10] login",
"description": "",
"item": [
{
"id": "7efef894-fa7e-3d6f-9d5b-9aa6d1f816ac",
"name": "[00] Login",
"description": {
"content": "Create an API token for this user, that can be used instead of the API key to identify the users actions.",
"type": "text/markdown"
},
"request": {
"url": {
"protocol": "https",
"host": "{{api_url}}",
"path": [
"v{{api_version}}",
"login"
],
"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 \"username\": \"\",\n \"password\": null,\n \"channel_type\": \"\",\n \"code\": \"\",\n \"token\": \"\",\n \"channel_id\": \"\",\n \"two_factor_userid\": \"\"\n}"
},
"description": {
"content": "Create an API token for this user, that can be used instead of the API key to identify the users actions.",
"type": "text/markdown"
}
}
},
{
"id": "c7af018e-36cf-3e8a-bd24-8b1a6976a7cb",
"name": "[00] Password Code",
"description": {
"content": "Generate a code that is sent to the email address of the agent for restoring a forgotten password.",
"type": "text/markdown"
},
"request": {
"url": {
"protocol": "https",
"host": "{{api_url}}",
"path": [
"v{{api_version}}",
"login",
"code"
],
"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 \"username\": \"\"\n}"
},
"description": {
"content": "Generate a code that is sent to the email address of the agent for restoring a forgotten password.",
"type": "text/markdown"
}
}
},
{
"id": "80149d01-a8ed-3d09-afec-e1921db7fdf8",
"name": "[00] Login",
"description": {
"content": "Logout a user who previously logged in",
"type": "text/markdown"
},
"request": {
"url": {
"protocol": "https",
"host": "{{api_url}}",
"path": [
"v{{api_version}}",
"login"
],
"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": "Logout a user who previously logged in",
"type": "text/markdown"
}
}
}
]
},
{
"id": "9d001299-d3e6-3132-a312-6e2686f497e1",
"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": "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": null,
"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": null,
"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 MIA.",
"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 MIA.",
"type": "text/markdown"
}
}
},
{
"id": "601dc9d9-b21b-39e3-ab41-f75b2866a7fb",
"name": "[00] Stop",
"description": {
"content": "Deactivate a user for MIA.",
"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 MIA.",
"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 (MIA 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 (MIA topics) of a user",
"type": "text/markdown"
}
}
},
{
"id": "2e7dd834-ce2a-3279-b83d-8d6b90ec12b9",
"name": "[00] Categories",
"description": {
"content": "Set categories (MIA 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 (MIA 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}"
},
"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": "7917d51e-5b83-3702-9e28-76964683324d",
"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 \"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 \"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": "306d8012-a0d2-38d3-9a7e-472ec2f6ff80",
"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
\n4 = Notification sent
5 = Notification delivered
6 = Notification read
-5 Notification failed
-6 Notification user does not exist",
"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 MIA 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
\n4 = Notification sent
5 = Notification delivered
6 = Notification read
-5 Notification failed
-6 Notification user does not exist",
"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}"
},
"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}"
},
"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": "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": "5753c66b-abf3-3fe9-b287-ab7a60d0339e",
"name": "[50] channel",
"description": "",
"item": [
{
"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": "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": "bot",
"value": "0",
"disabled": false,
"description": "Show automated / bot messages if bot = 1. If bot = 2 include also welcome and stop messages."
}
]
},
"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 MIA 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 MIA and the ticket system for customer support.",
"type": "text/markdown"
}
}
}
]
},
{
"id": "f7e7e8ce-2644-380a-880e-924d6c337491",
"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": "0283e73f-70a8-3a3b-a2be-cd26d5d412ba",
"name": "[65] MIA Content",
"description": "",
"item": [
{
"id": "56eb318e-bd21-3522-bdeb-009464c84436",
"name": "[00] List",
"description": {
"content": "List MIA 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."
}
]
},
"method": "GET",
"header": [
{
"key": "Content-Type",
"value": "application/json",
"disabled": false,
"description": "Enable JSON requests"
}
],
"body": null,
"description": {
"content": "List MIA 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 MIA content. This includes all users, MIA 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 MIA content. This includes all users, MIA topics and targeting groups with active users.",
"type": "text/markdown"
}
}
},
{
"id": "284cf086-66cc-3bdc-953e-f1e3b1ae0b42",
"name": "[00] Create",
"description": {
"content": "Create a new MIA 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}"
},
"description": {
"content": "Create a new MIA content",
"type": "text/markdown"
}
}
},
{
"id": "831c5329-8ebf-3dc5-9df8-44e107094da5",
"name": "[00] Update",
"description": {
"content": "Update an existing MIA 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}"
},
"description": {
"content": "Update an existing MIA 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 MIA 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 MIA content that is not yet published",
"type": "text/markdown"
}
}
}
]
},
{
"id": "c0dd6921-88db-3b1a-8a9a-216ed238c17c",
"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": "f74f54ca-faa3-32ca-9299-3f532c8afd71",
"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": "e15f46b9-4c4b-31b3-950d-7c6517e159c7",
"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": "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
{ \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.
{ \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": "083bdd80-f2aa-3744-a14f-4e486bb75b92", "name": "[00] Notifications", "description": { "content": "Get statistics of all sent notifications. \nThe output contains: \n