--- title: "Contacts" description: "Every operation in this group: what it accepts, what it returns and the errors it can answer with." url: "https://openemail.uk/docs/api/reference/contacts" area: "API" category: "Reference" --- # Contacts Every operation in this group: what it accepts, what it returns and the errors it can answer with. ## Operations 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. - Scopes: `contacts:read`. **Query parameters** - `limit` (`integer`, at least 1, at most 200, default `50`): Rows per page, a whole number from 1 to 200. The server defaults to 50. - `cursor` (`string`): The `nextCursor` from the previous page. Never build one yourself. - `source` (`string`, one of `"manual"`, `"auto"`, `"form"`): Narrows the page to contacts recorded that way. - `q` (`string`, up to 200 characters): Searches 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. **Returns** - `200` `ContactList`: Contacts in this workspace. **Errors** - The errors every operation can return: `400`, `401`, `403`, `404`, `422`, `500`, described in the [error catalog](https://openemail.uk/docs/api/errors). Also available in: SDK [`contacts.list()`](https://openemail.uk/docs/sdk/reference/contacts#list), [`contacts.listAll()`](https://openemail.uk/docs/sdk/reference/contacts#listAll), [`contacts.iterate()`](https://openemail.uk/docs/sdk/reference/contacts#iterate); CLI [`openemail contacts list`](https://openemail.uk/docs/cli/reference/contacts#contacts-list); MCP [`listContacts`](https://openemail.uk/docs/mcp/tools/contacts#listContacts). ### `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. - Scopes: `contacts:write`. **Request body** - `email` (`string`, required, up to 320 characters, format `email`): Trimmed and lower cased before it is stored. - `name` (`string`, nullable, up to 200 characters): Display name. Leave it out to save the contact without one. - `notes` (`string`, nullable, up to 5000 characters): Free text kept with the contact and shown beside it in the app. - `audienceIds` (`string[]`, up to 25 items): 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:write` scope. **Returns** - `201` `ContactDetail`: Created. **Errors** - `409`: `contact_exists`: that address is already in this workspace book. PATCH it instead. - The errors every operation can return: `400`, `401`, `403`, `404`, `422`, `500`, described in the [error catalog](https://openemail.uk/docs/api/errors). Also available in: SDK [`contacts.create()`](https://openemail.uk/docs/sdk/reference/contacts#create); CLI [`openemail contacts create`](https://openemail.uk/docs/cli/reference/contacts#contacts-create); MCP [`createContact`](https://openemail.uk/docs/mcp/tools/contacts#createContact), [`saveContact`](https://openemail.uk/docs/mcp/tools/contacts#saveContact), [`updateContact`](https://openemail.uk/docs/mcp/tools/contacts#updateContact). ### `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. - Scopes: `contacts:read`. **Query parameters** - `limit` (`integer`, at least 1, at most 100, default `25`): Rows per page, 1 to 100. - `cursor` (`string`): An opaque cursor from the previous page, with the same `sort`, `q` and `blocked`. Keyset, not offset: pass the previous page's `nextCursor`. One that names nothing in this list is a 400 `invalid_cursor`. - `sort` (`string`, one of `"recent"`, `"name"`, `"threads"`, default `"recent"`): `recent` puts the newest mail first, then saved contacts never seen in mail. `name` goes by name, or by address where there is none, ignoring case. `threads` puts the people with the most threads first. - `q` (`string`, up to 200 characters): Searches names, addresses and notes, with close spellings when nothing matches exactly. - `email` (`string`, up to 320 characters): One address only, matched case insensitively: the way to read one person's thread count and last mail. - `blocked` (`string`, one of `"true"`, `"false"`): `true` for only the people the workspace blocklist blocks, whole-domain rules included. **Returns** - `200` `PersonList`: A page of people. **Errors** - The errors every operation can return: `400`, `401`, `403`, `404`, `422`, `500`, described in the [error catalog](https://openemail.uk/docs/api/errors). Also available in: SDK [`contacts.listPeople()`](https://openemail.uk/docs/sdk/reference/contacts#listPeople), [`contacts.listAllPeople()`](https://openemail.uk/docs/sdk/reference/contacts#listAllPeople), [`contacts.iteratePeople()`](https://openemail.uk/docs/sdk/reference/contacts#iteratePeople); CLI [`openemail contacts list-people`](https://openemail.uk/docs/cli/reference/contacts#contacts-list-people); MCP [`listPeople`](https://openemail.uk/docs/mcp/tools/contacts#listPeople). ### `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. - Scopes: `contacts:write`. **Request body** - `emails` (`string[]`, required, 1 to 200 items): Addresses, matched case insensitively. A repeated address counts once. **Returns** - `200` `ContactBatchDelete`: What was deleted. **Errors** - The errors every operation can return: `400`, `401`, `403`, `404`, `422`, `500`, described in the [error catalog](https://openemail.uk/docs/api/errors). Also available in: SDK [`contacts.deleteMany()`](https://openemail.uk/docs/sdk/reference/contacts#deleteMany); CLI [`openemail contacts delete-many`](https://openemail.uk/docs/cli/reference/contacts#contacts-delete-many); MCP [`deleteContacts`](https://openemail.uk/docs/mcp/tools/contacts#deleteContacts). ### `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: `grace@example.com` 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. - Scopes: `contacts:read`. **Path parameters** - `email` (`string`, required): The contact's address, matched case insensitively. **Returns** - `200` `ContactDetail`: The contact. **Errors** - The errors every operation can return: `400`, `401`, `403`, `404`, `422`, `500`, described in the [error catalog](https://openemail.uk/docs/api/errors). Also available in: SDK [`contacts.get()`](https://openemail.uk/docs/sdk/reference/contacts#get); CLI [`openemail contacts get`](https://openemail.uk/docs/cli/reference/contacts#contacts-get); MCP [`getContact`](https://openemail.uk/docs/mcp/tools/contacts#getContact). ### `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. - Scopes: `contacts:write`. **Path parameters** - `email` (`string`, required): The contact's address, matched case insensitively. **Request body** - `name` (`string`, nullable, up to 200 characters): New display name. Null clears it. - `notes` (`string`, nullable, up to 5000 characters): New notes. Null clears them. **Returns** - `200` `ContactDetail`: Saved. **Errors** - The errors every operation can return: `400`, `401`, `403`, `404`, `422`, `500`, described in the [error catalog](https://openemail.uk/docs/api/errors). Also available in: SDK [`contacts.update()`](https://openemail.uk/docs/sdk/reference/contacts#update); CLI [`openemail contacts update`](https://openemail.uk/docs/cli/reference/contacts#contacts-update); MCP [`createContact`](https://openemail.uk/docs/mcp/tools/contacts#createContact), [`saveContact`](https://openemail.uk/docs/mcp/tools/contacts#saveContact), [`updateContact`](https://openemail.uk/docs/mcp/tools/contacts#updateContact). ### `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. - Scopes: `contacts:write`. **Path parameters** - `email` (`string`, required): The address, trimmed and lower cased on the server. **Request body** - `name` (`string`, up to 200 characters): Up to 200 characters. Left out, the stored name is kept. - `notes` (`string`, nullable, up to 5000 characters): Up to 5,000 characters. `null` clears the notes; left out, they are kept. **Returns** - `200` `ContactDetail`: Already a contact, now kept as `manual`. - `201` `ContactDetail`: Saved as a new contact. **Errors** - `422`: `unknown_parameter` for any key but `name` and `notes`. - The errors every operation can return: `400`, `401`, `403`, `404`, `500`, described in the [error catalog](https://openemail.uk/docs/api/errors). Also available in: SDK [`contacts.save()`](https://openemail.uk/docs/sdk/reference/contacts#save); CLI [`openemail contacts save`](https://openemail.uk/docs/cli/reference/contacts#contacts-save); MCP [`createContact`](https://openemail.uk/docs/mcp/tools/contacts#createContact), [`saveContact`](https://openemail.uk/docs/mcp/tools/contacts#saveContact), [`updateContact`](https://openemail.uk/docs/mcp/tools/contacts#updateContact). ### `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. - Scopes: `contacts:write`. **Path parameters** - `email` (`string`, required): The contact's address, matched case insensitively. **Returns** - `200` `DeletedContact`: Deleted and hidden. **Errors** - `422`: `invalid_contact` when the path is not an address. - The errors every operation can return: `400`, `401`, `403`, `404`, `500`, described in the [error catalog](https://openemail.uk/docs/api/errors). Also available in: SDK [`contacts.delete()`](https://openemail.uk/docs/sdk/reference/contacts#delete); CLI [`openemail contacts delete`](https://openemail.uk/docs/cli/reference/contacts#contacts-delete); MCP [`deleteContact`](https://openemail.uk/docs/mcp/tools/contacts#deleteContact). ### `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. - Scopes: `contacts:write`. **Path parameters** - `email` (`string`, required): The contact's address, matched case insensitively. **Request body** Content type: `image/png`, `image/jpeg`, `image/webp`, `image/gif`. `binary` **Returns** - `200` `ContactDetail`: The contact, with its new `photoUrl`. **Errors** - `404`: `contact_not_found` on `email`: the address is not a saved contact. - `422`: `invalid_image` when 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. - The errors every operation can return: `400`, `401`, `403`, `500`, described in the [error catalog](https://openemail.uk/docs/api/errors). Also available in: SDK [`contacts.setPhoto()`](https://openemail.uk/docs/sdk/reference/contacts#setPhoto); CLI [`openemail contacts set-photo`](https://openemail.uk/docs/cli/reference/contacts#contacts-set-photo); MCP [`setContactPhoto`](https://openemail.uk/docs/mcp/tools/contacts#setContactPhoto). ### `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. - Scopes: `contacts:write`. **Path parameters** - `email` (`string`, required): The contact's address, matched case insensitively. **Returns** - `200` `ContactDetail`: The contact, with `photoUrl` null. **Errors** - `404`: `contact_not_found` on `email`: the address is not a saved contact. - The errors every operation can return: `400`, `401`, `403`, `422`, `500`, described in the [error catalog](https://openemail.uk/docs/api/errors). Also available in: SDK [`contacts.removePhoto()`](https://openemail.uk/docs/sdk/reference/contacts#removePhoto); CLI [`openemail contacts remove-photo`](https://openemail.uk/docs/cli/reference/contacts#contacts-remove-photo); MCP [`removeContactPhoto`](https://openemail.uk/docs/mcp/tools/contacts#removeContactPhoto). ### `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 `ada+news@example.com` blocks `ada@example.com`. 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. - Scopes: `settings:write`. **Path parameters** - `email` (`string`, required): The address to block. **Returns** - `200` `ContactBlock`: Blocked. **Errors** - `422`: `invalid_contact` when the path is not an address, `blocklist_entry_too_broad` when it has fewer than two letters or numbers, or the narrowed-key refusal. `capability_unsupported` on `addressAllowlist`: 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. - The errors every operation can return: `400`, `401`, `403`, `404`, `500`, described in the [error catalog](https://openemail.uk/docs/api/errors). Also available in: SDK [`contacts.block()`](https://openemail.uk/docs/sdk/reference/contacts#block); CLI [`openemail contacts block`](https://openemail.uk/docs/cli/reference/contacts#contacts-block). ### `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. - Scopes: `settings:write`. **Path parameters** - `email` (`string`, required): The address to unblock. **Returns** - `200` `ContactBlock`: Unblocked. **Errors** - `422`: `invalid_contact` when the path is not an address, or the narrowed-key refusal. `capability_unsupported` on `addressAllowlist`: 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. - The errors every operation can return: `400`, `401`, `403`, `404`, `500`, described in the [error catalog](https://openemail.uk/docs/api/errors). Also available in: SDK [`contacts.unblock()`](https://openemail.uk/docs/sdk/reference/contacts#unblock); CLI [`openemail contacts unblock`](https://openemail.uk/docs/cli/reference/contacts#contacts-unblock). ### `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. - Scopes: `threads:read`. **Path parameters** - `email` (`string`, required): The address. It does not have to be a saved contact. **Query parameters** - `limit` (`integer`, at least 1, at most 100, default `25`): Threads per page, 1 to 100. - `cursor` (`string`): The previous page's `nextCursor`, with the same `q` and `sort`. - `q` (`string`, up to 200 characters): Searches inside those threads, with the same syntax as the mailbox search. - `sort` (`string`, one of `"newest"`, `"oldest"`, `"sender"`, `"subject"`, default `"newest"`): `newest` (the default), `oldest`, `sender` or `subject`. **Returns** - `200` `ContactThreadList`: A page of threads. **Errors** - `422`: `invalid_contact` when the path is not an address, or the narrowed-key refusal. `capability_unsupported` on `addressAllowlist`: 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. - The errors every operation can return: `400`, `401`, `403`, `404`, `500`, described in the [error catalog](https://openemail.uk/docs/api/errors). Also available in: SDK [`contacts.listThreads()`](https://openemail.uk/docs/sdk/reference/contacts#listThreads), [`contacts.listAllThreads()`](https://openemail.uk/docs/sdk/reference/contacts#listAllThreads), [`contacts.iterateThreads()`](https://openemail.uk/docs/sdk/reference/contacts#iterateThreads); CLI [`openemail contacts list-threads`](https://openemail.uk/docs/cli/reference/contacts#contacts-list-threads). ### `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. - Scopes: `threads:read`. **Path parameters** - `email` (`string`, required): The address. It does not have to be a saved contact. **Query parameters** - `minutes` (`integer`, at least 1, at most 10540800, default `129600`): How far back the window reaches from now. The default is 90 days. - `grain` (`string`, one of `"minute"`, `"hour"`, `"day"`, default `"day"`): Bucket width: `minute`, `hour` or `day`, defaulting to `day`. - `offsetMinutes` (`integer`, at least -840, at most 840, default `0`): The reader's offset from UTC in minutes, so that a day bucket falls on their calendar. **Returns** - `200` `ContactActivity`: The activity. **Errors** - `422`: `invalid_contact` when the path is not an address, or the narrowed-key refusal. `capability_unsupported` on `addressAllowlist`: 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. - The errors every operation can return: `400`, `401`, `403`, `404`, `500`, described in the [error catalog](https://openemail.uk/docs/api/errors). Also available in: SDK [`contacts.activity()`](https://openemail.uk/docs/sdk/reference/contacts#activity); CLI [`openemail contacts activity`](https://openemail.uk/docs/cli/reference/contacts#contacts-activity); MCP [`getContactActivity`](https://openemail.uk/docs/mcp/tools/contacts#getContactActivity). ### `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. - Scopes: `audiences:write`. **Path parameters** - `email` (`string`, required): The contact's address, matched case insensitively. **Request body** - `audienceIds` (`string[]`, required, up to 100 items): 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. **Returns** - `200` `ContactDetail`: The contact, with the audiences it is in after the change. **Errors** - `404`: `contact_not_found` on `email` when the address is not in the workspace book, or `audience_not_found` on `audienceIds` when an id names no audience here. Nothing is changed. - `422`: `invalid_parameter` on `audienceIds` for more than 100 ids, and on the entry, such as `audienceIds.0`, for an empty one, `unknown_parameter` for any other key in the body. - The errors every operation can return: `400`, `401`, `403`, `500`, described in the [error catalog](https://openemail.uk/docs/api/errors). Also available in: SDK [`contacts.setAudiences()`](https://openemail.uk/docs/sdk/reference/contacts#setAudiences); CLI [`openemail contacts set-audiences`](https://openemail.uk/docs/cli/reference/contacts#contacts-set-audiences); MCP [`setContactAudiences`](https://openemail.uk/docs/mcp/tools/audiences#setContactAudiences). ### Objects #### `Contact` `object` - `object` (`string`, one of `"contact"`) - `email` (`string`): Trimmed and lower cased on write. This is the key every contact route takes, because no contact id is exposed. - `name` (`string`, nullable) - `source` (`string`, one of `"manual"`, `"auto"`, `"form"`): `auto` when a send from the app composer recorded the address, `manual` when somebody saved it here or in the app. A recorded send never downgrades a `manual` contact to `auto`. - `notes` (`string`, nullable) - `photoUrl` (`string`, nullable): Where 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. - `lastSeenAt` (`string`, nullable, format `date-time`): When mail last went to this address from the app composer. Null until it does. - `createdAt` (`string`, format `date-time`) - `updatedAt` (`string`, format `date-time`) #### `ContactActivity` `object` - `object` (`string`, one of `"contact_activity"`) - `email` (`string`) - `since` (`string`, format `date-time`): The start of the first bucket, on the boundary `grain` and `offsetMinutes` put it. - `until` (`string`, format `date-time`) - `grain` (`string`, one of `"minute"`, `"hour"`, `"day"`) - `buckets` (`object[]`): Only the buckets with mail in them, oldest first. - `bucket` (`string`): The bucket in the reader's time: `2026-09-23`, `2026-09-23T14` or `2026-09-23T14:05`. - `received` (`integer`): Messages from this address. - `sent` (`integer`): Messages from the mailbox to this address. - `totals` (`object`) - `received` (`integer`) - `sent` (`integer`) - `threads` (`integer`): Threads with at least one message in the window. - `waiting` (`integer`): Threads whose newest message is from this address, so the mailbox owes the reply. - `lastReceivedAt` (`string`, nullable, format `date-time`) - `lastSentAt` (`string`, nullable, format `date-time`) - `replyTime` (`object`) - `yours` (`number`, nullable): Median milliseconds the mailbox took to answer, or null without a reply to measure. - `theirs` (`number`, nullable): Median milliseconds this address took to answer. #### `ContactBatchDelete` `object` - `object` (`string`, one of `"contact_batch_delete"`) - `deleted` (`integer`): Addresses deleted and hidden, saved or not. - `saved` (`integer`): Of those, how many were saved contacts. - `invalid` (`string[]`): Entries that are not addresses, lower cased. Nothing happened to them. #### `ContactBlock` `object` - `object` (`string`, one of `"contact_block"`) - `email` (`string`): The address as the blocklist sees it: lower cased, with any plus tag dropped. - `blocked` (`boolean`) - `blockedBy` (`object`, nullable): On a block, the rule that now blocks the address. - `rule` (`string`): The entry on the workspace blocklist that matches this address, exactly as it is stored. - `list` (`string`, one of `"blockedSenders"`, `"blockedDomains"`): `blockedSenders` for an address or pattern rule, `blockedDomains` for a rule that blocks a whole domain and every subdomain under it. - `created` (`boolean`): On a block, false when a rule already blocked the address and nothing was added. - `removed` (`object[]`): On an unblock, every rule taken off the workspace blocklist. A `blockedDomains` entry here unblocked the whole domain. - `rule` (`string`): The entry on the workspace blocklist that matches this address, exactly as it is stored. - `list` (`string`, one of `"blockedSenders"`, `"blockedDomains"`): `blockedSenders` for an address or pattern rule, `blockedDomains` for a rule that blocks a whole domain and every subdomain under it. #### `ContactDetail` `object` - `object` (`string`, one of `"contact"`) - `email` (`string`): Trimmed and lower cased on write. This is the key every contact route takes, because no contact id is exposed. - `name` (`string`, nullable) - `source` (`string`, one of `"manual"`, `"auto"`, `"form"`): `auto` when a send from the app composer recorded the address, `manual` when somebody saved it here or in the app. A recorded send never downgrades a `manual` contact to `auto`. - `notes` (`string`, nullable) - `photoUrl` (`string`, nullable): Where 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. - `lastSeenAt` (`string`, nullable, format `date-time`): When mail last went to this address from the app composer. Null until it does. - `createdAt` (`string`, format `date-time`) - `updatedAt` (`string`, format `date-time`) - `audiences` (`object[]`): Every audience this contact is in, the built-in default one included. Single-contact responses carry it; the list route does not. - `id` (`string`): The audience handle, `aud_` plus 24 hex. - `name` (`string`) - `builtin` (`string`, nullable, one of `"default"`): `default` on the one audience every contact joins, null on an audience somebody created. #### `ContactList` `object` - `object` (`string`, one of `"list"`) - `data` (`Contact[]`) - `hasMore` (`boolean`) - `nextCursor` (`string`, nullable) #### `ContactThread` `object` - `object` (`string`, one of `"thread"`) - `id` (`string`): The id `GET /threads/{id}` takes. - `subject` (`string`, nullable) - `from` (`object`, nullable): Who sent the newest message. - `name` (`string`, nullable) - `email` (`string`) - `receivedAt` (`string`, nullable): When the newest message arrived or went out. - `messageCount` (`integer`) - `hasUnread` (`boolean`) - `labels` (`object[]`) - `id` (`string`) - `name` (`string`) #### `ContactThreadList` `object` - `object` (`string`, one of `"list"`) - `data` (`ContactThread[]`) - `hasMore` (`boolean`): True when another page follows. Pass `nextCursor` back as `cursor` to read it. - `nextCursor` (`string`, nullable): Opaque. Pass it back as `cursor` for the next page, and never build one yourself. #### `DeletedContact` `object` - `object` (`string`, one of `"contact"`) - `email` (`string`) - `deleted` (`boolean`, one of `true`) - `wasSaved` (`boolean`): True when a saved contact was removed, false when the address was only seen in mail and has now been hidden. #### `Person` `object` - `object` (`string`, one of `"person"`) - `email` (`string`): Lower cased. The key every contact route takes. - `displayEmail` (`string`): The address as the most recent message wrote it, which may carry capitals. - `name` (`string`, nullable): The saved name, or else the newest display name seen in mail. - `saved` (`boolean`): True when the address is a saved contact. - `source` (`string`, nullable, one of `"manual"`, `"auto"`, `"form"`): As on a contact, or null when the address is only seen in mail. - `notes` (`string`, nullable) - `photoUrl` (`string`, nullable) - `threads` (`integer`, nullable): How 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. - `lastAt` (`string`, nullable, format `date-time`): When the newest of those threads last moved. Null for a saved contact never seen in mail. - `createdAt` (`string`, nullable, format `date-time`) - `updatedAt` (`string`, nullable, format `date-time`) - `blockedBy` (`object`, nullable): The workspace blocklist rule that blocks this address, or null when none does. - `rule` (`string`): The entry on the workspace blocklist that matches this address, exactly as it is stored. - `list` (`string`, one of `"blockedSenders"`, `"blockedDomains"`): `blockedSenders` for an address or pattern rule, `blockedDomains` for a rule that blocks a whole domain and every subdomain under it. #### `PersonList` `object` - `object` (`string`, one of `"list"`) - `data` (`Person[]`) - `hasMore` (`boolean`): True when another page follows. Pass `nextCursor` back as `cursor` to read it. - `nextCursor` (`string`, nullable): Opaque. Pass it back as `cursor` for the next page, and never build one yourself. - `seen` (`boolean`): True when the addresses seen in mail are included, which needs `threads:read`. False means the rows are the saved contacts alone.