COcoevera
Email

EmailLabelRelations.batch_create_or_update

Creates or updates EmailLabelRelation records in one request: an item with an id updates that record, an item without one creates a new record.

post/entities/EmailLabelRelations/batch-modify

Request

Query parameters

validation-levelinteger

Bit mask that relaxes validation on this write. 0 (the default) validates everything. Bits: 2 skip unchanged fields, 4 skip admin-defined validations, 8 allow read-only fields, 16 skip relation checks, 32 skip value checks, 64 skip invalid recalculations, 128 skip step-checklist gates, 256 add conditional field requirements, 512 skip uniqueness checks. Add bits together (20 = 4 + 16); member names and comma lists such as 4,16 work too. A value with an internal-only bit is refused with HTTP 400, code 117.

rollback-method0 | 1

0, the default: one failed item fails the whole batch (HTTP 422, or 404 for an unknown id) and nothing is written. 1: the valid items are written and the call answers 200 with success false and one result per item, an id or an error, in input order. Check every item.

Request body

email_label_idstring uuid

Id of the applied label.

mailbox_idstring uuid

Id of the mailbox (connected email account) the label is applied in. A label applies to a thread per mailbox, so the same thread can be labelled differently in two mailboxes.

owner_idstring uuid

Id of the relation owner.

thread_idstring uuid

Identifier of the conversation thread the label is applied to, matching Email.threadId. Every email in the thread shows the label.

idstring uuid

ID of object to update.

Example request

[
  {
    "email_label_id": "01234567-abcd-dcba-ffff-000000000000",
    "mailbox_id": "01234567-abcd-dcba-ffff-000000000000",
    "owner_id": "01234567-abcd-dcba-ffff-000000000000",
    "thread_id": "01234567-abcd-dcba-ffff-000000000000"
  }
]

Response

Result per item, in request order: the id of the created or updated record, or the error.

successboolean

True when the request succeeded; false on error.

Example response

{
  "success": true,
  "data": [
    {
      "http_status": 400,
      "code": 117,
      "name": "ERROR_PARAMETER_INVALID"
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.