---
title: "Create a pay schedule calendar URL"
method: POST
path: "/pay_schedules/{pay_schedule}/calendar_url"
tags: ["Pay Schedules"]
---

# Create a pay schedule calendar URL

`POST /pay_schedules/{pay_schedule}/calendar_url`

## Request

- Base URL: `https://sandbox.nmbr.co/services/payroll`
- URL: `https://sandbox.nmbr.co/services/payroll/pay_schedules/{pay_schedule}/calendar_url`
- Auth: HTTP bearer

Creates a calendar subscription URL for the pay schedule, replacing any existing one. The previous URL stops working immediately, so calendars subscribed to it no longer update, in every language.

## Path parameters

- `pay_schedule` string, required

## Request body

- object
  - `locale` 'en' | 'fr': The language of the calendar's event names. When omitted, the business entity's `preferred_locale` is used.

## Response `200`

OK

- unknown

## Changes

- **2026-09-29** `c42443c08e9e`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/nmbr/apis/nmbr-api/changes/pay_schedules/:pay_schedule/calendar_url/post.md)

---

[API](https://skmtc.dev/nmbr/apis/nmbr-api.md) - [All operations](https://skmtc.dev/nmbr/apis/nmbr-api/llms.txt) - [OpenAPI document](https://skmtc.dev/nmbr/apis/nmbr-api/revisions/3a5d58d37d2c?raw)