Install an Add-on for the Account specified

POST /v1/InstalledAddOns
Account sid auth token

Install an Add-on for the Account specified.

application/x-www-form-urlencoded

Body

  • AvailableAddOnSid string Required

    The SID of the AvaliableAddOn to install.

    Minimum length is 34, maximum length is 34. Format should match the following pattern: ^XB[0-9a-fA-F]{32}$.

  • AcceptTermsOfService boolean Required

    Whether the Terms of Service were accepted.

  • Configuration

    The JSON object that represents the configuration of the new Add-on being installed.

  • UniqueName string

    An application-defined string that uniquely identifies the resource. This value must be unique within the Account.

Responses

  • 201 application/json

    Created

    Hide headers attributes Show headers attributes
    • Access-Control-Allow-Origin string

      Specify the origin(s) allowed to access the resource

    • Access-Control-Allow-Methods string

      Specify the HTTP methods allowed when accessing the resource

    • Access-Control-Allow-Headers string

      Specify the headers allowed when accessing the resource

    • Access-Control-Allow-Credentials boolean

      Indicates whether the browser should include credentials

    • Access-Control-Expose-Headers string

      Headers exposed to the client

    Hide response attributes Show response attributes object
    • sid string | null

      The unique string that we created to identify the InstalledAddOn resource. This Sid can also be found in the Console on that specific Add-ons page as the 'Available Add-on Sid'.

      Minimum length is 34, maximum length is 34. Format should match the following pattern: ^XE[0-9a-fA-F]{32}$.

    • account_sid string | null

      The SID of the Account that created the InstalledAddOn resource.

      Minimum length is 34, maximum length is 34. Format should match the following pattern: ^AC[0-9a-fA-F]{32}$.

    • friendly_name string | null

      The string that you assigned to describe the resource.

    • description string | null

      A short description of the Add-on's functionality.

    • configuration object | null

      The JSON object that represents the current configuration of installed Add-on.

    • unique_name string | null

      An application-defined string that uniquely identifies the resource.

    • date_created string(date-time) | null

      The date and time in GMT when the resource was created specified in ISO 8601 format.

    • date_updated string(date-time) | null

      The date and time in GMT when the resource was last updated specified in ISO 8601 format.

    • url string(uri) | null

      The absolute URL of the resource.

    • links object(uri-map) | null

      The URLs of related resources.
  • 409 application/json

    Conflict

    Hide response attributes Show response attributes object
    • code integer(int32)
    • message string
    • params object | null
    • more_info string

      Link to Error Code References

    • status integer(int32)

      HTTP response status code
POST /v1/InstalledAddOns 
curl \
 --request POST 'https://marketplace.twilio.com/v1/InstalledAddOns' \
 --user "username:password" \
 --header "Content-Type: application/x-www-form-urlencoded" \
 --data 'UniqueName=voicebase_high_accuracy_transcription_1&Configuration=%7B%22bad_words%22%3A+true%7D&AvailableAddOnSid=XBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&AcceptTermsOfService=true'
Request example 
{"UniqueName"=>"voicebase_high_accuracy_transcription_1", "Configuration"=>"{\"bad_words\": true}", "AvailableAddOnSid"=>"XBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "AcceptTermsOfService"=>true}
Response examples (201) 
{
  "sid": "XEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
  "url": "https://marketplace.twilio.com/v1/InstalledAddOns/XEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
  "links": {
    "extensions": "https://marketplace.twilio.com/v1/InstalledAddOns/XEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Extensions",
    "available_add_on": "https://marketplace.twilio.com/v1/AvailableAddOns/XBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"
  },
  "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
  "description": "Automatic Transcription and Keyword Extract...",
  "unique_name": "voicebase_high_accuracy_transcription_1",
  "date_created": "2016-04-07T23:52:28Z",
  "date_updated": "2016-04-07T23:52:28Z",
  "configuration": {
    "bad_words": true
  },
  "friendly_name": "VoiceBase High Accuracy Transcription"
}
Response examples (409) 
{
  "code": 42,
  "message": "string",
  "params": {},
  "more_info": "string",
  "status": 42
}