Workflow Assign Label Actions

List of valid attributes:

Attribute	Description	Specifics
previous_action_id	ID of the previous workflow action in the sequence	Optional.
account_label_ids	Array of account label IDs to attach to the action	Create only. Response attribute on create and update
workflow_assign_label_action_labels		Update only
account_label_id	ID of the account label to add/delete
_delete	Indicator to delete the label	Don’t send this parameter if you don’t want to delete the label. Set it to true if you do.

Create

Example request:

{
  "data": {
    "type": "workflow_assign_label_action",
    "attributes": {
      "previous_action_id": "9ee58efe-7ce5-4143-99d3-954303b188f3",
      "account_label_ids": [
        "2dfdd8d7-418b-40fd-b98a-f8e531a363e0",
        "99a7c77d-fecc-4a2e-9e7c-f1b44e475ac0"
      ]
    }
  }
}

Example response:

{
  "data": {
    "id": "baf9c6a1-4e8b-492e-a972-a03bd0fd52ef",
    "type": "workflow_assign_label_action",
    "attributes": {
      "account_label_ids": [
        "2dfdd8d7-418b-40fd-b98a-f8e531a363e0",
        "99a7c77d-fecc-4a2e-9e7c-f1b44e475ac0"
      ]
    }
  }
}

This endpoint creates a new assign label action for a workflow.

HTTP Request

POST /api/v1/workflows/:workflow_id/assign_label_actions

URL Parameters

Parameter	Description
workflow_id	The ID of the workflow that the action belongs to

Update

Example request:

{
  "data": {
    "type": "workflow_assign_label_action",
    "attributes": {
      "workflow_assign_label_action_labels": [
        { "account_label_id": "2dfdd8d7-418b-40fd-b98a-f8e531a363e0" },
        {
          "account_label_id": "99a7c77d-fecc-4a2e-9e7c-f1b44e475ac0",
          "_delete": true
        }
      ]
    }
  }
}

Example response:

{
  "data": {
    "id": "baf9c6a1-4e8b-492e-a972-a03bd0fd52ef",
    "type": "workflow_assign_label_action",
    "attributes": {
      "account_label_ids": ["2dfdd8d7-418b-40fd-b98a-f8e531a363e0"]
    }
  }
}

This endpoint updates an assign label action.

HTTP Request

PUT /api/v1/workflows/:workflow_id/assign_label_actions/:assign_label_action_id

URL Parameters

Parameter	Description
assign_label_action_id	The ID of the assign label action to update
workflow_id	The ID of the workflow that the action belongs to