Email, calendar & files · Email
Marks a read or starred, or move a message.
PATCH
https://api.pozy.ai/v1/email/messages/{messageId}updateEmailMessage
Guides: Email, Email, calendar & files, Google Workspace
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
Path parameters
| Name | Type | Notes |
|---|---|---|
messageIdrequired | string |
Request body
application/json, required
accountIdstringrequiredunreadbooleanstarredbooleanfolderstring
Example
curl -X PATCH "https://api.pozy.ai/v1/email/messages/62d191e7089bc48b8ea56b35" \
-H "Authorization: Bearer $POZY_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"accountId": "696e0b682d0a31188e7a2ba9"
}'const res = await fetch("https://api.pozy.ai/v1/email/messages/62d191e7089bc48b8ea56b35", {
method: "PATCH",
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.patch(
"https://api.pozy.ai/v1/email/messages/62d191e7089bc48b8ea56b35",
headers={"Authorization": f"Bearer {os.environ['POZY_API_KEY']}"},
json={
"accountId": "696e0b682d0a31188e7a2ba9",
},
timeout=30,
)
resp.raise_for_status()
print(resp.json())Response
200 on success
dataobject21 child fields
idstringthreadIdstringaccountIdstringproviderstringOne of
google,microsoft.foldersarray of stringfromobjectOne of:
Email Address (2 fields)
emailstring (email)requirednamestringCan be null.
toarray of object2 child fields
emailstring (email)requirednamestringCan be null.
ccarray of object2 child fields
emailstring (email)requirednamestringCan be null.
bccarray of object2 child fields
emailstring (email)requirednamestringCan be null.
replyToarray of object2 child fields
emailstring (email)requirednamestringCan be null.
subjectstringsnippetstringtextstringCan be null.
htmlstringCan be null.
attachmentsarray of object6 child fields
idstringfilenamestringcontentTypestringsizeintegerisInlinebooleancontentIdstringCan be null.
headersmap of stringrawstringdatestring (date-time)unreadbooleanstarredbooleanmetadatamap of string
200 response
{
"data": {
"id": "6bfebd43ddc270f6d2c56fc5",
"threadId": "60186572e25ff711298bf12e",
"accountId": "696e0b682d0a31188e7a2ba9",
"provider": "google",
"folders": [
"string"
],
"from": {
"email": "alex@example.com",
"name": "Acme"
},
"to": [
{
"email": "alex@example.com",
"name": "Acme"
}
],
"cc": [
{
"email": "alex@example.com",
"name": "Acme"
}
],
"bcc": [
{
"email": "alex@example.com",
"name": "Acme"
}
],
"replyTo": [
{
"email": "alex@example.com",
"name": "Acme"
}
],
"subject": "string",
"snippet": "string",
"text": "Hello from Pozy",
"html": "string",
"attachments": [
{
"id": "6bfebd43ddc270f6d2c56fc5",
"filename": "photo.jpg",
"contentType": "image/jpeg",
"size": 482133,
"isInline": true,
"contentId": "6e56e1ad0e43e2da5ef935a5"
}
],
"headers": {
"key": "string"
},
"raw": "string",
"date": "2026-10-02T09:00:00.000Z",
"unread": true,
"starred": true,
"metadata": {
"key": "string"
}
}
}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. |
| 404 | not_found | Nothing with that id exists in your workspace. |
| 429 | rate_limit_error | Too many requests this minute. Wait for Retry-After seconds. |
Every code is listed in Errors.