Update a record recurrence

Schedule module

PATCH/record-recurrences/{id}recordRecurrences.update

A recurrence rule that generates records. Updates the fields sent; omitted fields are unchanged. Requires `If-Match` with the current `ETag`: a stale tag returns 412 and a missing tag returns 428.

Requires the capability work.recurring.write.
OAuth scopes: work.
Send If-Match with the ETag you read. A stale tag returns 412; a missing tag returns 428.
Error statuses: 400, 401, 404, 412, 422, 428, 429. Errors are RFC 9457 problem details.

Path and query parameters

recordRecurrences.update: Path and query parameters
Field	Type	Required	Description
id	string (uuid)	Yes	Identifier of the record recurrence.

Request body: RecordRecurrenceUpdate

recordRecurrences.update: RecordRecurrenceUpdate
Field	Type	Required	Description
rrule	string	No	RFC 5545 recurrence rule.Constraints: length 1 to 300
time_zone	string	No	IANA time zone the local time was entered in.Constraints: pattern ^[A-Za-z_]+(\/[A-Za-z0-9_+-]+)*$
until	string (date) \| null	No	Last date of the series.

{
  "rrule": "FREQ=WEEKLY;BYDAY=SA",
  "time_zone": "America/New_York",
  "until": "2026-10-08"
}

Response 200: RecordRecurrence

recordRecurrences.update: RecordRecurrence
Field	Type	Required	Description
id	string (uuid)	Yes	Identifier of the record recurrence.
org_id	string (uuid)	Yes	Identifier of the owning organization, derived from the parent row and never accepted from the caller.
created_at	string (date-time)	Yes	When the row was created.
created_by	string (uuid) \| null	Yes	Identifier of the person who created the row; null when a seed, platform or system process created it.
updated_at	string (date-time)	Yes	When the row was last updated.
updated_by	string (uuid) \| null	Yes	Identifier of the person who last updated the row; null when a seed, platform or system process updated it.
record_id	string (uuid)	Yes	Identifier of the template record.
rrule	string	Yes	RFC 5545 recurrence rule.Constraints: length 1 to 300
time_zone	string	Yes	IANA time zone the local time was entered in.Constraints: pattern ^[A-Za-z_]+(\/[A-Za-z0-9_+-]+)*$
until	string (date) \| null	Yes	Last date of the series.

{
  "id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "org_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "created_at": "2026-10-08T14:30:00Z",
  "created_by": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "updated_at": "2026-10-08T14:30:00Z",
  "updated_by": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "record_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "rrule": "FREQ=WEEKLY;BYDAY=SA",
  "time_zone": "America/New_York",
  "until": "2026-10-08"
}

Code samples

curl -X PATCH "$XOS_BASE_URL/record-recurrences/0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f" \
  -H "Authorization: Bearer $XOS_API_KEY" \
  -H 'If-Match: W/"etag-from-your-last-read"' \
  -H "Content-Type: application/json" \
  -d '{"rrule":"FREQ=WEEKLY;BYDAY=SA","time_zone":"America/New_York","until":"2026-10-08"}'

const { data, etag } = await xos.recordRecurrences.update("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f", {
    "rrule": "FREQ=WEEKLY;BYDAY=SA",
    "time_zone": "America/New_York",
    "until": "2026-10-08"
  }, { ifMatch: etag });

response = xos.record_recurrences.update("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f", {"rrule": "FREQ=WEEKLY;BYDAY=SA", "time_zone": "America/New_York", "until": "2026-10-08"}, if_match=etag)

xos record-recurrences update 0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f --data '{"rrule":"FREQ=WEEKLY;BYDAY=SA","time_zone":"America/New_York","until":"2026-10-08"}' --if-match auto