COcoevera
Email

EmailThreadMailboxClientReadStates.create

Creates a EmailThreadMailboxClientReadState record.

post/entities/EmailThreadMailboxClientReadStates

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.

Request body

modifiedstring date-time

Last modification time.

createdstring date-time

Creation time.

client_idstring uuid required

Id of the user whose read state of the email thread is tracked.

last_read_atstring date-time

Time when the user last read the email thread in the mailbox.

mailbox_idstring uuid required

Id of the mailbox (connected email account) the email thread belongs to.

thread_or_idstring uuid required

Id of the email thread, or the id of the email itself when it does not belong to a thread.

Example request

{
  "modified": "2019-01-01T00:00:00",
  "created": "2019-01-01T00:00:00",
  "client_id": "01234567-abcd-dcba-ffff-000000000000",
  "last_read_at": "2019-01-01T00:00:00",
  "mailbox_id": "01234567-abcd-dcba-ffff-000000000000",
  "thread_or_id": "01234567-abcd-dcba-ffff-000000000000"
}

Response

The created EmailThreadMailboxClientReadState record.

successboolean

True when the request succeeded; false on error.

Example response

{
  "success": true,
  "data": {
    "id": "01234567-abcd-dcba-ffff-000000000000",
    "modified": "2019-01-01T00:00:00",
    "created": "2019-01-01T00:00:00",
    "client_id": "01234567-abcd-dcba-ffff-000000000000",
    "last_read_at": "2019-01-01T00:00:00",
    "mailbox_id": "01234567-abcd-dcba-ffff-000000000000",
    "thread_or_id": "01234567-abcd-dcba-ffff-000000000000"
  }
}

Changes

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