An accreditation record supports a few API operations that are not available in the Console or Portal. Through the API, you can patch part of a record, delete a record, or send many patches or deletes in one batch request. This reference also applies to accreditation status reason, application, and application process records because they support the same operations.
Tip
Membership and accreditation are separate record types. Changing a membership through the API, including through a billing action, does not automatically update an accreditation’s status or dates. If your integration needs both records to reflect the same change, update the accreditation record as well.
Changing Part of a Record with a Patch
You can send a list of patch instructions when you only need to change specific fields. Rhythm applies those instructions to the existing record, then validates and saves the result the same way it handles a full update. If a full update can change a field, a patch can change that field too.
Warning
You cannot patch these record types from the Portal. Use a staff-side or integration credential instead.
Deleting an Accreditation
You can delete an accreditation record through the API. No Console or Portal screen offers this action, so an API delete is currently the only way to remove an accreditation.
Before Rhythm deletes the record, it checks whether anything else still depends on it, such as a visit, report, or evaluation that names the accreditation. If a dependent record exists, Rhythm refuses the delete. A visit can block deletion when it is tied to a billing run, so if you cannot explain a delete refusal, check whether a related visit is linked to a billing run. Resolve that relationship before you try the delete again. After the delete succeeds, Rhythm also removes the accreditation’s notice history, owed reports, and custom field values, and it records the removal like any other change.
Warning
A deleted accreditation is no longer selected by later billing runs for notices or phase advancement. Delete a record only when you are sure the school’s accreditation under that program should end.
Tip
A deleted record can still appear in query results for a little while after the delete succeeds. If you open it from that stale result, Rhythm can return an error. Rerun the query, or wait a moment for the change to propagate, before you assume the delete failed.
Changing or Deleting Many Records in One Batch
You can send up to 100 patch or delete operations for accreditations, status reasons, applications, or application processes in one batch request. Rhythm runs each operation and reports each result separately, so one failed operation does not stop the rest of the batch.
Tip
If you need to update the standing of many accreditations at once, such as moving a batch of schools to a new status after a program change, a batch request lets you send all the patches together instead of sending one request per school.
A failed operation inside an otherwise successful batch can mean the target record is no longer valid to update. For example, the record may have been deleted before the batch ran. Check whether each failed identifier still names an existing record before you retry it.
Tip
The same full-record validation applies when you bulk update accreditation report records through a query and Bulk Changes, even though that update goes through a query rather than this batch request. If any targeted report still has a legacy status value that the current status list no longer allows, or is missing a required field such as its contact, the update fails for that record. This happens even when you are only trying to change a different, unrelated field. Bring every required field up to date together, or exclude those records from the batch, rather than trying to fix one field at a time.
Related
- Accreditation Console and API Addresses
- Applications to Be Accredited Through the API
- Edit a School's Accreditation
- How Bulk Changes Work