COcoevera
Client

ClientStoryReads.update

Changes fields of the ClientStoryRead record with the given id; fields left out keep their values.

patch/entities/ClientStoryReads/{id}

Request

Path parameters

idstring uuid required

Id of the ClientStoryRead record to update.

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

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

The changed ClientStoryRead 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",
    "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
  }
}

Changes

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