Update time range availability settings

PUT /employees/{employeeId}/availability-templates/{availabilityTemplateId}/time-ranges/{id}/availability-settings

OAuth2

Update all availability settings for a time range 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.
availabilityTemplateId string Required

Minimum length is 1.
id string Required

Minimum length is 1.

application/json

Body

forceManualAccept boolean Required
overridesDefault boolean Required
officeId string Required

Minimum length is 1.
subjectAvailabilitySettings array[object] | null
Hide subjectAvailabilitySettings attributes Show subjectAvailabilitySettings attributes object
- subjectId string Required
  
  Minimum length is 1.
- availabilitySettings array[object] Required
  Hide availabilitySettings attributes Show availabilitySettings attributes object
  
  meetingType string Required
  
  Values are OFFICE, ON_LOCATION, PHONE, or VIDEO.
  
  maxConcurrentAppointments integer Required
  
  Minimum value is 0.
  
  Additional properties are NOT allowed
Additional properties are NOT allowed

Responses

200 application/json

Successful operation
Hide response attributes Show response attributes object
- data array[object] Required
  
  Hide data attributes Show data attributes object
  
  forceManualAccept boolean Required
  
  overridesDefault boolean Required
  
  availabilityTimeRange object Required
  
  Hide availabilityTimeRange attributes Show availabilityTimeRange attributes object
  
  id string Required
  
  Minimum length is 1.
  
  Additional properties are NOT allowed
  
  office object Required
  
  Hide office attributes Show office attributes object
  
  id string Required
  
  Minimum length is 1.
  
  Additional properties are NOT allowed
  
  subjectAvailabilitySettings array[object] Required
  
  Hide subjectAvailabilitySettings attributes Show subjectAvailabilitySettings attributes object
  
  subject object Required
  
  Hide subject attributes Show subject attributes object
  
  id string Required
  
  Minimum length is 1.
  
  Additional properties are NOT allowed
  
  availabilitySettings array[object] Required
  
  Hide availabilitySettings attributes Show availabilitySettings attributes object
  
  meetingType string Required
  
  Values are OFFICE, ON_LOCATION, PHONE, or VIDEO.
  
  maxConcurrentAppointments integer Required
  
  Minimum value is 0.
  
  Additional properties are NOT allowed
  
  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.

PUT /employees/{employeeId}/availability-templates/{availabilityTemplateId}/time-ranges/{id}/availability-settings

curl \
 -X PUT https://api.development.pexipengage.com/enterprises/acme/employees/123/availability-templates/123/time-ranges/123/availability-settings \
 -H "Content-Type: application/json" \
 -H "Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c" \
 -H "X-Correlation-Id: a4f0048e-c983-11ed-afa1-0242ac120002" \
 -d '[{"forceManualAccept":true,"overridesDefault":true,"officeId":"123","subjectAvailabilitySettings":[{"subjectId":"123","availabilitySettings":[{"meetingType":"OFFICE","maxConcurrentAppointments":5}]}]}]'

Request examples

# Headers
Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c
X-Correlation-Id: a4f0048e-c983-11ed-afa1-0242ac120002

# Payload
[
  {
    "forceManualAccept": true,
    "overridesDefault": true,
    "officeId": "123",
    "subjectAvailabilitySettings": [
      {
        "subjectId": "123",
        "availabilitySettings": [
          {
            "meetingType": "OFFICE",
            "maxConcurrentAppointments": 5
          }
        ]
      }
    ]
  }
]

Response examples (200)

{
  "data": [
    {
      "forceManualAccept": true,
      "overridesDefault": true,
      "availabilityTimeRange": {
        "id": "123"
      },
      "office": {
        "id": "123"
      },
      "subjectAvailabilitySettings": [
        {
          "subject": {
            "id": "123"
          },
          "availabilitySettings": [
            {
              "meetingType": "OFFICE",
              "maxConcurrentAppointments": 5
            }
          ]
        }
      ]
    }
  ]
}

Response examples (404)

{
  "errors": [
    {
      "message": "string",
      "code": "string",
      "type": "string",
      "statusCode": "string"
    }
  ]
}