Create a new Custom Operator for the given Account

POST /v2/Operators/Custom
Account sid auth token

Create a new Custom Operator for the given Account

application/x-www-form-urlencoded

Body

  • FriendlyName string Required

    A human readable description of the new Operator, up to 64 characters.

  • OperatorType string Required

    Operator Type for this Operator. References an existing Operator Type resource.

  • Config Required

    Operator configuration, following the schema defined by the Operator Type.

Responses

  • 202 application/json

    Accepted

    Hide headers attributes Show headers attributes
    • ETag string
    • X-Rate-Limit-Limit string
    • X-Rate-Limit-Remaining string
    • X-Rate-Limit-Config string
    • 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
    • account_sid string | null

      The unique SID identifier of the Account the Custom Operator belongs to.

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

    • sid string | null

      A 34 character string that uniquely identifies this Custom Operator.

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

    • friendly_name string | null

      A human-readable name of this resource, up to 64 characters.

    • description string | null

      A human-readable description of this resource, longer than the friendly name.

    • author string | null

      The creator of the Custom Operator. Custom Operators can only be created by a Twilio Account.

    • operator_type string | null

      Operator Type for this Operator. References an existing Operator Type resource.

    • version integer

      Numeric Custom Operator version. Incremented with each update on the resource, used to ensure integrity when updating the Custom Operator.

      Default value is 0.

    • availability string

      Custom Operator availability status. Possible values: internal, beta, public, retired.

      Values are internal, beta, public, or retired.

    • config

      Operator configuration, following the schema defined by the Operator Type. Only available on Operators created by the Account.

    • date_created string(date-time) | null

      The date that this Custom Operator was created, given in ISO 8601 format.

    • date_updated string(date-time) | null

      The date that this Custom Operator was updated, given in ISO 8601 format.

    • url string(uri) | null

      The URL of this resource.
POST /v2/Operators/Custom 
curl \
 --request POST 'https://intelligence.twilio.com/v2/Operators/Custom' \
 --user "username:password" \
 --header "Content-Type: application/x-www-form-urlencoded" \
 --data 'Config=%7B+%22configuration%22+%3A+%7B+%22field%22%3A+%22value%22%7D%7D&FriendlyName=My+New+Operator&OperatorType=operator-type-name'
Request example 
{"Config"=>"{ \"configuration\" : { \"field\": \"value\"}}", "FriendlyName"=>"My New Operator", "OperatorType"=>"operator-type-name"}
Response examples (202) 
{
  "sid": "LYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
  "url": "https://intelligence.twilio.com/v2/Operators/Custom/LYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
  "author": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
  "config": {
    "configuration": {
      "field": "value"
    }
  },
  "version": 1,
  "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
  "description": "New Operator",
  "availability": "public",
  "date_created": "2010-08-31T20:36:28Z",
  "date_updated": "2010-08-31T20:36:28Z",
  "friendly_name": "My New Operator",
  "operator_type": "operator-type-name"
}