Skip to main content
BackedHelp Centre

Let other systems change records through the API - Product News

API credentials can now be given write scopes, so another system can update registrations, applications, assessments, post-award records and files.

Published

ForAdministrators

What's new

  • Write scopes for API credentials. Until now a credential could only read. Under Settings > Profile and terms on the API Access tab, New Credential and each row's Edit scopes now offer Write registrations, Write applications, Write assessments, Write post-award records and Write files alongside Read. Each row lists its scopes. Every existing credential keeps only Read until you change it. See API access.
  • Writes act as an Administrator you choose. A credential with a write scope acts as one enabled Administrator, with their permissions and data access rules, and the row shows who. Choosing that person needs Can edit permissions. See API access.
  • Safe retries. Every write carries an Idempotency-Key, so a request sent twice changes things once, and an update carries If-Match so it can't overwrite a newer change. See API access.
  • Route by route. What each write route takes and refuses is in Write API: registrations, applications, notes, tags and assignments and Write API: milestones, payments, contracts and files.