Workflow Weekly Schedule Triggers

Valid Attributes

Attribute	Description	Details
account_id	ID of the account that the weekly schedule trigger belongs to	Cannot be set manually.
day_of_week	Day of the week when the workflow should trigger	Must be set. Valid values: any lowercase weekday name (monday–sunday).
hour_of_day	Hour at which the workflow should trigger on the scheduled day	Must be set. Integer between 0 and 23. Timezone: UTC

Create

Example request:

{
  "data": {
    "type": "workflow_weekly_schedule_trigger",
    "attributes": {
      "day_of_week": "monday",
      "hour_of_day": 10
    }
  }
}

Example response:

{
  "data": {
    "id": "ad21caa3-c798-4be2-8af4-019fec9b21be",
    "type": "workflow_weekly_schedule_trigger",
    "attributes": {
      "account_id": "c2546da1-e5ef-4f31-a205-9539c45805d2",
      "day_of_week": "monday",
      "hour_of_day": 10
    }
  }
}

This endpoint adds a new weekly schedule trigger to a workflow.

HTTP Request

POST /api/v1/workflows/:workflow_id/weekly_schedule_triggers

URL Parameters

Parameter	Description
workflow_id	The ID of the workflow that the trigger will be added to

Update

Example request:

{
  "data": {
    "type": "workflow_weekly_schedule_trigger",
    "attributes": {
      "day_of_week": "friday",
      "hour_of_day": 10
    }
  }
}

Example response:

{
  "data": {
    "id": "ad21caa3-c798-4be2-8af4-019fec9b21be",
    "type": "workflow_weekly_schedule_trigger",
    "attributes": {
      "account_id": "c2546da1-e5ef-4f31-a205-9539c45805d2",
      "day_of_week": "friday",
      "hour_of_day": 10
    }
  }
}

This endpoint updates a weekly schedule trigger of a workflow. The trigger can only be modified when the workflow does not have any connected actions.

HTTP Request

PUT /api/v1/workflows/:workflow_id/weekly_schedule_triggers/:weekly_schedule_trigger_id

URL Parameters

Parameter	Description
weekly_schedule_trigger_id	The ID of the weekly schedule trigger to update
workflow_id	The ID of the workflow that the trigger belongs to