API

Create a rule set

Creates a rule set for a company.

POST/v1/hq/rule_sets
AuthorizationBearer <token>

The Noona HQ API uses Bearer token for authentication.

Endpoints that return generic information that does not contain sensitive data do not require authentication. Endpoints that require authentication are specifically marked in the documentation.

Authorization: Bearer your-token

In: header

Query Parameters

select?array<string>
expand?array<string>

Request Body

application/json

date*string

The date of the rule set.

For recurring rule sets, this is the date where the recurrance rule starts.

Example"2020-08-24"
rrule?string

RRULE string.

The dtstart property is ignored, and the date attribute of the rule set is used to define the beginnin of the reccurence.

rule_set_template_id?string

The template that was used to create this rule set

Example"7awdXwZoedakjad37a"
company*string|never
title?string
starts_at*string

Start time

Example"11:00"
ends_at*string

End time

Example"13:00"
priority?integer

Lower numbers have higher priority.

This can be used to explicitly overwrite certain rules on dates where multiple rules apply.

Formatint32
Example1
rules?

Response Body

application/json

curl -X POST "https://api.noona.is/v1/hq/rule_sets" \  -H "Content-Type: application/json" \  -d '{    "company": "string",    "date": "2020-08-24",    "starts_at": "11:00",    "ends_at": "13:00"  }'
{
  "date": "2020-08-24",
  "rrule": "string",
  "rule_set_template_id": "7awdXwZoedakjad37a",
  "id": "7awdXwZoedakjad37a",
  "company": "string",
  "title": "string",
  "starts_at": "11:00",
  "ends_at": "13:00",
  "priority": 1,
  "rules": [
    {
      "starts_at": "11:00",
      "ends_at": "13:00",
      "type": "availability",
      "open": true
    }
  ],
  "future_instance_count": 1,
  "next_instance": "2020-08-24",
  "created_at": "2019-08-24T14:15:22Z",
  "updated_at": "2019-08-24T14:15:22Z"
}