Skip to content
NorthplaneNorthplane

Create time-period

POST
/api/v1/time-periods
curl --request POST \
  --url https://example.com/api/v1/time-periods \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "alias": "example", "createdAt": "2026-04-15T12:00:00Z", "days": { "additionalProperty": [ "example" ] }, "exceptions": { "additionalProperty": [ "example" ] }, "exclude": [ "example" ], "id": "example", "name": "example", "tenantId": "example", "updatedAt": "2026-04-15T12:00:00Z", "version": 1 }'

Authorizations

Section titled “Authorizations”

Request Body

Section titled “Request Body”
Media typeapplication/json
object
alias
string
createdAt
required
string format: date-time
days
object
key
additional properties
Array<string>
exceptions
object
key
additional properties
Array<string>
exclude
Array<string>
id
required
string
name
required
string
tenantId
required
string
updatedAt
required
string format: date-time
version
required
integer
Examplegenerated
{
  "alias": "example",
  "createdAt": "2026-04-15T12:00:00Z",
  "days": {
    "additionalProperty": [
      "example"
    ]
  },
  "exceptions": {
    "additionalProperty": [
      "example"
    ]
  },
  "exclude": [
    "example"
  ],
  "id": "example",
  "name": "example",
  "tenantId": "example",
  "updatedAt": "2026-04-15T12:00:00Z",
  "version": 1
}

Responses

Section titled “Responses”

201

Section titled “201”

Created

Media typeapplication/json
object
alias
string
createdAt
required
string format: date-time
days
object
key
additional properties
Array<string>
exceptions
object
key
additional properties
Array<string>
exclude
Array<string>
id
required
string
name
required
string
tenantId
required
string
updatedAt
required
string format: date-time
version
required
integer
Examplegenerated
{
  "alias": "example",
  "createdAt": "2026-04-15T12:00:00Z",
  "days": {
    "additionalProperty": [
      "example"
    ]
  },
  "exceptions": {
    "additionalProperty": [
      "example"
    ]
  },
  "exclude": [
    "example"
  ],
  "id": "example",
  "name": "example",
  "tenantId": "example",
  "updatedAt": "2026-04-15T12:00:00Z",
  "version": 1
}

default

Section titled “default”

Problem Details (RFC 9457)

Media typeapplication/problem+json
object
code
required
string
detail
string
instance
string
status
required
integer
title
required
string
type
required
string
Examplegenerated
{
  "code": "example",
  "detail": "example",
  "instance": "example",
  "status": 1,
  "title": "example",
  "type": "example"
}