Update subject availability settings

PUT /subjects/{id}/availability-settings

OAuth2

Update all availability settings for a subject 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

id string Required

Primary identifier of the requested resource

Minimum length is 1.

application/json

Body

meetingType string Required

Values are OFFICE, ON_LOCATION, PHONE, or VIDEO.
autoAccept boolean Required
estimatedDuration integer Required

Minimum value is 1.
timeSlotGranularity integer Required

Minimum value is 1.
trailingBufferTime integer Required

Minimum value is 0.
timeSlotEarliestPossible integer Required

Minimum value is 0.
timeSlotLatestPossible integer Required

Minimum value is 0.
maxConcurrentAppointments integer Required

Minimum value is 0.

Responses

200 application/json

Successful operation
Hide response attribute Show response attribute object
- data array[object] Required
  
  Hide data attributes Show data attributes object
  
  meetingType string Required
  
  Values are OFFICE, ON_LOCATION, PHONE, or VIDEO.
  
  autoAccept boolean Required
  
  estimatedDuration integer Required
  
  Minimum value is 1.
  
  timeSlotGranularity integer Required
  
  Minimum value is 1.
  
  trailingBufferTime integer Required
  
  Minimum value is 0.
  
  timeSlotEarliestPossible integer Required
  
  Minimum value is 0.
  
  timeSlotLatestPossible integer Required
  
  Minimum value is 0.
  
  maxConcurrentAppointments integer Required
  
  Minimum value is 0.
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 /subjects/{id}/availability-settings

curl \
 -X PUT https://api.development.pexipengage.com/enterprises/acme/subjects/1234/availability-settings \
 -H "Content-Type: application/json" \
 -H "Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c" \
 -H "X-Correlation-Id: a4f0048e-c983-11ed-afa1-0242ac120002" \
 -d '[{"meetingType":"OFFICE","autoAccept":true,"estimatedDuration":5,"timeSlotGranularity":5,"trailingBufferTime":5,"timeSlotEarliestPossible":5,"timeSlotLatestPossible":5,"maxConcurrentAppointments":5}]'

Request examples

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

# Payload
[
  {
    "meetingType": "OFFICE",
    "autoAccept": true,
    "estimatedDuration": 5,
    "timeSlotGranularity": 5,
    "trailingBufferTime": 5,
    "timeSlotEarliestPossible": 5,
    "timeSlotLatestPossible": 5,
    "maxConcurrentAppointments": 5
  }
]

Response examples (200)

{
  "data": [
    {
      "meetingType": "OFFICE",
      "autoAccept": true,
      "estimatedDuration": 5,
      "timeSlotGranularity": 5,
      "trailingBufferTime": 5,
      "timeSlotEarliestPossible": 5,
      "timeSlotLatestPossible": 5,
      "maxConcurrentAppointments": 5
    }
  ]
}

Response examples (404)

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