API

Create a blocked time

Creates a blocked time for a company.

POST/v1/hq/blocked_times
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

company*string|
employee?string|
space?string|Deprecated
resource?|string
title?string
Example"Lunch"
starts_at*string

Start time of blocked time

Formatdate-time
Example"2022-09-12T12:00:00Z"
ends_at*string

End time of blocked time

Formatdate-time
Example"2022-09-12T13:00:00Z"
rrule?string

RRULE string for recurring events and blocked times.

The dtstart property is ignored, and the start time of the event/blocked time is used instead.

If no until is specified, it will default to 2 years from time of creation.

Until has a maximum value of 2 years from time of creation.

Count can be any value, but generated events/blocked times past the 2 year mark will be ignored.

Example"FREQ=WEEKLY;INTERVAL=1;BYDAY=MO,TU,WE,TH,FR"
theme?string
Formatenum
Value in"themered" | "themepurple" | "themeyellow" | "themewine" | "themeorange" | "themegreen" | "themeblack" | "themegrey" | "themeblue" | "themecoral" | "thememint"
Example"themeblack"

Response Body

application/json

application/json

curl -X POST "https://api.noona.is/v1/hq/blocked_times" \  -H "Content-Type: application/json" \  -d '{    "company": "string",    "starts_at": "2022-09-12T12:00:00Z",    "ends_at": "2022-09-12T13:00:00Z"  }'
{
  "id": "7awdXwZoedakjad37a",
  "company": "string",
  "employee": "string",
  "space": "string",
  "resource": {
    "id": "7dj29KiAE1wdjw731",
    "company": "string",
    "resource_group": {
      "id": "string"
    },
    "type": "space",
    "name": "Table 1",
    "name_translations": {
      "is": "King Accounting tenging",
      "fr": "Connexion King Accounting"
    },
    "description": "A good window view",
    "description_translations": {
      "is": "King Accounting tenging",
      "fr": "Connexion King Accounting"
    },
    "priority": "normal",
    "image": {
      "thumb": "https://placekitten.com/200/200",
      "image": "https://placekitten.com/200/300",
      "public_id": "https://placekitten.com/200/300",
      "type": "thumbnail",
      "provider": "cloudinary",
      "width": 200,
      "height": 300,
      "bytes": 95849
    },
    "reference_id": "1234567890",
    "marketplace": true,
    "available_for_bookings": true,
    "booking_interval": 15,
    "order": 1,
    "min_capacity": 1,
    "max_capacity": 2,
    "allow_overlapping_bookings": false,
    "sub_resources": [
      "string"
    ],
    "event_type_preferences": [
      {
        "event_type": "string",
        "skip": false,
        "skip_calendar": false,
        "skip_marketplace": false,
        "has_custom_duration": false,
        "custom_duration": {
          "duration": 60,
          "before_pause": 25,
          "pause": 10,
          "after_pause": 25
        }
      }
    ],
    "created_at": "2019-08-24T14:15:22Z",
    "updated_at": "2019-08-24T14:15:22Z"
  },
  "title": "Lunch",
  "starts_at": "2022-09-12T12:00:00Z",
  "ends_at": "2022-09-12T13:00:00Z",
  "date": "2022-09-12",
  "rrule": "FREQ=WEEKLY;INTERVAL=1;BYDAY=MO,TU,WE,TH,FR",
  "duration": 60,
  "theme": "themeblack",
  "created_by": "string",
  "updated_by": "string",
  "created_at": "2019-08-24T14:15:22Z",
  "updated_at": "2019-08-24T14:15:22Z"
}
{
  "message": "Customer onboarding error."
}
Empty
Empty
Empty