Sign in
flows

putFlow

Update automation flow by id

put/v1/automation/flows/{flow_id}

Path parameters

flow_idstring required

ID of the Automation Flow

Example:7791b04a-16d2-44a2-9af9-2d59c25c512f

Automation Workflow ID

Request body

idstring

ID of the Automation Flow

flow_namestring required

A descriptive name for the Automation

enabledboolean

Whether the automation is enabled or not

entity_schemastring

The triggering entity schema

runsnumber

Number of automation executions that ran

created_atstring date-time
updated_atstring date-time
created_bystring

User / service who created automation flow

last_updated_bystring

User / service who last updated automation flow

org_idstring

Organization the automation flow belongs to

system_flowboolean

Determines if the flow is a system generated flow

versionnumber

Version of the flow

_manifeststring[] nullable

Source blueprint/manifest ID used when automation is created via blueprints.

protectedboolean

If true, automation is displayed in read-only mode in the UI to discourage changes

Response

The updated automation flow

idstring

ID of the Automation Flow

flow_namestring required

A descriptive name for the Automation

enabledboolean

Whether the automation is enabled or not

entity_schemastring

The triggering entity schema

runsnumber

Number of automation executions that ran

created_atstring date-time
updated_atstring date-time
created_bystring

User / service who created automation flow

last_updated_bystring

User / service who last updated automation flow

org_idstring

Organization the automation flow belongs to

system_flowboolean

Determines if the flow is a system generated flow

versionnumber

Version of the flow

_manifeststring[] nullable

Source blueprint/manifest ID used when automation is created via blueprints.

protectedboolean

If true, automation is displayed in read-only mode in the UI to discourage changes

Changes

Changed in 3 of the 6 revisions of this API.1018

  • aca0a6a2f48f1014See the full diff
    • ●

      added the new relationsAdded enum value to the triggers/items/anyOf[EntityOperationTrigger]/allOf[subschema #2]/configuration/filter_config/operation/operation/items/ response property for the response status 200

      response-property-enum-value-added

    • ●

      added the new relationsAdded enum value to the triggers/items/anyOf[EntityOperationTrigger]/allOf[subschema #2]/configuration/operations/items/ response property for the response status 200

      response-property-enum-value-added

    • ●

      added the new relationsDeleted enum value to the triggers/items/anyOf[EntityOperationTrigger]/allOf[subschema #2]/configuration/filter_config/operation/operation/items/ response property for the response status 200

      response-property-enum-value-added

    • ●

      added the new relationsDeleted enum value to the triggers/items/anyOf[EntityOperationTrigger]/allOf[subschema #2]/configuration/operations/items/ response property for the response status 200

      response-property-enum-value-added

    • ●

      added the new relationsRemoved enum value to the triggers/items/anyOf[EntityOperationTrigger]/allOf[subschema #2]/configuration/filter_config/operation/operation/items/ response property for the response status 200

      response-property-enum-value-added

    • ●

      added the new relationsRemoved enum value to the triggers/items/anyOf[EntityOperationTrigger]/allOf[subschema #2]/configuration/operations/items/ response property for the response status 200

      response-property-enum-value-added

    • ●

      added the new relationsRestored enum value to the triggers/items/anyOf[EntityOperationTrigger]/allOf[subschema #2]/configuration/filter_config/operation/operation/items/ response property for the response status 200

      response-property-enum-value-added

    • ●

      added the new relationsRestored enum value to the triggers/items/anyOf[EntityOperationTrigger]/allOf[subschema #2]/configuration/operations/items/ response property for the response status 200

      response-property-enum-value-added

    • ●

      added the new relationsSoftDeleted enum value to the triggers/items/anyOf[EntityOperationTrigger]/allOf[subschema #2]/configuration/filter_config/operation/operation/items/ response property for the response status 200

      response-property-enum-value-added

    • ●

      added the new relationsSoftDeleted enum value to the triggers/items/anyOf[EntityOperationTrigger]/allOf[subschema #2]/configuration/operations/items/ response property for the response status 200

      response-property-enum-value-added

    • ○

      added the new optional request property actions/items/anyOf[SendEmailAction]/allOf[subschema #2]/config/journey_id

      new-optional-request-property

    • ○

      added the new optional request property actions/items/anyOf[SendEmailAction]/allOf[subschema #2]/config/wait_for_journey_submission

      new-optional-request-property

    • ○

      added the new relationsAdded enum value to the request property triggers/items/anyOf[EntityOperationTrigger]/allOf[subschema #2]/configuration/filter_config/operation/operation/items/

      request-property-enum-value-added

    • ○

      added the new relationsAdded enum value to the request property triggers/items/anyOf[EntityOperationTrigger]/allOf[subschema #2]/configuration/operations/items/

      request-property-enum-value-added

    • ○

      added the new relationsDeleted enum value to the request property triggers/items/anyOf[EntityOperationTrigger]/allOf[subschema #2]/configuration/filter_config/operation/operation/items/

      request-property-enum-value-added

    • ○

      added the new relationsDeleted enum value to the request property triggers/items/anyOf[EntityOperationTrigger]/allOf[subschema #2]/configuration/operations/items/

      request-property-enum-value-added

    • ○

      added the new relationsRemoved enum value to the request property triggers/items/anyOf[EntityOperationTrigger]/allOf[subschema #2]/configuration/filter_config/operation/operation/items/

      request-property-enum-value-added

    • ○

      added the new relationsRemoved enum value to the request property triggers/items/anyOf[EntityOperationTrigger]/allOf[subschema #2]/configuration/operations/items/

      request-property-enum-value-added

    • ○

      added the new relationsRestored enum value to the request property triggers/items/anyOf[EntityOperationTrigger]/allOf[subschema #2]/configuration/filter_config/operation/operation/items/

      request-property-enum-value-added

    • ○

      added the new relationsRestored enum value to the request property triggers/items/anyOf[EntityOperationTrigger]/allOf[subschema #2]/configuration/operations/items/

      request-property-enum-value-added

    • ○

      added the new relationsSoftDeleted enum value to the request property triggers/items/anyOf[EntityOperationTrigger]/allOf[subschema #2]/configuration/filter_config/operation/operation/items/

      request-property-enum-value-added

    • ○

      added the new relationsSoftDeleted enum value to the request property triggers/items/anyOf[EntityOperationTrigger]/allOf[subschema #2]/configuration/operations/items/

      request-property-enum-value-added

    • ○

      added the optional property actions/items/anyOf[SendEmailAction]/allOf[subschema #2]/config/journey_id to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property actions/items/anyOf[SendEmailAction]/allOf[subschema #2]/config/wait_for_journey_submission to the response with the 200 status

      response-optional-property-added

  • 4631cafda8302See the full diff
    • ○

      added AssignEntityAction to the actions/items/ request property anyOf list

      request-property-any-of-added

    • ○

      added AssignEntityAction to the actions/items/ response property anyOf list for the response status 200

      response-property-any-of-added

  • e137591d90852See the full diff
    • ○

      added the new optional request property actions/items/anyOf[MapEntityAction]/allOf[subschema #2]/config/use_uniqueness_criteria

      new-optional-request-property

    • ○

      added the optional property actions/items/anyOf[MapEntityAction]/allOf[subschema #2]/config/use_uniqueness_criteria to the response with the 200 status

      response-optional-property-added