operators

Update operator

Partially updates an operator by its identifier. The code is immutable.

patch/api/v1/operators/{id}

Path parameters

idstring uuid required
Example:01920000-0000-7000-8000-000000000000

Operator identifier (UUID).

Request body

namestring
activeboolean
emailstring email nullable
metadataobject nullable

Response

Operator updated.

idstring required
codestring required
namestring required
activeboolean required
emailstring nullable required
metadataobject nullable required
created_atstring required
updated_atstring required

Changes

Changed in 2 of the 9 revisions of this API.8412

    • added the new optional request property active

      new-optional-request-property

    • added the new optional request property email

      new-optional-request-property

    • added the new optional request property metadata

      new-optional-request-property

    • added the new optional request property name

      new-optional-request-property

    • added the required property active to the response with the 200 status

      response-required-property-added

    • added the required property code to the response with the 200 status

      response-required-property-added

    • added the required property created_at to the response with the 200 status

      response-required-property-added

    • added the required property email to the response with the 200 status

      response-required-property-added

    • added the required property id to the response with the 200 status

      response-required-property-added

    • added the required property metadata to the response with the 200 status

      response-required-property-added

    • added the required property name to the response with the 200 status

      response-required-property-added

    • added the required property updated_at to the response with the 200 status

      response-required-property-added

    This revision also has 2 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

    • removed the required property active from the response with the 200 status

      response-required-property-removed

    • removed the required property code from the response with the 200 status

      response-required-property-removed

    • removed the required property created_at from the response with the 200 status

      response-required-property-removed

    • removed the required property email from the response with the 200 status

      response-required-property-removed

    • removed the required property id from the response with the 200 status

      response-required-property-removed

    • removed the required property metadata from the response with the 200 status

      response-required-property-removed

    • removed the required property name from the response with the 200 status

      response-required-property-removed

    • removed the required property updated_at from the response with the 200 status

      response-required-property-removed

    • removed the request property active

      request-property-removed

    • removed the request property email

      request-property-removed

    • removed the request property metadata

      request-property-removed

    • removed the request property name

      request-property-removed

    This revision also has 36 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog