Skip to content
XOS Developers

Delete a record recurrence

Schedule module

DELETE/record-recurrences/{id}recordRecurrences.delete

A recurrence rule that generates records. Soft-deletes the record recurrence: it moves to Trash and can be restored for its table's retention period.

  • Requires the capability work.recurring.write.
  • OAuth scopes: work.
  • Error statuses: 401, 404, 422, 429. Errors are RFC 9457 problem details.

Path and query parameters

recordRecurrences.delete: Path and query parameters
FieldTypeRequiredDescription
idstring (uuid)YesIdentifier of the record recurrence.

Response 204: no body.

Code samples

curl -X DELETE "$XOS_BASE_URL/record-recurrences/0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f" \
  -H "Authorization: Bearer $XOS_API_KEY"
const { data } = await xos.recordRecurrences.delete("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f");
response = xos.record_recurrences.delete("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f")
xos record-recurrences delete 0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f