Admin APIs
distributors
Wholesale Distribution

Grant Distributor Access

Grant distributor access to an existing user of this client (PRO-2681), as either a Distributor Admin or a Distributor User. Access applies across every contract the distributor holds. Re-granting a user who already holds a distributor role changes their role.

post/api/v1/admin/distributors/{client_id}/access

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/{client_id}/access
  • Auth: OAuth 2 (authorization code, authorization URL authorize, token URL token)

Path parameters

client_idstring uuid required

Request body

user_idstring uuid4 required
distributor_role'Distributor Admin' | 'Distributor User'

Additive distributor role stored directly on users.distributor_role (distributor_role_enum Postgres enum), the same pattern as block_role. DISTRIBUTOR_ADMIN grants access to the platform's distributor features, scoped by the user's client's distributor contract(s); DISTRIBUTOR_USER marks a non-administrative distributor user and grants no distributor-view access on its own.

prompt_accessboolean nullable

Response

Successful Response

idstring uuid4 required
first_namestring required
last_namestring required
emailstring required
rolestring required
statusstring

Changes

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