Read marks
5 routes. Paths are relative to https://api.intersink.com/v1.
- GET/read-marks/{list}When I read each of these records (null = unread)
- GET/read-marks/{list}/countsHow many records of the list I have and have not read
- POST/read-marks/{list}/readMark records read (opening a record does this)
- POST/read-marks/{list}/read-allMark every record of the list read
- POST/read-marks/{list}/unreadMark records unread again
When I read each of these records (null = unread)
GET/read-marks/{list}
Needs a signed-in user (Bearer token or access_token cookie).
Pass the ids of the rows on screen. Ids that are not records of this list in the channel are left out.
Parameters
| Name | Type | Description |
|---|---|---|
| listrequired | string, path | crm.contacts (leads), crm.deals, orders One of: "crm.contacts", "crm.deals", "orders". |
| channel_id | string (uuid), query | The channel; the session's channel when left out |
| idsrequired | string, query | Record ids, comma separated (at most 200) Example: "id1,id2" |
Response
200. data is object (ReadMarksStateDto).
| Field | Type | Description |
|---|---|---|
| listrequired | string | Example: "crm.contacts" |
| channel_idrequired | string (uuid) | |
| readrequired | object | Each asked id → when this person read it, or null (unread). Ids not in the channel are left out. |
How many records of the list I have and have not read
GET/read-marks/{list}/counts
Needs a signed-in user (Bearer token or access_token cookie).
Parameters
| Name | Type | Description |
|---|---|---|
| listrequired | string, path | crm.contacts (leads), crm.deals, orders One of: "crm.contacts", "crm.deals", "orders". |
| channel_id | string (uuid), query | The channel; the session's channel when left out |
Response
200. data is object (ReadMarksCountsDto).
| Field | Type | Description |
|---|---|---|
| listrequired | string | Example: "crm.contacts" |
| channel_idrequired | string (uuid) | |
| totalrequired | number | Records in the list Example: 40 |
| readrequired | number | Read by this person Example: 15 |
| unreadrequired | number | Not read by this person Example: 25 |
Mark records read (opening a record does this)
POST/read-marks/{list}/read
Needs a signed-in user (Bearer token or access_token cookie).
Parameters
| Name | Type | Description |
|---|---|---|
| listrequired | string, path | crm.contacts (leads), crm.deals, orders One of: "crm.contacts", "crm.deals", "orders". |
Request body application/json
| Field | Type | Description |
|---|---|---|
| channel_id | string (uuid) | The channel; the session's channel when left out |
| idsrequired | string[] | At most 200 items. |
Response
200. data is object (ReadMarksChangeDto).
| Field | Type | Description |
|---|---|---|
| listrequired | string | Example: "crm.contacts" |
| channel_idrequired | string (uuid) | |
| changedrequired | number | Marks added (read) or removed (unread); ones already right are not counted Example: 3 |
| unreadrequired | number | Unread records left in the list for this person Example: 25 |
| more | boolean | read-all only: more records remain past the per-call cap; call again Example: false |
Mark every record of the list read
POST/read-marks/{list}/read-all
Needs a signed-in user (Bearer token or access_token cookie).
Up to 5000 records per call; more: true means call again.
Parameters
| Name | Type | Description |
|---|---|---|
| listrequired | string, path | crm.contacts (leads), crm.deals, orders One of: "crm.contacts", "crm.deals", "orders". |
Request body application/json
| Field | Type | Description |
|---|---|---|
| channel_id | string (uuid) | The channel; the session's channel when left out |
Response
200. data is object (ReadMarksChangeDto).
| Field | Type | Description |
|---|---|---|
| listrequired | string | Example: "crm.contacts" |
| channel_idrequired | string (uuid) | |
| changedrequired | number | Marks added (read) or removed (unread); ones already right are not counted Example: 3 |
| unreadrequired | number | Unread records left in the list for this person Example: 25 |
| more | boolean | read-all only: more records remain past the per-call cap; call again Example: false |
Mark records unread again
POST/read-marks/{list}/unread
Needs a signed-in user (Bearer token or access_token cookie).
Parameters
| Name | Type | Description |
|---|---|---|
| listrequired | string, path | crm.contacts (leads), crm.deals, orders One of: "crm.contacts", "crm.deals", "orders". |
Request body application/json
| Field | Type | Description |
|---|---|---|
| channel_id | string (uuid) | The channel; the session's channel when left out |
| idsrequired | string[] | At most 200 items. |
Response
200. data is object (ReadMarksChangeDto).
| Field | Type | Description |
|---|---|---|
| listrequired | string | Example: "crm.contacts" |
| channel_idrequired | string (uuid) | |
| changedrequired | number | Marks added (read) or removed (unread); ones already right are not counted Example: 3 |
| unreadrequired | number | Unread records left in the list for this person Example: 25 |
| more | boolean | read-all only: more records remain past the per-call cap; call again Example: false |