Skip to main content
Skip table of contents

Modify an IVR Service

PATCH /Services/{serviceId}

Description:
Updates one or more fields of an existing IVR service. Fields not included in the request remain unchanged. (This endpoint supports JSON Merge Patch as described in RFC 7386.)

Path Parameter:

  • serviceId (required)
    Type: integer
    Description: The identifier of the IVR service to be updated.
    Example: 561814

Request Body:
The request body is of type application/merge-patch+json and may include:

  • name (string):
    The new name (maximum 50 characters).

  • phoneNumber (string):
    The new phone number (maximum 50 characters).

  • tenantId (string):
    The new tenant id (maximum 255 characters); set to null to use the default value.

Security:
Requires Basic Authentication.

Responses:

  • 204 No Content:
    Indicates that the update was successful.

  • 400 Bad Request:
    If validation fails. The error response provides a reason code:

    • 0: Some required parameters are missing.

    • 1: Given service id is not valid.

    • 2: Given name is not valid or too long.

    • 3: Given phone number is not valid or too long.

    • 4: Given tenant id is not valid or does not exist.

  • 401 Unauthorized, 403 Forbidden, 404 Not Found, 409 Conflict, 500 Internal Server Error, 504 Gateway Timeout:
    Standard error responses.

JavaScript errors detected

Please note, these errors can depend on your browser setup.

If this problem persists, please contact our support.