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

application/json

Body

Responses

  • 200 application/json

    Successful operation

    Hide response attribute Show response attribute object
    • data array[object] Required
      Hide data attributes Show data attributes object
      • forceManualAccept boolean Required
      • overridesDefault boolean Required
      • availabilityTimeRange object Required

        Additional properties are NOT allowed.

        Hide availabilityTimeRange attribute Show availabilityTimeRange attribute object
        • id string Required

          Minimum length is 1.

      • office object Required

        Additional properties are NOT allowed.

        Hide office attribute Show office attribute object
        • id string Required

          Minimum length is 1.

      • subjectAvailabilitySettings array[object] Required
        Hide subjectAvailabilitySettings attributes Show subjectAvailabilitySettings attributes object
        • subject object Required

          Additional properties are NOT allowed.

          Hide subject attribute Show subject attribute object
          • id string Required

            Minimum length is 1.

        • availabilitySettings array[object] Required
          Hide availabilitySettings attributes Show availabilitySettings 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.
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"
    }
  ]
}