Skip to main content

Update an Application

POST 

/Accounts/:AccountSid/Applications/:Sid

Allows you to modify the properties of an application.

Permissions

The API token must include one of the following scopes: Voice or Messaging or Fax.

Request

Path Parameters

    AccountSid uuidrequired

    The Account ID that has the Application.

    Sid uuidrequired

    The Application ID that uniquely identifies the Application.

Body

required

    FriendlyName stringrequired

    A named unique identifier for the resource. Allowed characters: A-Za-z0-9_-. Maximum of 100 characters.

    Example: My Friendly Name
    MessageStatusCallback string

    If a message's ApplicationSid is set to this Application's Sid, when a message receives a status change, SignalWire will send a POST request to this URL with the message's details.

    Example: http://www.example.com/sms-status-callback
    SmsFallbackMethod string

    Whether the request to SmsFallbackUrl is a GET or a POST. Default is POST.

    Possible values: [GET, POST]

    Example: GET
    SmsFallbackUrl string

    The URL SignalWire will request if errors occur when fetching the SmsUrl.

    Example: http://www.example.com/sms-fallback
    SmsMethod string

    Whether the request to SmsUrl is a GET or a POST. Default is POST.

    Possible values: [GET, POST]

    Example: GET
    SmsStatusCallback string

    If a message's ApplicationSid is set to this Application's Sid, when a message receives a status change, SignalWire will send a POST request to this URL with the message's details.

    Example: http://www.example.com/sms-status-callback
    SmsUrl string

    The URL to request when an SMS is received.

    Example: http://example.com
    StatusCallback string

    The URL to pass status updates to the Application.

    Example: http://example.com
    StatusCallbackMethod string

    Whether the request to the StatusCallback URL is a GET or a POST. Default is POST.

    Possible values: [GET, POST]

    Example: POST
    VoiceFallbackMethod string

    Whether the request to VoiceFallbackUrl is a GET or a POST. Default is POST.

    Possible values: [GET, POST]

    Example: GET
    VoiceFallbackUrl string

    The URL SignalWire will request if errors occur when fetching the Url.

    Example: http://example.com
    VoiceMethod string

    Whether the request to VoiceUrl is a GET or a POST. Default is POST.

    Possible values: [GET, POST]

    Example: GET
    VoiceUrl string

    The URL to request when a phone number receives a call or fax.

    Example: http://example.com

Responses

OK

Schema

    account_sid uuid

    The unique identifier for the Account that created this Application.

    Example: b3877c40-da60-4998-90ad-b792e98472af
    api_version string

    The version of the SignalWire API.

    Example: 2010-04-01
    date_created string

    The date, in RFC 2822 GMT format, this Account was created.

    Example: Sat, 15 Sept 2018 10:00:00 +0000
    date_updated string

    The date, in RFC 2822 GMT format, this Account was updated.

    Example: Sat, 16 Sept 2018 10:00:00 +0000
    sid uuid

    The unique identifier for the Account.

    Example: b3877c40-da60-4998-90ad-b792e98472af
    friendly_name string

    A named unique identifier for the resource. Allowed characters: A-Za-z0-9_-. Maximum of 100 characters.

    Example: My Friendly Name
    message_status_callback string

    If a message's ApplicationSid is set to this Application's Sid, when a message receives a status change, SignalWire will send a POST request to this URL with the message's details.

    Example: http://www.example.com/sms-status-callback
    sms_fallback_method string

    Whether the request to SmsFallbackUrl is a GET or a POST. Default is POST.

    Possible values: [GET, POST]

    Example: GET
    sms_fallback_url string

    The URL SignalWire will request if errors occur when fetching the SmsUrl.

    Example: http://www.example.com/sms-fallback
    sms_method string

    Whether the request to SmsUrl is a GET or a POST. Default is POST.

    Possible values: [GET, POST]

    Example: GET
    sms_status_callback string

    If a message's ApplicationSid is set to this Application's Sid, when a message receives a status change, SignalWire will send a POST request to this URL with the message's details.

    Example: http://www.example.com/sms-status-callback
    sms_url string

    The URL to request when an SMS is received.

    Example: http://example.com
    status_callback string

    The URL to pass status updates to the Application.

    Example: http://example.com
    staus_callback_method string

    Whether the request to the StatusCallback URL is a GET or a POST. Default is POST.

    Possible values: [GET, POST]

    Example: POST
    uri string

    The URI for this Application.

    Example: /api/laml/2010-04-01/Accounts/b3877c40-da60-4998-90ad-b792e98472af/Applications/b3877c40-da60-4998-90ad-b792e98472af.json
    voice_caller_id_lookup boolean

    Whether or not to look up a caller's ID from the database. Possible values are true or false. Default is false.

    Example: false
    voice_fallback_method string

    Whether the request to VoiceFallbackUrl is a GET or a POST. Default is POST.

    Possible values: [GET, POST]

    Example: GET
    voice_fallback_url string

    The URL SignalWire will request if errors occur when fetching the Url.

    Example: http://example.com
    voice_method string

    Whether the request to VoiceUrl is a GET or a POST. Default is POST.

    Possible values: [GET, POST]

    Example: GET
    voice_url string

    The URL to request when a phone number receives a call or fax.

    Example: http://example.com