Skip to Content
RhythmHelp Center
/

Available Documentation

  • Platform
  • CRM
  • Portals
  • Security & Settings
  • Accreditation
  • Membership
  • Finance & Billing
  • Orders & Inventory
  • Events
  • Certifications
  • Awards
  • Careers
  • Fundraising
  • Integrations
  • Sponsorships
  • Submissions

Coming Later

  • DocumentsComing Soon
Awards
  • Overview

Subjects

  • Concepts
  • Tasks
  • Portal
  • Configure
  • Reference
    • Overview
    • Fees, Coupons, and Settings Through the API
    • Batch-Update References Through the API
    • The Awards Public API
    • Where Recipient Categories Appear
  1. Home
  2. Awards
  3. Reference

Batch-Update References Through the API

reference batch api ‧ batch update references ‧ bulk reference operations

On This Page
  • How a Batch Runs
  • Reading the Result

An integration can include many create, read, update, patch, and delete operations for reference records in one API request, instead of calling the API once for each reference.

How a Batch Runs ​

Each operation in a batch goes through the same checks Rhythm uses when that operation runs by itself. Validation, permissions, and all other rules still apply.

Operations run in parallel, not in the order you list them. Do not send a batch where one operation depends on another finishing first, because Rhythm does not guarantee a sequence.

Reading the Result ​

Rhythm reports the outcome of each operation separately. One operation in a batch can fail while the others succeed, so review each operation’s result instead of treating the batch as one all-or-nothing result.

Tip

Because operations do not run in a guaranteed order and each one is checked on its own, split the work into smaller requests if you need to create a reference and then immediately act on it. Send the create first, confirm it succeeded, and then send the follow-up operation.

Continue in This Subject

PreviousFees, Coupons, and Settings Through the APINext The Awards Public API

Related Articles

  • Add, Edit, and Remove a Reference on an Application

    Add a referee to an application yourself, correct a reference's details or status, mark one declined or reopen it, and remove a reference you no longer need.

  • The Awards Public API

    Where to find the Awards API reference documentation, and how the public Awards API is secured.

On This Page

  • How a Batch Runs
  • Reading the Result
Rhythm Help Center© Rhythm Software

Search article titles, settings, tasks, and troubleshooting topics. Press Enter to see results.

Browse Platform Documentation