Update an availability template

PATCH /employees/{employeeId}/availability-templates/{id}
OAuth2

Update an availability template by its ID

Headers

  • Authorization string

    Bearer token used for authorization

    Minimum length is 1.

  • X-Correlation-Id string

    Unique identifier to allow referencing a particular transaction or event chain

    Minimum length is 1.

Path parameters

  • employeeId string Required

    Minimum length is 1.

  • id string Required

    Minimum length is 1.

application/json

Body

  • name string

    Minimum length is 1.

  • type string

    Values are DAY or WEEK.

  • timeZone string

    Minimum length is 1.

  • color string | null

    Minimum length is 1.

  • order integer | null

    Minimum value is 0.

Responses

  • • 200 application/json

    Successful operation

    Hide response attributes Show response attributes object
  • • 404 application/json

    Resource not found

    Hide response attribute Show response attribute object
    • errors array[object] Required

      At least 1 element.

      Hide errors attributes Show errors attributes object
      • message string Required

        Minimum length is 1.

      • code string Required

        Minimum length is 1.

      • type string Required

        Minimum length is 1.

      • statusCode string Required

        Minimum length is 1.
  • • 422 application/json

    Business validation failed

    • AVAILABILITY_TEMPLATE_DEFAULT_TEMPLATE_MODIFICATION_NOT_ALLOWED

    See Error codes

    Hide response attribute Show response attribute object
    • errors array[object] Required

      At least 1 element.

      Hide errors attributes Show errors attributes object
PATCH /employees/{employeeId}/availability-templates/{id} 
curl \
 -X PATCH https://api.pexipengage.com/enterprises/acme/employees/123/availability-templates/123 \
 -H "Content-Type: application/json" \
 -H "Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c" \
 -H "X-Correlation-Id: a4f0048e-c983-11ed-afa1-0242ac120002" \
 -d '{"name":"string","type":"WEEK","timeZone":"Europe/Brussels","color":"#89d0c1","order":5}'
Request example 
# Headers
Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c
X-Correlation-Id: a4f0048e-c983-11ed-afa1-0242ac120002

# Payload
{
  "name": "string",
  "type": "WEEK",
  "timeZone": "Europe/Brussels",
  "color": "#89d0c1",
  "order": 5
}
Response examples (200) 
{
  "data": {
    "id": "123",
    "name": "string",
    "type": "WEEK",
    "timeZone": "Europe/Brussels",
    "employee": {
      "id": "123"
    },
    "color": "#89d0c1",
    "order": 5,
    "isDefault": true,
    "createdAt": "2022-08-17T19:05:21.362Z",
    "updatedAt": "2022-08-17T19:05:21.362Z"
  }
}
Response examples (404) 
{
  "errors": [
    {
      "message": "string",
      "code": "string",
      "type": "string",
      "statusCode": "string"
    }
  ]
}
Response examples (422) 
{
  "errors": [
    {
      "message": "string",
      "code": "string",
      "type": "string",
      "statusCode": "string",
      "arguments": {}
    }
  ]
}