Контакты
Каждая операция этой группы: что она принимает, что возвращает и какими ошибками может ответить.
Операции
The address book, and it belongs to the workspace rather than to whoever saved a row. Every member and every key on the workspace reads and writes the same book.
A contact is addressed by its email address on every route here, because no id is exposed. Two things write rows: somebody saving one, in the app or through this API, which lands as manual, and a member sending mail from the app composer, which lands as auto. Mail ARRIVING from an address creates nothing, so an empty book on a busy mailbox is the expected state rather than a fault.
GET/contacts
List contacts
The address book belongs to the workspace, so every key on it reads the same rows and a contact saved by one member is visible to the rest.
Most recently seen first, with contacts that have never been mailed last. source is manual for an address somebody saved, in the app or through this API, and auto for one recorded because a member sent mail to it from the composer. Mail arriving from an address creates no contact.
Paging is keyset. Pass nextCursor back as cursor while hasMore is true.
Requires the contacts:read scope.
Параметры запроса
limitintegerRows per page, a whole number from 1 to 200. The server defaults to 50.
Не меньше 1Не больше 200По умолчанию50cursorstringThe
nextCursorfrom the previous page. Never build one yourself.sourcestringNarrows the page to contacts recorded that way.
Одно из"manual""auto""form"qstringSearches the name and the address. When nothing matches exactly on the first page, close spellings are returned instead, and the pages that follow keep matching the same way.
До 200 символов
Возвращает
Contacts in this workspace.
Ошибки
Ошибки, которые может вернуть любая операция400401403404422500Каталог ошибок
Также доступно в
POST/contacts
Create a contact
The address is the identity, so there is no id to choose and no id in the response. It is trimmed and lower cased before it is stored, and the contact is saved with source set to manual.
The new contact joins the built-in default audience as it is written, and any audience named in audienceIds alongside it. Naming audiences also requires the audiences:write scope.
An address already in the book is refused rather than merged, so a retry cannot overwrite a name somebody edited in the app.
Requires the contacts:write scope.
Тело запроса
emailstringОбязательноTrimmed and lower cased before it is stored.
До 320 символовФорматemailnamestringDisplay name. Leave it out to save the contact without one.
Может быть nullДо 200 символовnotesstringFree text kept with the contact and shown beside it in the app.
Может быть nullДо 5000 символовaudienceIdsstring[]Audiences to put the new contact in. The default audience is joined whether or not it is named here. Sending this also requires the
audiences:writescope.До 25 элементов
Возвращает
Created.
Ошибки
- 409
contact_exists: that address is already in this workspace book. PATCH it instead.
Ошибки, которые может вернуть любая операция400401403404422500Каталог ошибок
Также доступно в
GET/contacts/people
List people
Everyone on the Contacts page in the app: the saved contacts, and every address seen in mail as the sender or a recipient of a thread's newest message, with the number of threads and when mail last moved. A person seen in mail and saved is one row.
The addresses seen in mail are listed only when the key also holds threads:read, because they are read out of the mail. Without it the rows are the saved contacts alone and seen is false. A key limited to particular addresses or domains gets the saved contacts alone too, with seen false, even when it holds threads:read, because the other addresses would be read out of the mail of every address in the workspace. Deleted addresses and the mailbox's own addresses are left out.
blockedBy names the workspace blocklist rule that blocks a row, the same rule blocked=true filters on.
Requires the contacts:read scope.
Параметры запроса
limitintegerRows per page, 1 to 100.
Не меньше 1Не больше 100По умолчанию25cursorstringAn opaque cursor from the previous page, with the same
sort,qandblocked. Keyset, not offset: pass the previous page'snextCursor. One that names nothing in this list is a 400invalid_cursor.sortstringrecentputs the newest mail first, then saved contacts never seen in mail.namegoes by name, or by address where there is none, ignoring case.threadsputs the people with the most threads first.Одно из"recent""name""threads"По умолчанию"recent"qstringSearches names, addresses and notes, with close spellings when nothing matches exactly.
До 200 символовemailstringOne address only, matched case insensitively: the way to read one person's thread count and last mail.
До 320 символовblockedstringtruefor only the people the workspace blocklist blocks, whole-domain rules included.Одно из"true""false"
Возвращает
A page of people.
Ошибки
Ошибки, которые может вернуть любая операция400401403404422500Каталог ошибок
Также доступно в
POST/contacts/batch-delete
Delete contacts in bulk
Deletes up to 200 addresses in one call, each the way DELETE /contacts/{email} deletes one: a saved contact goes with its notes, photo and audience memberships, and every address is hidden, so a send does not record it again. Addresses that were only seen in mail are hidden too. An entry that is not an address comes back in invalid and the rest still go through.
Requires the contacts:write scope.
Тело запроса
emailsstring[]ОбязательноAddresses, matched case insensitively. A repeated address counts once.
От 1 до 200 элементов
Возвращает
What was deleted.
Ошибки
Ошибки, которые может вернуть любая операция400401403404422500Каталог ошибок
Также доступно в
GET/contacts/{email}
Retrieve a contact
The book is the workspace's. The address is matched case insensitively, and it is a path segment, so URL encode it: [email protected] travels as grace%40example.com.
A 404 means only that the address is not in the book. It says nothing about whether mail has been exchanged with it.
Requires the contacts:read scope.
Параметры пути
emailstringОбязательноThe contact's address, matched case insensitively.
Возвращает
The contact.
Ошибки
Ошибки, которые может вернуть любая операция400401403404422500Каталог ошибок
Также доступно в
PATCH/contacts/{email}
Update a contact
A partial update, never an upsert. An address not in the book is a 404.
The address itself cannot be changed: it is the identity and the path segment, so moving a contact to a new address is a delete and a create. source and lastSeenAt are the server's and are not accepted here.
Requires the contacts:write scope.
Параметры пути
emailstringОбязательноThe contact's address, matched case insensitively.
Тело запроса
namestringNew display name. Null clears it.
Может быть nullДо 200 символовnotesstringNew notes. Null clears them.
Может быть nullДо 5000 символов
Возвращает
Saved.
Ошибки
Ошибки, которые может вернуть любая операция400401403404422500Каталог ошибок
Также доступно в
PUT/contacts/{email}
Save a contact
Saves the address the way Add to contacts and Keep in contacts do in the app. An address that is not a contact yet becomes one, answered with 201. One recorded from a send becomes manual, and one already saved keeps what it has, answered with 200. A deleted address is brought back. The body is optional.
Requires the contacts:write scope.
Параметры пути
emailstringОбязательноThe address, trimmed and lower cased on the server.
Тело запроса
namestringUp to 200 characters. Left out, the stored name is kept.
До 200 символовnotesstringUp to 5,000 characters.
nullclears the notes; left out, they are kept.Может быть nullДо 5000 символов
Возвращает
Already a contact, now kept as manual.
Saved as a new contact.
Ошибки
- 422
unknown_parameterfor any key butnameandnotes.
Ошибки, которые может вернуть любая операция400401403404500Каталог ошибок
Также доступно в
DELETE/contacts/{email}
Delete a contact
Deletes somebody from the contacts the way Delete does in the app. A saved contact goes with its notes, its photo and every audience membership, the built-in default one included. The address is then hidden: it leaves GET /contacts/people, and mail sent to it from the app composer no longer records it. The address can be one that was only ever seen in mail.
No mail moves. Saving the address again, with POST /contacts or PUT /contacts/{email}, brings it back as a new contact.
Requires the contacts:write scope.
Параметры пути
emailstringОбязательноThe contact's address, matched case insensitively.
Возвращает
Deleted and hidden.
Ошибки
- 422
invalid_contactwhen the path is not an address.
Ошибки, которые может вернуть любая операция400401403404500Каталог ошибок
Также доступно в
PUT/contacts/{email}/photo
Set a contact photo
Uploads the photo shown for the contact, replacing any there was. Send the image itself as the body, not JSON, with its type in Content-Type: image/png, image/jpeg, image/webp, image/gif. Up to 5 MB goes in. It is fitted into a 512 pixel square and stored as WebP, and an animated image keeps its first frame.
The address has to be a saved contact: save it with PUT /contacts/{email} first.
Requires the contacts:write scope.
Параметры пути
emailstringОбязательноThe contact's address, matched case insensitively.
Тело запроса
Тип содержимогоimage/png, image/jpeg, image/webp, image/gif
Возвращает
The contact, with its new photoUrl.
Ошибки
- 404
contact_not_foundonemail: the address is not a saved contact.- 422
invalid_imagewhen the body is not an image of an accepted type, is too large or cannot be read.- 502
image_not_stored: the image was read but could not be stored. Try again.- 503
image_busy: the image service is saturated. Try again shortly.
Ошибки, которые может вернуть любая операция400401403500Каталог ошибок
Также доступно в
DELETE/contacts/{email}/photo
Remove a contact photo
Removes the contact photo and deletes the stored image. Removing a photo from a contact that has none changes nothing.
Requires the contacts:write scope.
Параметры пути
emailstringОбязательноThe contact's address, matched case insensitively.
Возвращает
The contact, with photoUrl null.
Ошибки
- 404
contact_not_foundonemail: the address is not a saved contact.
Ошибки, которые может вернуть любая операция400401403422500Каталог ошибок
Также доступно в
POST/contacts/{email}/block
Block a contact
Puts the address on the workspace blocklist, the one PATCH /settings edits as blockedSenders, so mail from it is refused from then on. A plus tag is dropped: blocking [email protected] blocks [email protected]. When a rule already blocks the address, a whole-domain one included, nothing is added and created is false. The address does not have to be a contact.
It needs settings:write, because it writes the blocklist rather than the contact.
Requires the settings:write scope.
Параметры пути
emailstringОбязательноThe address to block.
Возвращает
Blocked.
Ошибки
- 422
invalid_contactwhen the path is not an address,blocklist_entry_too_broadwhen it has fewer than two letters or numbers, or the narrowed-key refusal.capability_unsupportedonaddressAllowlist: the blocklist belongs to the whole workspace and filters the mail of every address in it, so a key limited to particular addresses or domains cannot change it. Use a key with no address or domain restriction.
Ошибки, которые может вернуть любая операция400401403404500Каталог ошибок
Также доступно в
DELETE/contacts/{email}/block
Unblock a contact
Takes every workspace blocklist rule that blocks the address off the list, and lists them in removed. When one is a whole-domain rule, everybody at that domain is unblocked with it. Rules set for one address or one domain in the settings are not touched. An address no rule blocks answers with removed empty.
Requires the settings:write scope.
Параметры пути
emailstringОбязательноThe address to unblock.
Возвращает
Unblocked.
Ошибки
- 422
invalid_contactwhen the path is not an address, or the narrowed-key refusal.capability_unsupportedonaddressAllowlist: the blocklist belongs to the whole workspace and filters the mail of every address in it, so a key limited to particular addresses or domains cannot change it. Use a key with no address or domain restriction.
Ошибки, которые может вернуть любая операция400401403404500Каталог ошибок
Также доступно в
GET/contacts/{email}/threads
List conversations with a contact
Every thread the address wrote or was written to, in every folder, the Mail tab on a contact in the app. The address does not have to be a saved contact. Each row is a summary of the thread; GET /threads/{id} reads the messages.
Requires the threads:read scope.
Параметры пути
emailstringОбязательноThe address. It does not have to be a saved contact.
Параметры запроса
limitintegerThreads per page, 1 to 100.
Не меньше 1Не больше 100По умолчанию25cursorstringThe previous page's
nextCursor, with the sameqandsort.qstringSearches inside those threads, with the same syntax as the mailbox search.
До 200 символовsortstringnewest(the default),oldest,senderorsubject.Одно из"newest""oldest""sender""subject"По умолчанию"newest"
Возвращает
A page of threads.
Ошибки
- 422
invalid_contactwhen the path is not an address, or the narrowed-key refusal.capability_unsupportedonaddressAllowlist: a contact's threads and activity are read from the mail of every address in the workspace, so a key limited to particular addresses or domains cannot read them. Use a key with no address or domain restriction.
Ошибки, которые может вернуть любая операция400401403404500Каталог ошибок
Также доступно в
GET/contacts/{email}/activity
Read activity with a contact
The Activity tab on a contact in the app: messages received from the address and sent to it, per bucket, over a window that ends now, with the threads that moved, the threads waiting on a reply from the mailbox, and the median time each side takes to answer. Mail in the bin or in spam is left out.
Requires the threads:read scope.
Параметры пути
emailstringОбязательноThe address. It does not have to be a saved contact.
Параметры запроса
minutesintegerHow far back the window reaches from now. The default is 90 days.
Не меньше 1Не больше 10540800По умолчанию129600grainstringBucket width:
minute,hourorday, defaulting today.Одно из"minute""hour""day"По умолчанию"day"offsetMinutesintegerThe reader's offset from UTC in minutes, so that a day bucket falls on their calendar.
Не меньше -840Не больше 840По умолчанию0
Возвращает
The activity.
Ошибки
- 422
invalid_contactwhen the path is not an address, or the narrowed-key refusal.capability_unsupportedonaddressAllowlist: a contact's threads and activity are read from the mail of every address in the workspace, so a key limited to particular addresses or domains cannot read them. Use a key with no address or domain restriction.
Ошибки, которые может вернуть любая операция400401403404500Каталог ошибок
Также доступно в
PUT/contacts/{email}/audiences
Set a contact's audiences
Sets exactly which audiences the contact is in, the way the audience picker on a contact does in the app. The contact joins every listed audience it is not in yet and leaves every other one, in one transaction. The built-in default audience is always kept, so { "audienceIds": [] } leaves the contact in the default audience alone. Memberships it keeps also keep their addedAt.
The address is matched case insensitively and has to be a contact already. Create it with POST /contacts, which takes audienceIds too. An id that names no audience in this workspace refuses the whole call and changes nothing.
audiences:write is the only scope checked, because this writes memberships rather than the contact. Sending the same list again changes nothing, so a retry is safe.
Requires the audiences:write scope.
Параметры пути
emailstringОбязательноThe contact's address, matched case insensitively.
Тело запроса
audienceIdsstring[]ОбязательноEvery audience the contact should be in once the call returns, up to 100. The default audience is kept whether or not it is named, so an empty array leaves only the default one. A repeated id counts once.
До 100 элементов
Возвращает
The contact, with the audiences it is in after the change.
Ошибки
- 404
contact_not_foundonemailwhen the address is not in the workspace book, oraudience_not_foundonaudienceIdswhen an id names no audience here. Nothing is changed.- 422
invalid_parameteronaudienceIdsfor more than 100 ids, and on the entry, such asaudienceIds.0, for an empty one,unknown_parameterfor any other key in the body.
Ошибки, которые может вернуть любая операция400401403500Каталог ошибок
Также доступно в
Объекты
Contactobject
objectstring- Одно из
"contact" emailstringTrimmed and lower cased on write. This is the key every contact route takes, because no contact id is exposed.
namestring- Может быть null
sourcestringautowhen a send from the app composer recorded the address,manualwhen somebody saved it here or in the app. A recorded send never downgrades amanualcontact toauto.Одно из"manual""auto""form"notesstring- Может быть null
photoUrlstringWhere the contact photo is served, or null when the contact has none. Set it with
PUT /contacts/{email}/photo. A new upload gets a new URL.Может быть nulllastSeenAtstringWhen mail last went to this address from the app composer. Null until it does.
Может быть nullФорматdate-timecreatedAtstring- Формат
date-time updatedAtstring- Формат
date-time
ContactActivityobject
objectstring- Одно из
"contact_activity" emailstringsincestringThe start of the first bucket, on the boundary
grainandoffsetMinutesput it.Форматdate-timeuntilstring- Формат
date-time grainstring- Одно из
"minute""hour""day" bucketsobject[]Only the buckets with mail in them, oldest first.
bucketstringThe bucket in the reader's time:
2026-09-23,2026-09-23T14or2026-09-23T14:05.receivedintegerMessages from this address.
sentintegerMessages from the mailbox to this address.
totalsobjectreceivedintegersentintegerthreadsintegerThreads with at least one message in the window.
waitingintegerThreads whose newest message is from this address, so the mailbox owes the reply.
lastReceivedAtstring- Может быть nullФормат
date-time lastSentAtstring- Может быть nullФормат
date-time
replyTimeobjectyoursnumberMedian milliseconds the mailbox took to answer, or null without a reply to measure.
Может быть nulltheirsnumberMedian milliseconds this address took to answer.
Может быть null
ContactBatchDeleteobject
objectstring- Одно из
"contact_batch_delete" deletedintegerAddresses deleted and hidden, saved or not.
savedintegerOf those, how many were saved contacts.
invalidstring[]Entries that are not addresses, lower cased. Nothing happened to them.
ContactBlockobject
objectstring- Одно из
"contact_block" emailstringThe address as the blocklist sees it: lower cased, with any plus tag dropped.
blockedbooleanblockedByobjectOn a block, the rule that now blocks the address.
Может быть nullrulestringThe entry on the workspace blocklist that matches this address, exactly as it is stored.
liststringblockedSendersfor an address or pattern rule,blockedDomainsfor a rule that blocks a whole domain and every subdomain under it.Одно из"blockedSenders""blockedDomains"
createdbooleanOn a block, false when a rule already blocked the address and nothing was added.
removedobject[]On an unblock, every rule taken off the workspace blocklist. A
blockedDomainsentry here unblocked the whole domain.rulestringThe entry on the workspace blocklist that matches this address, exactly as it is stored.
liststringblockedSendersfor an address or pattern rule,blockedDomainsfor a rule that blocks a whole domain and every subdomain under it.Одно из"blockedSenders""blockedDomains"
ContactDetailobject
objectstring- Одно из
"contact" emailstringTrimmed and lower cased on write. This is the key every contact route takes, because no contact id is exposed.
namestring- Может быть null
sourcestringautowhen a send from the app composer recorded the address,manualwhen somebody saved it here or in the app. A recorded send never downgrades amanualcontact toauto.Одно из"manual""auto""form"notesstring- Может быть null
photoUrlstringWhere the contact photo is served, or null when the contact has none. Set it with
PUT /contacts/{email}/photo. A new upload gets a new URL.Может быть nulllastSeenAtstringWhen mail last went to this address from the app composer. Null until it does.
Может быть nullФорматdate-timecreatedAtstring- Формат
date-time updatedAtstring- Формат
date-time audiencesobject[]Every audience this contact is in, the built-in default one included. Single-contact responses carry it; the list route does not.
idstringThe audience handle,
aud_plus 24 hex.namestringbuiltinstringdefaulton the one audience every contact joins, null on an audience somebody created.Может быть nullОдно из"default"
ContactListobject
objectstring- Одно из
"list" dataContact[]hasMorebooleannextCursorstring- Может быть null
ContactThreadobject
objectstring- Одно из
"thread" idstringThe id
GET /threads/{id}takes.subjectstring- Может быть null
fromobjectWho sent the newest message.
Может быть nullnamestring- Может быть null
emailstring
receivedAtstringWhen the newest message arrived or went out.
Может быть nullmessageCountintegerhasUnreadbooleanlabelsobject[]idstringnamestring
ContactThreadListobject
objectstring- Одно из
"list" dataContactThread[]hasMorebooleanTrue when another page follows. Pass
nextCursorback ascursorto read it.nextCursorstringOpaque. Pass it back as
cursorfor the next page, and never build one yourself.Может быть null
DeletedContactobject
objectstring- Одно из
"contact" emailstringdeletedboolean- Одно из
true wasSavedbooleanTrue when a saved contact was removed, false when the address was only seen in mail and has now been hidden.
Personobject
objectstring- Одно из
"person" emailstringLower cased. The key every contact route takes.
displayEmailstringThe address as the most recent message wrote it, which may carry capitals.
namestringThe saved name, or else the newest display name seen in mail.
Может быть nullsavedbooleanTrue when the address is a saved contact.
sourcestringAs on a contact, or null when the address is only seen in mail.
Может быть nullОдно из"manual""auto""form"notesstring- Может быть null
photoUrlstring- Может быть null
threadsintegerHow many threads have this address as the sender or a recipient of their newest message. Null when the key does not read mail or the address has never been seen in it.
Может быть nulllastAtstringWhen the newest of those threads last moved. Null for a saved contact never seen in mail.
Может быть nullФорматdate-timecreatedAtstring- Может быть nullФормат
date-time updatedAtstring- Может быть nullФормат
date-time blockedByobjectThe workspace blocklist rule that blocks this address, or null when none does.
Может быть nullrulestringThe entry on the workspace blocklist that matches this address, exactly as it is stored.
liststringblockedSendersfor an address or pattern rule,blockedDomainsfor a rule that blocks a whole domain and every subdomain under it.Одно из"blockedSenders""blockedDomains"
PersonListobject
objectstring- Одно из
"list" dataPerson[]hasMorebooleanTrue when another page follows. Pass
nextCursorback ascursorto read it.nextCursorstringOpaque. Pass it back as
cursorfor the next page, and never build one yourself.Может быть nullseenbooleanTrue when the addresses seen in mail are included, which needs
threads:read. False means the rows are the saved contacts alone.