Skip to main content
POST
https://api.usenotra.com
/
v1
/
schedules
Create a schedule
curl --request POST \
  --url https://api.usenotra.com/v1/schedules \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "sourceType": "cron",
  "sourceConfig": {
    "cron": {
      "frequency": "daily",
      "hour": 11,
      "minute": 29,
      "dayOfWeek": 3,
      "dayOfMonth": 16
    }
  },
  "targets": {
    "repositoryIds": [
      "<string>"
    ]
  },
  "outputType": "changelog",
  "enabled": true,
  "outputConfig": {
    "publishDestination": "webflow",
    "brandVoiceId": "<string>"
  },
  "autoPublish": false,
  "lookbackWindow": "last_7_days"
}
'
{
  "schedule": {
    "id": "<string>",
    "organizationId": "<string>",
    "name": "<string>",
    "sourceType": "cron",
    "sourceConfig": {
      "cron": {
        "frequency": "daily",
        "hour": 11,
        "minute": 29,
        "dayOfWeek": 3,
        "dayOfMonth": 16
      }
    },
    "targets": {
      "repositoryIds": [
        "<string>"
      ]
    },
    "outputType": "changelog",
    "enabled": true,
    "autoPublish": true,
    "createdAt": "<string>",
    "updatedAt": "<string>",
    "lookbackWindow": "current_day",
    "outputConfig": {
      "publishDestination": "webflow",
      "brandVoiceId": "<string>"
    }
  },
  "organization": {
    "id": "<string>",
    "slug": "<string>",
    "name": "<string>",
    "logo": "<string>"
  }
}

Authorizations

Authorization
string
header
required

Send your API key in the Authorization header as Bearer API_KEY.

Body

application/json
name
string
required
Required string length: 1 - 120
sourceType
enum<string>
required
Available options:
cron
sourceConfig
object
required
targets
object
required
outputType
enum<string>
required
Available options:
changelog,
blog_post,
linkedin_post,
twitter_post
enabled
boolean
required
outputConfig
object
autoPublish
boolean
default:false
lookbackWindow
enum<string>
default:last_7_days
Available options:
current_day,
yesterday,
last_7_days,
last_14_days,
last_30_days

Response

Schedule created successfully

schedule
object
required
organization
object
required