This endpoint creates a Listing based on the given data

POST /v1/Listings
Account sid auth token

This endpoint creates a Listing based on the given data.

application/x-www-form-urlencoded

Body

  • ModuleInfo string

    A JSON object containing essential attributes that define a Listing.

  • Configuration string

    A JSON object for providing Listing-specific configuration. Contains button setup, notification URL, and more.

Responses

  • 200 application/json

    OK

    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
    • url string(uri) | null

      URL to query the subresource.

    • sid string | null

      ModuleSid that identifies this Listing.

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

    • description object | null

      A JSON object describing the module and is displayed under the Description tab of the Module detail page. You can define the main body of the description, highlight key features or aspects of the module and if applicable, provide code samples for developers

    • support object | null

      A JSON object containing information on how customers can obtain support for the module. Use this parameter to provide details such as contact information and support description.

    • policies object | null

      A JSON object describing the module's privacy and legal policies and is displayed under the Policies tab of the Module detail page. The maximum file size for Policies is 5MB

    • module_info object | null

      A JSON object containing essential attributes that define a module. This information is presented on the Module detail page in the Twilio Marketplace Catalog. You can pass the following attributes in the JSON object

    • documentation object | null

      A JSON object for providing comprehensive information, instructions, and resources related to the module

    • configuration object | null

      A JSON object for providing listing specific configuration. Contains button setup, notification url, among others.

    • pricing object | null

      A JSON object for providing Listing specific pricing information.
POST /v1/Listings 
curl \
 --request POST 'https://marketplace.twilio.com/v1/Listings' \
 --user "username:password" \
 --header "Content-Type: application/x-www-form-urlencoded" \
 --data '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&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'
Request example 
{"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."}, "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"]}}}
Response examples (200) 
{
  "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"
  }
}