REST API Activities and communicationEmailMailboxRelations

EmailMailboxRelations

Read-only: list and get EmailMailboxRelations.

The summaries on this page are generated from the specification; written descriptions come with the next releases of the reference.

Method	Path	Operation
GET	`/entities/EmailMailboxRelations`	List EmailMailboxRelations
GET	`/entities/EmailMailboxRelations/{id}`	Get EmailMailboxRelation

EmailMailboxRelations is read-only: the API offers its read operations only.

GET List EmailMailboxRelations

Returns the EmailMailboxRelations the API application can read, one page at a time. In the list envelope, total counts every match and page_info pages through them.

Query parameters

Name	Type	Description
`include-deleted`	boolean	Include soft-deleted records. Lists only; get-by-id refuses it.
`first`	integer	Page size. Default 30, maximum 100; a larger value is refused with HTTP 400, code 117.
`last`	integer	Return the last N records of the result; together with `first`, the last N of the first M. Maximum 100.
`before`	string	Cursor from `page_info.start_cursor`, to page backwards. URL-encode it.
`after`	string	Cursor from `page_info.end_cursor` of the previous page. URL-encode it: cursors are base64, and a raw + becomes a space.
`expand`	string	Related records to return inline instead of their URIs, comma-separated; dots reach nested relations, as in `account_relations.account`.
`order-by`	string	Fields to sort by, comma-separated. A leading - sorts descending, as in `-modified`; dotted paths sort by related fields.
`filter`	object	`filter[field]=value`. Separate several values with a raw comma (OR), as in `filter[name]=north,south`. Encode a comma that belongs to a value as %2C. URLSearchParams and Python requests encode every comma, so build the filter part of the query string yourself. Dotted paths filter on related records, as in `filter[owner.email]`. Encode a + in a value as %2B: query values are form-decoded, so a raw + becomes a space.
`filter-op`	object	`filter-op[field]=operator`, one per field: eq (the default), ieq, not-eq, not-ieq, contains, icontains, starts, istarts, ends, iends, gt, gte, lt, lte, between, null, not-null, empty and not-empty. null, not-null, empty and not-empty take no filter value; gt, gte, lt and lte take exactly one.
`load-only`	string	Fields to return, comma-separated (raw or encoded commas both work here); dots select nested fields, as in `owner.id`. All fields are returned without it. Lists only: get-by-id refuses it with HTTP 400, code 118.

Responses

200 Page of EmailMailboxRelation records.: success, total, page_info, data 400 Bad request 401 Not authenticated 429 Rate limited 500 Server error

curl 'https://{region}.api.coevera.com/api/v100/rest/spaces/{space_id}/entities/EmailMailboxRelations?first=10' \
  --user "$COEVERA_API_KEY:$COEVERA_API_SECRET"

fetch('https://{region}.api.coevera.com/api/v100/rest/spaces/{space_id}/entities/EmailMailboxRelations?first=10', {
  headers: {
    Authorization: "Basic " + btoa(`${process.env.COEVERA_API_KEY}:${process.env.COEVERA_API_SECRET}`)
  }
})

import os

import requests

response = requests.get(
    "https://{region}.api.coevera.com/api/v100/rest/spaces/{space_id}/entities/EmailMailboxRelations",
    params={
      "first": "10"
    },
    auth=(os.environ["COEVERA_API_KEY"], os.environ["COEVERA_API_SECRET"])
)

GET Get EmailMailboxRelation

Returns one record by id. expand returns related records inline instead of their URIs.

Path parameters

Name	Type	Description
`id`	string (uuid)	Id of the EmailMailboxRelation record to retrieve. Required

Query parameters

Name	Type	Description
`expand`	string	Related records to return inline instead of their URIs, comma-separated; dots reach nested relations. The only parameter this call accepts.

Responses

200 The EmailMailboxRelation record.: success, data 400 Bad request 401 Not authenticated 404 Not found 429 Rate limited 500 Server error

curl 'https://{region}.api.coevera.com/api/v100/rest/spaces/{space_id}/entities/EmailMailboxRelations/ba000000-0000-4000-a000-000000000001' \
  --user "$COEVERA_API_KEY:$COEVERA_API_SECRET"

fetch('https://{region}.api.coevera.com/api/v100/rest/spaces/{space_id}/entities/EmailMailboxRelations/ba000000-0000-4000-a000-000000000001', {
  headers: {
    Authorization: "Basic " + btoa(`${process.env.COEVERA_API_KEY}:${process.env.COEVERA_API_SECRET}`)
  }
})

import os

import requests

response = requests.get(
    "https://{region}.api.coevera.com/api/v100/rest/spaces/{space_id}/entities/EmailMailboxRelations/ba000000-0000-4000-a000-000000000001",
    auth=(os.environ["COEVERA_API_KEY"], os.environ["COEVERA_API_SECRET"])
)

EmailMailboxRelation fields

Field	Type	Notes
`id`	uuid	Read-only Unique identifier of entity.
`is_delete_protected`	boolean	Read-only True when the record is protected against deletion because it must always exist in the space.
`is_deleted`	boolean	Read-only Specifies if the entity is considered deleted.
`modified`	date-time	Read-only Last modification time.
`created`	date-time	Read-only Creation time.
`email`	uri → Emails	Read-only Email that belongs to the mailbox.
`direction`	integer	Read-only Direction of the email relative to this mailbox: outgoing for the mailbox that sent it, incoming for a mailbox that received it.1 OutgoingEmail · 2 IncomingEmail
`email_created`	date-time	Read-only Creation time.
`email_id`	uuid → Emails	Read-only Id of the email that belongs to the mailbox.
`email_is_deleted`	boolean	Read-only True when the related email has been deleted from this mailbox; such links are hidden from the inbox view.
`error_code`	integer	Read-only Error code for the email in this mailbox; 0 means the email was processed without error.
`event_types`	string	Read-only Tracking events recorded so far for the related email (opens, clicks, replies, bounces, unsubscribes); several can be combined.2 · 4 · 8 · 16 · 32 · 64
`is_draft`	boolean	Read-only Copy of the related email's draft flag; true when the email is an unsent draft, which shows it in the mailbox Drafts.
`is_scheduled`	boolean	Read-only Whether the email is scheduled to be sent at a future time and has not been sent yet.
`label_ids`	object	Read-only Ids of the labels applied to this conversation in this mailbox.

Show all 19 fields

Field	Type	Notes
`mailbox_id`	uuid	Read-only Id of the mailbox (connected email account) the email belongs to.
`sent_or_scheduled_at`	date-time	Read-only Time when the email was sent, or its scheduled send time if it has not been sent yet.
`thread_or_id`	uuid	Read-only Id of the email thread, or the id of the email itself when it does not belong to a thread.
`type`	integer	Read-only Copy of the related email's type: an individual email or part of a mass email.1 Standard · 2 Mass

Custom fields appear in your space's live spec: fetch it with your credentials.

Every error body has success: false, http_status, code, name and message. Branch on code: the status alone does not tell a missing permission from a bad parameter. All codes: error codes; how to handle them: Errors.

HTTP	When
400	Bad request: a bad or unknown parameter (codes 117, 118), a missing permission (code 50), conflicting data (code 2002) or any other API error. The REST API answers 400 where others answer 403 or 409; check `code`.
401	Not authenticated: missing or wrong credentials, a credential of another space, or an expired token (code 401, ERROR_UNAUTHORIZED).
404	No such record or entity (code 143 ERROR_NO_ENTITY, or 2006 ERROR_UNKNOWN_TYPE).
429	Too many requests (code 182). Wait for the seconds in Retry-After, then retry.
500	Unexpected server error (code 1000, ERROR_UNKNOWN).