PUT /pm-extension-ms/available-extensions/v1

Update the extension description.

To modify the details of a security profile:

  1. Perform the authentication and login to the API. For more information, see POST /auth/login.

  2. Use PUT /pm-extension-ms/available-extensions/v1 to send an HTTP PUT request.

  3. Click Try it Out option.

  4. Under Request body select application/json from drop-down list.

  5. Enter the request body parameter values as follows:
    {
  "extension": "string",
  "freeTime": "string",
  "availabilityType": "string",
  "description": "string",
  "mxoneSubsystem": "string"
}
    The following table describes the request body parameters.

    Parameter Name

    Sample Value

    Description

    >mxoneSubsystem

    String

    Enter the Telephony System.

    Format: String

    Options: Available Telephony Subsystems that have been previously created.
    Note: This parameter is mandatory.

    >availabilityType

    String

    When searching for an available extension numbers it is possible to enter the Description either partially or fully. All the available extensions with the entered description are listed.

    Format: Up to 250 alphanumerical characters.

    Example: reserved

    >extension

    String

    The Extension Number. The extension number is the directory number for the extension.

    Format: Non-editable
    Note: This parameter is mandatory.

    >description

    String

    When searching for an available extension numbers it is possible to enter the Description either partially or fully. All the available extensions with the entered description are listed.

    Format: Up to 250 alphanumerical characters.

    Example: reserved

  6. Click on Execute to generate the request URL.

    Request URL:
    https://<IP_Address>:<PORT>/pm-extension-ms/available-extensions/v1
    The following table lists the expected responses.

    Response Type

    Value

    Schema
    Valid Response

    200 OK
    For 200 OK, 
    {
  "extension": "string",
  "freeTime": "string",
  "availabilityType": "string",
  "description": "string",
  "miVoiceMXONE": "string"
}

    Error Response

    400 Bad Request

    Not applicable

    401 Authentication Failure

    Not applicable

    403 Forbidden

    Not applicable

    404 Not found

    Not applicable
Parent topic: Available Extensions
↑