Sign in

v1

latestOpenAPI 3.1.02026-08-061,5107704.5 MB
Client

ClientStoryReads.update

Modifies ClientStoryRead or ClientStoryReads with given id(s)

patch/entities/ClientStoryReads/{id}

Path parameters

idstring uuid required

ID of ClientStoryRead to update

Query parameters

validation-levelinteger

Specify validation level of ClientStoryRead 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

activity_idstring uuid

Id of the read appointment or task, or empty when this read points to a message.

message_idstring uuid

Id of the read email or memo, or empty when this read points to an activity.

no_followboolean

When true, the user explicitly chose not to follow up on this item.

owner_idstring uuid

Id of the reading user.

read_atstring date-time

Timestamp the user marked the item as read.

revisioninteger

Revision when entity was lastly changed.

Example request

{
  "activity_id": "01234567-abcd-dcba-ffff-000000000000",
  "message_id": "01234567-abcd-dcba-ffff-000000000000",
  "owner_id": "01234567-abcd-dcba-ffff-000000000000",
  "read_at": "2019-01-01T00:00:00",
  "revision": 1
}

Response

Modification confirmation. Returns resulting ClientStoryRead

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",
    "activity_id": "01234567-abcd-dcba-ffff-000000000000",
    "message_id": "01234567-abcd-dcba-ffff-000000000000",
    "owner_id": "01234567-abcd-dcba-ffff-000000000000",
    "read_at": "2019-01-01T00:00:00",
    "revision": 1
  }
}