> ## Documentation Index
> Fetch the complete documentation index at: https://docs.batchrelay.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Accept a versioned agreement



## OpenAPI

````yaml https://api.batchrelay.com/openapi.json post /v1/api-accounts/{account_id}/agreements/{agreement_id}/accept
openapi: 3.1.0
info:
  description: >-
    Provider-neutral print catalog and prepared-media validation. This document
    covers only routes owned by the Go service; it deliberately excludes
    migration-proxied order lifecycle routes and all provider payloads.
  license:
    name: Proprietary
    url: https://github.com/SENTINELITE/Batch-Relay-Go/blob/main/README.md
  title: Batch Relay API
  version: 1.0.1
servers:
  - url: https://api.batchrelay.com
security: []
tags:
  - description: Service health and the public API description.
    name: System
  - description: Test Mode session creation and API credential entry points.
    name: Authentication
  - description: >-
      Provider-neutral canonical catalog resources and platform-owned semantic
      definitions.
    name: Catalog
  - description: Studio-scoped guest checkout-link management.
    name: Checkout links
  - description: >-
      One-way operational event messages. Alert emails contain no message body
      and recipients read messages after Batch Relay authentication.
    name: Studio messages
  - description: >-
      Explicit, reviewable sandbox-to-Live promotion plans for forms, catalog,
      and storefront configuration.
    name: Sandbox promotions
  - description: Provider-neutral validation, quoting, and order lifecycle operations.
    name: Print orders
  - description: Managed fulfillment asset ingestion and metadata.
    name: Managed assets
  - description: Studio-scoped original asset upload sessions and objects.
    name: Studio assets
  - description: Prepared and confirmed event roster team changes.
    name: Event team changes
  - description: Authenticated studio, event, and form-management operations.
    name: Studio management
  - description: >-
      Authenticated studio retail catalog management. Draft and publication
      lifecycles are explicit per product or package.
    name: Studio catalog
  - description: >-
      Authenticated singular storefront assortment management. PATCH atomically
      publishes a new immutable assortment revision; no storefront draft
      lifecycle exists yet.
    name: Storefront
  - description: Managed media used by the studio retail catalog.
    name: Studio catalog assets
  - description: Template rendering job creation and retrieval.
    name: Template renders
  - description: >-
      Published browser-side template packages and short-lived server proof
      renders. Preview artifacts are never fulfillment artwork.
    name: Browser previews
  - description: API account and credential administration.
    name: API accounts
paths:
  /v1/api-accounts/{account_id}/agreements/{agreement_id}/accept:
    parameters:
      - $ref: '#/components/parameters/ClientSurface'
      - $ref: '#/components/parameters/ClientVersion'
      - $ref: '#/components/parameters/InvocationMode'
    post:
      tags:
        - API accounts
      summary: Accept a versioned agreement
      operationId: acceptAPIAccountAgreement
      parameters:
        - $ref: '#/components/parameters/APIAccountID'
        - in: path
          name: agreement_id
          required: true
          schema:
            type: string
        - $ref: '#/components/parameters/IdempotencyKey'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AgreementAcceptance'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIAccount'
          description: API account
        '503':
          description: Lifecycle unavailable
      security:
        - managementSession: []
components:
  parameters:
    ClientSurface:
      description: >-
        Untrusted optional analytics hint naming the calling client surface. It
        never affects authorization, routing, pricing, or behavior.
      in: header
      name: X-BatchRelay-Client-Surface
      required: false
      schema:
        maxLength: 100
        minLength: 1
        type: string
    ClientVersion:
      description: >-
        Untrusted optional analytics hint naming the calling client version. It
        never affects authorization, routing, pricing, or behavior.
      in: header
      name: X-BatchRelay-Client-Version
      required: false
      schema:
        maxLength: 100
        minLength: 1
        type: string
    InvocationMode:
      description: >-
        Untrusted optional analytics hint naming the invocation mode. It never
        affects authorization, routing, pricing, or behavior.
      in: header
      name: X-BatchRelay-Invocation-Mode
      required: false
      schema:
        maxLength: 100
        minLength: 1
        type: string
    APIAccountID:
      in: path
      name: account_id
      required: true
      schema:
        maxLength: 256
        minLength: 1
        type: string
    IdempotencyKey:
      in: header
      name: Idempotency-Key
      required: true
      schema:
        maxLength: 200
        minLength: 1
        type: string
  schemas:
    AgreementAcceptance:
      additionalProperties: false
      properties:
        version:
          minLength: 1
          type: string
      required:
        - version
      type: object
    APIAccount:
      additionalProperties: false
      properties:
        billing:
          $ref: '#/components/schemas/APIAccountBilling'
        created_by_user_id:
          type: string
        id:
          type: string
        owner:
          $ref: '#/components/schemas/APIAccountOwner'
        status:
          enum:
            - active
            - disabled
          type: string
      required:
        - id
        - owner
        - status
        - billing
      type: object
    APIAccountBilling:
      additionalProperties: false
      properties:
        customer_configured:
          type: boolean
        default_payment_method_configured:
          type: boolean
        status:
          enum:
            - not_configured
            - setup_pending
            - active
            - action_required
            - past_due
            - disabled
          type: string
      required:
        - status
        - customer_configured
        - default_payment_method_configured
      type: object
    APIAccountOwner:
      description: >-
        Exactly one reference is present: studio_id for studio accounts or
        individual_owner_user_id for individual accounts.
      properties:
        individual_owner_user_id:
          type: string
        owner_type:
          enum:
            - studio
            - individual
          type: string
        studio_id:
          type: string
      required:
        - owner_type
      type: object
  securitySchemes:
    managementSession:
      bearerFormat: Clerk session token
      description: >-
        Verified Batch Relay dashboard session token. This is distinct from a
        scoped Batch Relay API key.
      scheme: bearer
      type: http

````