v54

latestOpenAPI 3.0.0raw.githubusercontent.com2026-08-01594762.7 KB

Holidays

Create or update holiday

Creates or updates a holiday, searching by holiday ID.

Permissions

Any user or API key must have at least one of the appropriate License Manager resources to be able to successfully run this request. Otherwise they will receive a status code 403 error. These are the applicable resources for this endpoint:

Product	Category	Resource
Logistics	Logistics access	Logistics full access
Logistics	Logistics access	Logistics shipping full access

You can create a custom role with that resource or use one of the following predefined roles:

Role	Resource
Logistics - Full access	Logistics full access
OMS - Full access	Logistics full access
Logistics - Full access	Logistics shipping full access
OMS - Full access	Logistics shipping full access

❗ Assigning a predefined role to users or application keys usually grants permission to multiple License Manager resources. If some of these permissions are not necessary, consider creating a custom role instead. For more information regarding security, see Best practices for using application keys. To learn more about machine authentication at VTEX, see Authentication overview.

put/api/logistics/pvt/configuration/holidays/{holidayId}

Path parameters

holidayIdstring required

Example:christmas2025

Holiday ID.

Headers

Acceptstring required

HTTP Client Negotiation Accept Header. Indicates the types of responses the client can understand.

Content-Typestring required

Type of the content being sent.

Request body

namestring required

Holiday ID.

startDatestring required

Holiday starting date, in the format YYYY-MM-DD.

Example request

{
  "name": "Christmas",
  "startDate": "2024-12-25"
}

v54