Update office subject coverage regions

PUT /employees/{id}/office-subject-coverage-regions
OAuth2

Update office subject coverage regions for an agent within an office 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.

Query parameters

  • office-id string Required

    Office ID

    Minimum length is 1.

  • subject-id string Required

    Subject ID

    Minimum length is 1.

application/json

Body

  • meetingType string Required

    Values are OFFICE, ON_LOCATION, PHONE, or VIDEO.

  • regionIds array[string] Required

    At least 1 element. Minimum length of each is 1.

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.

      • office object Required

        Additional properties are NOT allowed.

        Hide office attribute Show office attribute object
        • id string Required

          Minimum length is 1.

      • regions array[object] Required
        Hide regions attribute Show regions attribute object
        • id string Required

          Minimum length is 1.

      • subject object Required

        Additional properties are NOT allowed.

        Hide subject attribute Show subject attribute object
        • id string Required

          Minimum length is 1.
  • 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/{id}/office-subject-coverage-regions 
curl \
 -X PUT https://api.development.pexipengage.com/enterprises/acme/employees/1234/office-subject-coverage-regions?office-id=123&subject-id=123 \
 -H "Content-Type: application/json" \
 -H "Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c" \
 -H "X-Correlation-Id: a4f0048e-c983-11ed-afa1-0242ac120002" \
 -d '[{"meetingType":"OFFICE","regionIds":["123"]}]'
Request examples 
# Headers
Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c
X-Correlation-Id: a4f0048e-c983-11ed-afa1-0242ac120002

# Payload
[
  {
    "meetingType": "OFFICE",
    "regionIds": [
      "123"
    ]
  }
]
Response examples (200) 
{
  "data": [
    {
      "meetingType": "OFFICE",
      "office": {
        "id": "123"
      },
      "regions": [
        {
          "id": "123"
        }
      ],
      "subject": {
        "id": "123"
      }
    }
  ]
}
Response examples (404) 
{
  "errors": [
    {
      "message": "string",
      "code": "string",
      "type": "string",
      "statusCode": "string"
    }
  ]
}