Snooze collection item | SchoolSet

Snoozes a contract collection item according to the provided date and note fields.

AuthorizationBearer

You can retrieve your token by visiting your dashboard and clicking Generate API token.

This endpoint expects an object.

contract_idslist of integersRequired

contract IDs list.

snooze_untilstring or nullOptional

Must be a valid date.

notestring or nullOptional

note value.

Successful POST response for /api/v1/collection/snooze.

statusstring

messagestring

dataobject

1	curl -X POST https://app.schoolset.io/app/api/v1/collection/snooze \
2	-H "Authorization: Bearer <token>" \
3	-H "Content-Type: application/json" \
4	-d '{
5	"contract_ids": [
6	1024
7	]
8	}'

1	{
2	"status": "success",
3	"message": "Contracts successfully snoozed until the specified date.",
4	"data": {
5	"contract_id": 1024,
6	"contract_ids": [
7	1024
8	],
9	"count": 1,
10	"removed_records": [
11	4587
12	],
13	"removed_by_user_id": 305,
14	"removed_at": "2024-06-10T14:22:00Z"
15	}
16	}