Automation Rules

Update an automation rule. Supplying conditions replaces the whole condition tree; omitting it leaves the tree untouched. Rules are not versioned, so an edit takes effect on the next scheduled run.

patch/api/automation-rules/{id}

Path parameters

idstring required

Request body

namestring
descriptionstring nullable
workflowIdstring
workflowTemplateKeystring
stepConfigsobject
triggerCronstring
timezonestring
status'draft' | 'active' | 'paused' | 'archived'
conditionsSchema0Input — unresolved $ref

Response

Default Response

Changes

Changed in 3 of the 49 revisions of this API.11111

    • ▲

      the response property / became nullable for the status

      response-property-became-nullable

    • ▲

      the response property / became nullable for the status

      response-property-became-nullable

  • 97e51f27dc779110See the full diff
    • ▲

      added to the request property allOf list

      request-property-all-of-added

    • ▲

      request property list-of-types was narrowed by removing types null from media type application/json

      request-property-list-of-types-narrowed

    • ▲

      the response property / became nullable for the status

      response-property-became-nullable

    • ▲

      the response property / became nullable for the status

      response-property-became-nullable

    • ▲

      the response property / became nullable for the status

      response-property-became-nullable

    • ▲

      the response property / became nullable for the status

      response-property-became-nullable

    • ▲

      the response property / became nullable for the status

      response-property-became-nullable

    • ▲

      the response property / became nullable for the status

      response-property-became-nullable

    • ▲

      the response property / became nullable for the status

      response-property-became-nullable

    • ●

      the request property's maxLength was set to 2000

      request-property-max-length-set

    • ○

      the request property became nullable

      request-property-became-nullable

    • ○

      removed 'propertyNames' constraint from the request property /

      request-property-property-names-removed

    • ○

      added to the / response property allOf list for the response status

      response-property-all-of-added

    • ○

      removed subschema #2 from the / response property anyOf list for the response status

      response-property-any-of-removed

    • ○

      response property data/createdAt list-of-types was narrowed by removing types null from media type application/json of response 200

      response-property-list-of-types-narrowed

    • ○

      response property data/description list-of-types was narrowed by removing types null from media type application/json of response 200

      response-property-list-of-types-narrowed

    • ○

      response property data/lastRunAt list-of-types was narrowed by removing types null from media type application/json of response 200

      response-property-list-of-types-narrowed

    • ○

      response property data/nextRunAt list-of-types was narrowed by removing types null from media type application/json of response 200

      response-property-list-of-types-narrowed

    • ○

      response property data/rootGroupId list-of-types was narrowed by removing types null from media type application/json of response 200

      response-property-list-of-types-narrowed

    • ○

      response property data/updatedAt list-of-types was narrowed by removing types null from media type application/json of response 200

      response-property-list-of-types-narrowed

    • ○

      endpoint added

      endpoint-added

Of the 49 revisions, 1 has no diff computed.