Create an availability template

POST /employees/{employeeId}/availability-templates

OAuth2

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.

application/json

Body Required

name string Required

Minimum length is 1.
type string Required

Values are DAY or WEEK.
timeZone string Required

Minimum length is 1.
color string | null

Minimum length is 1.
order integer | null

Minimum value is 0. Default value is 0.
Additional properties are NOT allowed

Responses

201 application/json

Successful operation
Hide response attributes Show response attributes object
- data object Required
  
  Hide data attributes Show data attributes object
  
  id string Required
  
  Minimum length is 1.
  
  name string Required
  
  Minimum length is 1.
  
  type string Required
  
  Values are DAY or WEEK.
  
  timeZone string Required
  
  Minimum length is 1.
  
  employee object Required
  
  Hide employee attributes Show employee attributes object
  
  id string Required
  
  Minimum length is 1.
  
  Additional properties are NOT allowed
  
  color string Required
  
  Minimum length is 1.
  
  order integer Required
  
  Minimum value is 0.
  
  isDefault boolean Required
  
  createdAt string(date-time) Required
  
  Minimum length is 1.
  
  updatedAt string(date-time) Required
  
  Minimum length is 1.
  
  Additional properties are NOT allowed
- Additional properties are NOT allowed
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.

POST /employees/{employeeId}/availability-templates

curl \
 -X POST https://api.development.pexipengage.com/enterprises/acme/employees/123/availability-templates \
 -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 (201)

{
  "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"
    }
  ]
}