This endpoint updates the data of a given Listing
This endpoint updates the data of a given Listing. To find a Listing's SID, use the Available Add-ons resource or view its Listing details page in the Console by visiting the Catalog or the My Listings tab and selecting the Listing. Only Listing owners are allowed to update the Listing.
Path parameters
-
SID that uniquely identifies the Listing.
Minimum length is
34
, maximum length is34
. Format should match the following pattern:^XB[0-9a-fA-F]{32}$
.
Body
-
A JSON object containing essential attributes that define a Listing.
-
A JSON object describing the Listing. You can define the main body of the description, highlight key features or aspects of the Listing, and provide code samples for developers if applicable.
-
A JSON object for providing comprehensive information, instructions, and resources related to the Listing.
-
A JSON object describing the Listing's privacy and legal policies. The maximum file size for Policies is 5MB.
-
A JSON object containing information on how Marketplace users can obtain support for the Listing. Use this parameter to provide details such as contact information and support description.
-
A JSON object for providing Listing-specific configuration. Contains button setup, notification URL, and more.
-
A JSON object for providing Listing's purchase options.
curl \
--request POST 'https://marketplace.twilio.com/v1/Listing/{Sid}' \
--user "username:password" \
--header "Content-Type: application/x-www-form-urlencoded" \
--data 'Pricing=%7B%22body%22%3D%3E%22%23%23%23+Basic+plan+-+%2415%2Fmonth%22%7D&Support=%7B%22billing_email%22%3D%3E%22billing%40billing.com%22%2C+%22billing_phone%22%3D%3E%22%2B1+888-888-8888%22%2C+%22technical_email%22%3D%3E%22support%40support.com%22%2C+%22technical_phone%22%3D%3E%22%2B1+888-888-8888%22%2C+%22support_description%22%3D%3E%22Call+Support+for+any+help.%22%2C+%22customer_support_email%22%3D%3E%22support%40support.com%22%2C+%22customer_support_phone%22%3D%3E%22%2B1+888-888-8888%22%7D&Policies=%7B%22legal%22%3D%3E%22%5BLink+Custom+Name%5D%28https%3A%2F%2Fwww.mycompany.legal%29%22%2C+%22privacy%22%3D%3E%22%5BLink+Custom+Name%5D%28https%3A%2F%2Fwww.mycompany.privacy.com%29%22%7D&ModuleInfo=%7B%22name%22%3D%3E%22My+Company+Marketplace+Listing%22%2C+%22tagline%22%3D%3E%22My+Company+Subheadline%22%2C+%22logo_url%22%3D%3E%22https%3A%2F%2Fmycompany.com%2Fimage.png%22%2C+%22provider_name%22%3D%3E%22My+Company+Name%22%2C+%22provider_web_url%22%3D%3E%22https%3A%2F%2Fwww.sampleurl.com%22%2C+%22logo_bg_color_hex%22%3D%3E%22%23ff5722%22%2C+%22short_description%22%3D%3E%22Short+description+on+what+the+Company+does.%22%7D&Description=%7B%22body%22%3D%3E%22Long+Description+about+the+Listing%2FCompany%22%2C+%22highlights%22%3D%3E%5B%7B%22title%22%3D%3E%22Feature+1%22%2C+%22description%22%3D%3E%22Feature+1+Description%22%7D%2C+%7B%22title%22%3D%3E%22Feature+2%22%2C+%22description%22%3D%3E%22Feature+2+Description%22%7D%5D%2C+%22code_samples%22%3D%3E%5B%7B%22code%22%3D%3E%22console.log%28%E2%80%98Hello%2C+World%E2%80%99%29%3B%22%2C+%22title%22%3D%3E%22Example+1%22%2C+%22description%22%3D%3E%22This+is+just+a+code+sample%22%7D%5D%7D&Configuration=%7B%22buttons%22%3D%3E%5B%7B%22url%22%3D%3E%22https%3A%2F%2Fmycompanysignup.com%22%2C+%22label%22%3D%3E%22Setup+Account%22%2C+%22help_text%22%3D%3E%22Help+caption+for+the+button%22%7D%5D%2C+%22notification_configuration%22%3D%3E%7B%22callback_url%22%3D%3E%22https%3A%2F%2Fexample.com%22%2C+%22notification_events%22%3D%3E%5B%22module_install%22%5D%7D%7D&Documentation=%7B%22body%22%3D%3E%22%23%23%23+Large+documentation+body.%22%7D'
{"Pricing"=>{"body"=>"### Basic plan - $15/month"}, "Support"=>{"billing_email"=>"billing@billing.com", "billing_phone"=>"+1 888-888-8888", "technical_email"=>"support@support.com", "technical_phone"=>"+1 888-888-8888", "support_description"=>"Call Support for any help.", "customer_support_email"=>"support@support.com", "customer_support_phone"=>"+1 888-888-8888"}, "Policies"=>{"legal"=>"[Link Custom Name](https://www.mycompany.legal)", "privacy"=>"[Link Custom Name](https://www.mycompany.privacy.com)"}, "ModuleInfo"=>{"name"=>"My Company Marketplace Listing", "tagline"=>"My Company Subheadline", "logo_url"=>"https://mycompany.com/image.png", "provider_name"=>"My Company Name", "provider_web_url"=>"https://www.sampleurl.com", "logo_bg_color_hex"=>"#ff5722", "short_description"=>"Short description on what the Company does."}, "Description"=>{"body"=>"Long Description about the Listing/Company", "highlights"=>[{"title"=>"Feature 1", "description"=>"Feature 1 Description"}, {"title"=>"Feature 2", "description"=>"Feature 2 Description"}], "code_samples"=>[{"code"=>"console.log(‘Hello, World’);", "title"=>"Example 1", "description"=>"This is just a code sample"}]}, "Configuration"=>{"buttons"=>[{"url"=>"https://mycompanysignup.com", "label"=>"Setup Account", "help_text"=>"Help caption for the button"}], "notification_configuration"=>{"callback_url"=>"https://example.com", "notification_events"=>["module_install"]}}, "Documentation"=>{"body"=>"### Large documentation body."}}
{
"sid": "XBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
"url": "https://marketplace.twilio.com/v1/Listing/XBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
"pricing": {
"body": "Basic plan - $10/month"
},
"support": {
"billing_email": "anEmail",
"billing_phone": "+1 888-888-8888",
"technical_email": "anEmail",
"technical_phone": "+1 888-888-8888",
"support_description": "aDescription",
"customer_support_email": "anEmail",
"customer_support_phone": "+1 888-888-8888"
},
"policies": {
"legal": "someOtherUrl",
"privacy": "someUrl"
},
"description": {
"body": "aBody",
"highlights": [
{
"title": "aTitle",
"description": "aDescription"
}
],
"code_samples": [
{
"code": "aCode",
"title": "aTitle",
"description": "aDescription"
}
]
},
"module_info": {
"tag": "Description",
"tagline": "aTagline",
"logo_url": "aUrl",
"logo_bg_color_hex": "#ff5722"
},
"configuration": {
"buttons": [
{
"url": "https://example.com",
"label": "Configurable button text",
"help_text": "The button text, url, and help text are now configurable via self service"
}
],
"notification_configuration": {
"callback_url": "https://example.com"
}
},
"documentation": {
"body": "aBody"
}
}