Partial Update Application

PATCH update will only update the specified field

Request URL

PATCHhttps://dashboard.bandwidth.com/api/accounts/{{account}}/applications/{{applicationId}}

Basic Authentication

Bandwidth's Account API leverages Basic Authentication with your Dashboard API Credentials. Read more about how Bandwidth secures endpoints in the Security & Credentials document.

Supported Parameters

Parameters Mandatory Description
AppName No Plain text name of the application
MsgCallbackUrl No Url to receive message events
CallInitiatedCallbackUrl No Url to receive voice events
CallInitiatedMethod No HTTP method for events sent to the CallInitiatedCallbackUrl.
POST or GET
Default is POST
CallStatusCallbackUrl No Url to receive voice events NOT related to Initiated. Such as: rejected or hung up.
CallStatusMethod No HTTP method for events sent to the CallStatusCallbackUrl.
POST or GET
Default is POST
CallbackCreds No Basic auth credentials to apply to your message & voice events
CallbackCreds.UserId No Basic auth UserId
CallbackCreds.Password No Basic auth Password
CallInitiatedFallbackUrl No Url to receive voice events URL is used when voice events fail to process at CallInitiatedCallbackUrl
CallInitiatedFallbackMethod No HTTP method for events sent to the CallInitiatedFallbackUrl.
POST or GET
Default is POST
CallInitiatedFallbackCreds No Basic auth credentials to apply to voice events sent to the CallInitiatedFallbackUrl.
CallInitiatedFallbackCreds.UserId No Basic auth UserId
CallInitiatedFallbackCreds.Password No Basic auth Password

Example 1 of 1: Update only the UserId field

PATCH https://dashboard.bandwidth.com/api/accounts/{{accountId}}/applications/{{applicationId}} HTTP/1.1
Content-Type: application/xml; charset=utf-8
Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQ=

<Application>
    <CallbackCreds>
        <UserId>Your-NEW-User-id</UserId>
    </CallbackCreds>
</Application>

Response

HTTP/1.1 200 OK
Content-Type: application/xml

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ApplicationProvisioningResponse>
    <Application>
        <ApplicationId>d775585a-ed5b-4a49-8b96-f68c0a993ebe</ApplicationId>
        <ServiceType>Messaging-V2</ServiceType>
        <AppName>Production Server</AppName>
        <MsgCallbackUrl>https://yourSecureSite.com/callbacks</MsgCallbackUrl>
        <CallbackCreds>
            <UserId>Your-NEW-User-id</UserId>
            <Password>Your-Password</Password>
        </CallbackCreds>
    </Application>
</ApplicationProvisioningResponse>

results matching ""

    No results matching ""