Skip to content

Flows API

Update a flow's status (and, as an extension, its name, archive state, definition and settings)

PATCHhttps://email.growthdept.ai/api/flows/{id}

The request body can be up to 5 MB.

Rate limits

Burst: 3/s

Steady: 60/m

Tier S. See rate limits for how requests are counted.

Scopes

flows:write

Operation id

update_flow The same operation as in Klaviyo's API. OpenAPI document

Path parameters

stringrequired

Query parameters

array of strings

Attributes of flow resources to return.

Sparse fieldsets guide

Pick values to add them to the request:

Body

Send application/vnd.api+json or application/json.

object

  • dataobjectrequired

    data: 5 fields
    • typestringrequired

      flow
    • idstringrequired

    • attributesobjectrequired

      attributes: 5 fields
      • statusstring

        draftmanuallive
      • namestringcan be null

      • archivedbooleancan be null

      • definitionobject

      • settingsobject

    • relationshipsobject

    • metaobject

Edit the example. The code samples use what you type here.

Headers

stringrequireddefault 2026-10-15

API revision, YYYY-MM-DD. This server implements 2026-10-15.

Revisions guide

Responses

200Success

Response body

object

  • dataobjectrequired

    data: 5 fields
    • typestringrequired

      flow
    • idstringrequired

    • attributesobjectrequired

      attributes: 6 fields
      • namestringcan be null

      • statusstringcan be null

      • archivedbooleancan be null

      • createdstring (date-time)can be null

      • updatedstring (date-time)can be null

      • trigger_typestringcan be null

        Added to ListDate BasedLow InventoryMetricPrice DropUnconfigured
    • relationshipsobject

      relationships: 2 fields
      • flow-actionsobject

        flow-actions: 2 fields
        • dataarray of objects

          data: 2 fields
          • typestringrequired

            flow-action
          • idstringrequired

        • linksobject

          links: 2 fields
          • selfstring (uri)required

          • relatedstring (uri)required

      • tagsobject

        tags: 2 fields
        • dataarray of objects

          data: 2 fields
          • typestringrequired

            tag
          • idstringrequired

        • linksobject

          links: 2 fields
          • selfstring (uri)required

          • relatedstring (uri)required

    • linksobjectrequired

      links: 1 field
      • selfstring (uri)required

  • linksobject

    links: 1 field
    • selfstring (uri)required

  • metaobject

4XXClient error

Response body

object

  • errorsarray of objectsrequired

    errors: 8 fields
    • idstringrequired

    • statusintegerrequired

    • codestringrequired

    • titlestringrequired

    • detailstringrequired

    • sourceobject

      source: 2 fields
      • pointerstring

      • parameterstring

    • linksobject

    • metaobject

See status codes for each code.

5XXServer error

Response body

object

  • errorsarray of objectsrequired

    errors: 8 fields
    • idstringrequired

    • statusintegerrequired

    • codestringrequired

    • titlestringrequired

    • detailstringrequired

    • sourceobject

      source: 2 fields
      • pointerstring

      • parameterstring

    • linksobject

    • metaobject