v1

latestOpenAPI 3.1.02026-08-061,5107704.5 MB

EmailThreadMailboxClientReadStates.update

Modifies EmailThreadMailboxClientReadState or EmailThreadMailboxClientReadStates with given id(s)

patch/entities/EmailThreadMailboxClientReadStates/{id}

Path parameters

idstring uuid required

ID of EmailThreadMailboxClientReadState to update

Query parameters

validation-levelinteger

Specify validation level of EmailThreadMailboxClientReadState on update. Use them as bit mask: 0 - validate each field on entity, 2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields, 16 - allows to set entity on deleted relationship.

Request body

client_idstring uuid

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

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

thread_or_idstring uuid

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

Example request

{
  "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

Modification confirmation. Returns resulting EmailThreadMailboxClientReadState

successboolean

True when response 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"
  }
}