younifyd
Menu

Create Schedule

Create a schedule

POST/v2/subscriptions/schedules

Use it in a workflow

  1. Add a step and choose the Elastic Path connector.
  2. Pick the Create Schedule action (under Subscriptions).
  3. Fill in the fields below, then reference the result from later steps as {{createSchedule.response.data}}.

Request

Query parameters

filterstring (string)

Some Subscriptions API endpoints support filtering. For the general syntax, see [**Filtering**](/guides/Getting-Started/filtering), but you must go to a specific endpoint to understand the attributes and operators an endpoint supports.

Request body

Enter the body as JSON in the step's Body field.

dataobjectrequired
typestringrequired

One ofsubscription_schedule

attributesobjectrequired5 fields
json
{
  "data": {
    "type": "subscription_schedule",
    "attributes": {
      "specification": "30 0 * * *",
      "location": "Europe/London",
      "job": {
        "job_type": "billing-run"
      },
      "external_ref": "abc123",
      "name": "Daily billing run."
    }
  }
}

Response

Returns 201 with an object. Read it in later steps with {{createSchedule.response.data.<field>}}.

dataobject
idstring (uuid)

The unique identifier.

typestringrequired

One ofsubscription_schedule

attributesanyrequired
metaobjectrequired3 fields
json
{
  "data": {
    "type": "subscription_schedule",
    "attributes": null,
    "meta": {
      "owner": "store",
      "timestamps": {
        "updated_at": "2017-01-10T11:41:19.244842Z",
        "created_at": "2017-01-10T11:41:19.244842Z"
      },
      "scheduled_for": "2017-07-21T17:32:28Z"
    },
    "id": "11111111-2222-3333-4444-555555555555"
  }
}

Need more? See the Elastic Path guide for connection setup and behaviour shared by every action.