Create Operating Calendar Closure

Beta

POST/v1/operations/operating-calendars/{id}/closures

Idempotent with Idempotency-Key header. Learn more

Closes a calendar on a date.

Every ship-by date resolved against this calendar afterwards walks past the closure: a carrier that does not move on Thanksgiving pushes the day an order has to leave earlier, and a plant shutdown does the same.

Closing the same date twice is a no-op rather than an error, so re-seeding a year is safe and never renames a closure somebody has relabelled.

Permissions requiredValues:production_schedules:update

The role behind your API key or agent must grant every one of these permissions.

idstring

Operating calendar ID.

closed_onstring (date-time)

The date nothing operates. Truncated to a day.

namestring

What the closure is, such as "Thanksgiving Day" or "Summer shutdown".

objectstringenumValues:operating_calendar_closure

Resource type identifier.

idstring

Unique identifier.

operating_calendar_idstring

The calendar this closure belongs to.

closed_onstring (date-time)

The date nothing operates.

namestring

What the closure is, such as "Thanksgiving Day" or "Summer shutdown".

created_atstring (date-time)

Creation timestamp.

updated_atstring (date-time)

Last updated timestamp.

Responses

201

Successful response for Create Operating Calendar Closure

Create Operating Calendar Closure

import OpenMRP from '@openmrp/sdk';

const client = new OpenMRP({
  bearerToken: 'YOUR_API_KEY', // Your API key goes here
});

const operatingCalendarClosure = await client.operations.operatingCalendars.closures.create(
  'occd_7f2m9qk4wzxb',
  { closed_on: '2026-11-26T00:00:00Z', name: 'Thanksgiving Day' },
);

console.log(operatingCalendarClosure.id);

import OpenMRP from '@openmrp/sdk';

const client = new OpenMRP({
  bearerToken: 'YOUR_API_KEY', // Your API key goes here
});

const operatingCalendarClosure = await client.operations.operatingCalendars.closures.create(
  'occd_7f2m9qk4wzxb',
  { closed_on: '2026-11-26T00:00:00Z', name: 'Thanksgiving Day' },
);

console.log(operatingCalendarClosure.id);

201 example

{
  "object": "operating_calendar_closure",
  "id": "occdcn_3vh8yt5nqp1r",
  "operating_calendar_id": "occd_7f2m9qk4wzxb",
  "closed_on": "2026-11-26T00:00:00Z",
  "name": "Thanksgiving Day",
  "created_at": "2026-01-06T09:14:00Z",
  "updated_at": "2026-01-06T09:14:00Z"
}

{
  "object": "operating_calendar_closure",
  "id": "occdcn_3vh8yt5nqp1r",
  "operating_calendar_id": "occd_7f2m9qk4wzxb",
  "closed_on": "2026-11-26T00:00:00Z",
  "name": "Thanksgiving Day",
  "created_at": "2026-01-06T09:14:00Z",
  "updated_at": "2026-01-06T09:14:00Z"
}

Create Operating Calendar Closure

Authorization

Path Parameters

Request Body

Returns

Responses