Admin APIs
distributors
Wholesale Distribution

Update Contract

Rename a contract (PRO-2305). Terms, TOU, and tiers have their own dedicated edit endpoints; only the operator-facing name is set here.

patch/api/v1/admin/distributors/contracts/{contract_id}

Request

  • Base URL: https://carbonarc.ai (the document declares no server; this is the origin it was published from)
  • URL: https://carbonarc.ai/api/v1/admin/distributors/contracts/{contract_id}
  • Auth: OAuth 2 (authorization code, authorization URL authorize, token URL token)

Path parameters

contract_idstring uuid required

Request body

namestring nullable
signup_plan_idstring nullable

Response

Successful Response

idstring uuid4 required
namestring nullable
statusstring required
contract_starts_atstring date nullable
contract_term_monthsinteger required
term_endstring date nullable
account_managerstring nullable
signup_plan_idstring nullable
created_atstring date-time required
updated_atstring date-time required
active_accountsinteger required
total_accountsinteger nullable

Changes

No recorded changes to this operation across all 4 revisions of this API.