Skip to main content
POST
/
schedulers
Create an scheduler
curl --request POST \
  --url https://api.syntage.com/schedulers \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "type": "recurring",
  "name": "Daily Invoices Scheduler",
  "isEnabled": true,
  "tags": [
    "/entity-tags/91106968-1abd-4d64-85c1-4e73d96fb997"
  ]
}
'
{
  "@context": "/contexts/Scheduler",
  "@id": "/schedulers/91106968-1abd-4d64-85c1-4e73d96fb997",
  "@type": "Scheduler",
  "id": "e0a24894-7fbf-48ae-bfb0-efaae30a6319",
  "name": "Daily Invoices Scheduler",
  "type": "recurring",
  "isEnabled": true,
  "rules": {
    "@context": "/contexts/SchedulerRule",
    "@id": "/schedulers/rules",
    "@type": "hydra:Collection",
    "hydra:member": [
      {
        "@id": "/schedulers/rules/91106968-1abd-4d64-85c1-4e73d96fb997",
        "@type": "SchedulerRule",
        "id": "e0a24894-7fbf-48ae-bfb0-efaae30a6319",
        "scheduler": "Daily Invoices Scheduler",
        "options": {
          "types": [
            "I",
            "E",
            "P"
          ],
          "period": {
            "from": "2020-01-01T00:00:00.000Z",
            "to": "2020-03-31T23:59:59.000Z"
          }
        },
        "cronExpression": "@daily",
        "nextRunDate": "2020-01-01T12:15:00.000Z",
        "createdAt": "2020-01-01T12:15:00.000Z",
        "updatedAt": "2020-01-01T12:15:00.000Z"
      }
    ],
    "hydra:totalItems": 1,
    "hydra:view": {
      "@id": "/schedulers/rules?page=1",
      "@type": "hydra:PartialCollectionView",
      "hydra:first": "/schedulers/rules?page=1",
      "hydra:next": "/schedulers/rules?page=2",
      "hydra:last": "/schedulers/rules?page=3"
    },
    "hydra:search": {
      "@type": "<string>",
      "hydra:template": "<string>",
      "hydra:variableRepresentation": "<string>",
      "hydra:mapping": [
        {
          "@type": "<string>",
          "variable": "<string>",
          "property": "<string>",
          "required": true
        }
      ]
    }
  },
  "tags": [
    {
      "@id": "/entity-tags/91106968-1abd-4d64-85c1-4e73d96fb997",
      "@type": "EntityTag",
      "id": "e0a24894-7fbf-48ae-bfb0-efaae30a6319",
      "name": "Important Taxpayer",
      "createdAt": "2020-01-01T12:15:00.000Z",
      "updatedAt": "2020-01-01T12:15:00.000Z"
    }
  ],
  "createdAt": "2020-01-01T12:15:00.000Z",
  "updatedAt": "2020-01-01T12:15:00.000Z"
}

Authorizations

​
X-API-Key
string
header
required

Your API key is available in the Production and Sandbox dashboards.

Body

application/json
​
type
enum<string>
required
write-only

The type of scheduler, only the recurring type is allowed for creation

Available options:
recurring
Example:

"recurring"

​
name
string | null
write-only

The scheduler name. Optional; if omitted, the scheduler is created without a name.

Example:

"Daily Invoices Scheduler"

​
isEnabled
boolean
default:true
write-only

To enable or disable the scheduler

Example:

true

​
tags
string
write-only

The tags to be associated with the scheduler

Example:
[
  "/entity-tags/91106968-1abd-4d64-85c1-4e73d96fb997"
]

Response

Scheduler resource response

​
@context
string
default:/contexts/Scheduler
​
@id
string<iri-reference>

Scheduler IRI reference

Example:

"/schedulers/91106968-1abd-4d64-85c1-4e73d96fb997"

​
@type
string
default:Scheduler
​
id
string<uuid>
Example:

"e0a24894-7fbf-48ae-bfb0-efaae30a6319"

​
name
string | null

The scheduler name. May be null for first-time schedulers created automatically by the platform.

Example:

"Daily Invoices Scheduler"

​
type
enum<string>
Available options:
recurring
Example:

"recurring"

​
isEnabled
boolean
​
rules
object
​
tags
object[]
​
createdAt
string

Date and time the resource was created

Example:

"2020-01-01T12:15:00.000Z"

​
updatedAt
string

Date and time the resource was last updated

Example:

"2020-01-01T12:15:00.000Z"