Skip to content
BuildBase
HTTP API menu

Create a shared booking calendar for the signed-in user as a seller

Saves a calendar with its name, slot grid and settings, for the seller's items to book on.

Warning

Not fully described yet. The API description has no described successful answer for this operation yet. The method, path, sign-in, rate limits and request fields on this page are read from the server's code and are accurate; what a successful call returns is not written down here yet. Until it is, search engines and the agent index leave this page out.

POST/api/v1/public/me/calendars

Sign-in
A signed-in user's session: send the session id in the x-session-id header.
Rate limit
Up to 500 requests every 3 seconds per IP address; up to 1,000 requests a minute per API key (some requests are not counted).

Saves a calendar with its name, slot grid and settings, for the seller's items to book on. Answers 404 when the user has not started selling, and 422 when the grid is not valid or the seller already keeps the most calendars allowed (20).

Request

Send the body as application/json.

Body

FieldTypeRequiredConstraintsDescription
namestringYes1 to 80 characters-
timeZonestringYesat most 64 characters-
slotMinutesintegerYesat least 0, at most 720-
bufferMinutesintegerNoat least 0, at most 240-
bufferBeforeMinutesintegerNoat least 0, at most 240-
seatsPerSlotintegerNoat least 0, at most 1000-
weeklyobjectYes--
weekly.monarray of objectNoat most 6 items-
weekly.mon[].fromstringNoat most 5 characters-
weekly.mon[].tostringNoat most 5 characters-
weekly.tuearray of objectNoat most 6 items-
weekly.tue[].fromstringNoat most 5 characters-
weekly.tue[].tostringNoat most 5 characters-
weekly.wedarray of objectNoat most 6 items-
weekly.wed[].fromstringNoat most 5 characters-
weekly.wed[].tostringNoat most 5 characters-
weekly.thuarray of objectNoat most 6 items-
weekly.thu[].fromstringNoat most 5 characters-
weekly.thu[].tostringNoat most 5 characters-
weekly.friarray of objectNoat most 6 items-
weekly.fri[].fromstringNoat most 5 characters-
weekly.fri[].tostringNoat most 5 characters-
weekly.satarray of objectNoat most 6 items-
weekly.sat[].fromstringNoat most 5 characters-
weekly.sat[].tostringNoat most 5 characters-
weekly.sunarray of objectNoat most 6 items-
weekly.sun[].fromstringNoat most 5 characters-
weekly.sun[].tostringNoat most 5 characters-
exceptionsarray of objectNoat most 200 items-
exceptions[].datestringNoat most 10 characters-
exceptions[].windowsarray of objectNoat most 6 items-
exceptions[].windows[].fromstringNoat most 5 characters-
exceptions[].windows[].tostringNoat most 5 characters-
capacityModelstringNoone of "shared_pool", "item_caps", "exclusive"-
moveConflictsstringNoone of "refuse", "overbook"-
bookingLimitsobject or nullNo--
bookingLimits.perDayinteger or nullNoat least 0, at most 1000-
bookingLimits.perWeekinteger or nullNoat least 0, at most 1000-

Example request

Replace each YOUR_... value with your own, and set the credential in the environment variable the sample reads.

curl -X POST "https://api.console.buildbase.app/api/v1/public/me/calendars" \
  -H "x-session-id: $BUILDBASE_SESSION_ID" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "Example",
  "timeZone": "string",
  "slotMinutes": 0,
  "weekly": {
    "mon": [
      {
        "from": "string",
        "to": "string"
      }
    ],
    "tue": [
      {
        "from": "string",
        "to": "string"
      }
    ],
    "wed": [
      {
        "from": "string",
        "to": "string"
      }
    ]
  }
}'
const response = await fetch(
  'https://api.console.buildbase.app/api/v1/public/me/calendars',
  {
    method: 'POST',
    headers: {
      'x-session-id': process.env.BUILDBASE_SESSION_ID ?? '',
      'Content-Type': 'application/json',
    },
    body: JSON.stringify({
      name: 'Example',
      timeZone: 'string',
      slotMinutes: 0,
      weekly: {
        mon: [
          {
            from: 'string',
            to: 'string',
          },
        ],
        tue: [
          {
            from: 'string',
            to: 'string',
          },
        ],
        wed: [
          {
            from: 'string',
            to: 'string',
          },
        ],
      },
    }),
  }
);
if (!response.ok) {
  throw new Error(`${response.status}: ${await response.text()}`);
}
const data = await response.text();
import os

import requests

response = requests.post(
    "https://api.console.buildbase.app/api/v1/public/me/calendars",
    headers={
        "x-session-id": os.environ["BUILDBASE_SESSION_ID"],
    },
    json={
        "name": "Example",
        "timeZone": "string",
        "slotMinutes": 0,
        "weekly": {
            "mon": [
                {
                    "from": "string",
                    "to": "string",
                },
            ],
            "tue": [
                {
                    "from": "string",
                    "to": "string",
                },
            ],
            "wed": [
                {
                    "from": "string",
                    "to": "string",
                },
            ],
        },
    },
    timeout=30,
)
response.raise_for_status()
data = response.text

Responses

A successful answer is not described yet. The server answers with the status and body its handler sends.

Any other status

The handler's own answer. Not described yet: response bodies come from captured responses (server/openapi/captured) and overlays (server/openapi/overlays).

Errors

Each refusal, what it means, and what to do. The request changed nothing.

400 Bad Request

What it means: The request failed a validate() schema, or an id in the path is not a valid id. path names the field.

What to do: Fix the field the body names in path (or read message) and send the request again. Nothing was changed.

Example
{
  "error": true,
  "success": false,
  "path": "string",
  "message": "string"
}

401 Unauthorized

What it means: The credential is missing, expired or not accepted here, or the caller's role has no grant for x-permission (refused with 401 too). The body is the plain text Unauthorized, or a JSON body with a code where the gate says why.

What to do: Send the credential this operation asks for (see Sign-in above), or sign in again if it expired. A valid credential is also refused when the role has no grant for the permission above.

Example
Unauthorized

429 Too Many Requests

What it means: A rate limit in x-rateLimit was reached. retryAfter and the Retry-After header say how many seconds until the window resets.

What to do: Wait the number of seconds in the Retry-After header (also retryAfter in the body), then retry. Slow down repeated calls.

Example
{
  "success": false,
  "message": "string",
  "reason": "rate_limited",
  "retryAfter": 1
}