Framework

Create Framework Order

Changed on
post/v2/framework/buy

Request

  • Base URL: https://api.carbonarc.co (the document declares no server; this is the origin it was published from)
  • URL: https://api.carbonarc.co/v2/framework/buy
  • Auth: none declared

Query parameters

repurchase_reason'refresh' | 'reinstate' nullable
pollboolean

Opt into the job-polling contract (PRO-3420): if the operation hasn't finished within its short submission wait, respond with a QueryJobResponse envelope instead of blocking until it's done. Callers that don't pass this keep the original always-blocking behavior unchanged.

job_idstring nullable

Finalize a job an earlier poll=true call already submitted, once GET /v2/query-jobs/{job_id} reports it terminal, instead of submitting a new one.

Request body

source'tribes' | 'riastrad' | 'prisms' nullable
configobject nullable

Response

Successful Response

unknown required

Changes

  • 766fe5f73174Revision changes
    • info

      added the new latest enum value to the request property /////

    • info

      added the new max enum value to the request property /////

  • 475c0fdb4aafRevision changes
    • info

      added the new optional query request parameter job_id

    • info

      added the new optional query request parameter poll