v1

latestOpenAPI 3.0.12026-07-243686491.1 MB
Operators

Patch an operator

Required scope: operators:write. Only name, email and financeEmail may be updated; VAT number, EAN/CIF and logo are read-only via this endpoint.

patch/api/v1/operators/{id}

Path parameters

idinteger required

Request body

namestring nullable

Updated name of the operator

emailstring email nullable

Primary contact email for the operator

financeEmailstring email nullable

Finance / billing email for the operator

Example request

{
  "name": "Monta",
  "email": "contact@example.com",
  "financeEmail": "finance@example.com"
}

Response

Updated operator

idinteger

ID of the operator

namestring required

Name of operator

identifierstring required

Identifier of operator

partnerIdinteger nullable

Id of the partner

vatNumberstring nullable

VAT number

Example response

{
  "id": 14,
  "name": "Monta",
  "identifier": "monta",
  "partnerId": 1,
  "vatNumber": "FOO-123-ABC"
}