Bases
Change Requests

Create Change Request in Base

post/api/v1/bases/{baseId}/change-requests

Request

  • Base URL: https://api-docs.busabase.com
  • URL: https://api-docs.busabase.com/api/v1/bases/{baseId}/change-requests
  • Auth: none declared

Path parameters

baseIdstring required

Request body

fieldsobject required

Record field values keyed by field slug. The base's PRIMARY field (its first field) becomes the record's display name and the change request title everywhere — always give it a short, human-readable value, never an id or placeholder.

messagestring

Explanation shown to the human reviewer. Write a conventional-commit style subject — imperative verb + what + why, e.g. "Add Acme Corp — qualified lead from the June webinar".

submittedBystring
idempotencyKeystring

Optional client-supplied key that dedupes retries. Scoped per base + submitter: calling this endpoint again with the SAME idempotencyKey (e.g. after a timeout or a 5xx where you couldn't tell if the first call succeeded) returns the change request created by the first call instead of creating a duplicate. Omit for normal one-shot calls; only set it when you might retry.

autoMergeboolean

Response

Merged in the same call when the actor has write access on the Base's node — the materialized record comes back (materialized: true). Review-first when the actor lacks write access or passes autoMerge: false: a pending ChangeRequest proposing the record (materialized: false).

OR

Changes

No recorded changes to this operation across all 1 revision of this API.