Inbox · Messages
Creates a conversation.
Request
Send your API key as Authorization: Bearer pz_live_.... Read-only keys cannot call it. Keys with the messages resource group disabled get 403 resource_group_disabled. Authentication
Request body
application/json, required
accountIdstringrequiredparticipantIdstringparticipantUsernamestringmessagestringsubjectstringUp to 998 characters.
ccarray of string (email)Up to 50 items.
skipDmCheckbooleanDefault
false.templateNamestringcategorystringOne of
utility.linkPreviewbooleanDefault
true.templateLanguagestringtemplateParamsarray of stringtemplateButtonParamsarray of objectUp to 10 items.
indexintegerrequired0 to 9.
subTypestringrequiredOne of
url,copy_code,flow.valuestringrequired
templateCardsarray of objectUp to 10 items.
cardIndexintegerrequired0 to 9.
paramsarray of stringheaderMediaobject3 child fields
typestringrequiredOne of
image,video,document.linkstringidstring
buttonsarray of objectUp to 2 items.
3 child fields
indexintegerrequired0 to 1.
subTypestringrequiredOne of
quick_reply,url.valuestringrequired
headerMediaobjecttypestringrequiredOne of
image,video,document.linkstringidstringfilenamestring
headerLocationobjectlatitudenumberrequiredlongitudenumberrequirednamestringaddressstring
Example
curl -X POST "https://api.pozy.ai/v1/inbox/conversations" \
-H "Authorization: Bearer $POZY_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"accountId": "696e0b682d0a31188e7a2ba9"
}'const res = await fetch("https://api.pozy.ai/v1/inbox/conversations", {
method: "POST",
headers: {
Authorization: `Bearer ${process.env.POZY_API_KEY}`,
"Content-Type": "application/json",
},
body: JSON.stringify({
accountId: "696e0b682d0a31188e7a2ba9"
}),
});
const data = await res.json();
if (!res.ok) throw new Error(data?.error ?? `Request failed with status ${res.status}`);
console.log(data);import os
import requests
resp = requests.post(
"https://api.pozy.ai/v1/inbox/conversations",
headers={"Authorization": f"Bearer {os.environ['POZY_API_KEY']}"},
json={
"accountId": "696e0b682d0a31188e7a2ba9",
},
timeout=30,
)
resp.raise_for_status()
print(resp.json())Response
201 on success
successbooleandataobjectmessageIdstringconversationIdstringparticipantIdstringparticipantNamestringCan be null.
participantUsernamestringCan be null.
201 response
{
"success": true,
"data": {
"messageId": "62d191e7089bc48b8ea56b35",
"conversationId": "6e525f3820fc636aa96d2ee9",
"participantId": "6f0150243551cb6ee41f35e0",
"participantName": "Acme",
"participantUsername": "acme"
}
}Errors
Errors use one shape: { error, type, code, param?, details? }. The ones you are most likely to see here:
| 400 | invalid_request_error | A parameter or body field is missing or invalid. param names it. |
| 401 | authentication_error | The API key is missing, revoked or expired. |
| 403 | permission_error | The key is read-only, scoped to other profiles, or has this resource group disabled. |
| 429 | rate_limit_error | Too many requests this minute. Wait for Retry-After seconds. |
Every code is listed in Errors.
More in Messages
GETList conversationsGETSearch conversationsGETGet conversationPUTUpdate conversation statusDELDelete conversationGETList messagesPOSTSend messagePATCHEdit messageDELDelete messagePOSTSend typing indicatorPOSTChange who answers a conversation (handover)POSTAccept a message requestGETList the Page's conversation labelsPOSTCreate a conversation labelDELDelete a conversation labelGETList the labels on a conversationPOSTAdd a label to a conversationDELRemove a label from a conversationPOSTMark a conversation as readPOSTAdd reactionDELRemove reactionPOSTUpload media fileGETResolve message attachment