Create a record recurrence

Schedule module

POST/record-recurrencesrecordRecurrences.create

A recurrence rule that generates records. Creates a record recurrence. Requires `Idempotency-Key`; a replay returns the original response. The organization is derived from the credential or the parent row, never from the body.

Requires the capability work.recurring.write.
OAuth scopes: work.
Send an Idempotency-Key header. A replay with the same key returns the original response.
Error statuses: 400, 401, 409, 422, 429. Errors are RFC 9457 problem details.

Request body: RecordRecurrenceCreate

recordRecurrences.create: RecordRecurrenceCreate
Field	Type	Required	Description
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	No	Last date of the series.

{
  "record_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "rrule": "FREQ=WEEKLY;BYDAY=SA",
  "time_zone": "America/New_York",
  "until": "2026-10-08"
}

Response 201: RecordRecurrence

recordRecurrences.create: 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 POST "$XOS_BASE_URL/record-recurrences" \
  -H "Authorization: Bearer $XOS_API_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{"record_id":"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f","rrule":"FREQ=WEEKLY;BYDAY=SA","time_zone":"America/New_York","until":"2026-10-08"}'

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

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

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