Workflow Yearly Schedule Triggers

Valid Attributes

Attribute	Description	Details
account_id	ID of the account that the yearly schedule trigger belongs to	Cannot be set manually.
day_of_month	Day of the month when the workflow should trigger	Must be set. Integer between 1 and 31.
hour_of_day	Hour at which the workflow should trigger on the scheduled day	Must be set. Integer between 0 and 23. Timezone: UTC
month	The month at which the workflow should trigger	Must be set. Integer between 1 and 12.

Create

Example request:

{
  "data": {
    "type": "workflow_yearly_schedule_trigger",
    "attributes": {
      "day_of_month": 15,
      "hour_of_day": 10,
      "month": 1
    }
  }
}

Example response:

{
  "data": {
    "id": "1324983d-3428-4574-bd06-1507c1caa00f",
    "type": "workflow_yearly_schedule_trigger",
    "attributes": {
      "account_id": "fe578719-5ab8-461c-82cb-e8e483a921d2",
      "day_of_month": 15,
      "hour_of_day": 10,
      "month": 1
    }
  }
}

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

HTTP Request

POST /api/v1/workflows/:workflow_id/yearly_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_yearly_schedule_trigger",
    "attributes": {
      "day_of_month": 15,
      "hour_of_day": 10,
      "month": 12
    }
  }
}

Example response:

{
  "data": {
    "id": "1324983d-3428-4574-bd06-1507c1caa00f",
    "type": "workflow_yearly_schedule_trigger",
    "attributes": {
      "account_id": "fe578719-5ab8-461c-82cb-e8e483a921d2",
      "day_of_month": 15,
      "hour_of_day": 10,
      "month": 12
    }
  }
}

This endpoint updates a yearly 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/yearly_schedule_triggers/:yearly_schedule_trigger_id

URL Parameters

Parameter	Description
yearly_schedule_trigger_id	The ID of the yearly schedule trigger to update
workflow_id	The ID of the workflow that the trigger belongs to