Sign in
state-machines

Set state machine as default

Promotes the state machine to the default for its entity type within the account, demoting the previous default atomically. Idempotent: promoting the current default is a successful no-op.

patch/api/v1/state-machines/{id}/default

Path parameters

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

State machine identifier (UUID).

Response

State machine set as default.

idstring required
entity_type'ORDER' | 'FULFILLMENT_ORDER' required
codestring required
namestring required
activeboolean required
is_defaultboolean required
versionnumber required
created_atstring required
updated_atstring required

Changes

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

  • a3b4750a505f10See the full diff
    • ○

      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 entity_type 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 is_default 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 transitions 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

    • ○

      added the required property version 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

  • 84194c31ab851See the full diff
    • ○

      endpoint added

      endpoint-added

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