Register a partner deal

POST /api/partners/deals/register on the Vigilbase One API.

POST/api/partners/deals/register

Authorizations

Send one of these:

AuthorizationstringAccess tokenheaderrequired

Bearer access token from Vigilbase Identity (auth.vigilbase.com), sent as Authorization: Bearer <token>. The CLI gets one with vigilbase login.

AuthorizationstringAPI keyheaderrequired

Organisation API key (vb_one_…) from Settings → API keys in Vigilbase One, sent as Authorization: Bearer vb_one_…. Needs a key with write access: read-only keys get 403 with the code read_only_key. See organisation API keys.

Permissions checkedadmin:fullwrite:partner_deals

Query Parameters

impersonate_customer_idstring

Body

application/json

The catalog has no JSON Schema for this body. One validates it with the schema below.

Validation schema

PartnerDealRegistrationOperationSchema = DealRegistrationSchema.extend({
  operationId: z.string().uuid(),
})

Response

Success

# Token from `vigilbase login`, or a write API key (vb_one_…)
curl --request POST \
  --url 'https://one.vigilbase.com/api/partners/deals/register' \
  --header "Authorization: Bearer $VIGILBASE_TOKEN" \
  --header 'Content-Type: application/json' \
  --data '{}'

Set VIGILBASE_TOKEN to an Identity access token or an organisation API key first, or use Try it.

Responses

200Success

401Authentication required

403Not permitted

The catalog doesn't include example response bodies for this endpoint.

Was this page helpful?