Create a new Rate Limit for a Service

POST /v2/Services/{ServiceSid}/RateLimits

TODO: Resource-level docs

Create a new Rate Limit for a Service

Path parameters

Body

  • Description string

    Description of this Rate Limit

  • UniqueName string Required

    Provides a unique and addressable name to be assigned to this Rate Limit, assigned by the developer, to be optionally used in addition to SID. This value should not contain PII.

Responses

  • 201

    Created

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

      The SID of the Account that created the resource

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

    • date_created string(date-time) | null

      The RFC 2822 date and time in GMT when the resource was created

    • date_updated string(date-time) | null

      The RFC 2822 date and time in GMT when the resource was last updated

    • description string | null

      Description of this Rate Limit

    • links object(uri-map) | null

      The URLs of related resources

    • service_sid string | null

      The SID of the Service that the resource is associated with

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

    • sid string | null

      A string that uniquely identifies this Rate Limit.

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

    • unique_name string | null

      A unique, developer assigned name of this Rate Limit.

    • url string(uri) | null

      The URL of this resource.
POST /v2/Services/{ServiceSid}/RateLimits 
curl \
 -X POST https://verify.twilio.com/v2/Services/{ServiceSid}/RateLimits \
 --user "username:password" \
 -H "Content-Type: application/x-www-form-urlencoded" \
 -d 'Description=string&UniqueName=string'
Request example 
{
  "Description": "string",
  "UniqueName": "string"
}
Request examples 
{
  "Description": "string",
  "UniqueName": "string"
}
Response examples (201) 
{
  "account_sid": "string",
  "date_created": "2023-05-04T09:42:00+00:00",
  "date_updated": "2023-05-04T09:42:00+00:00",
  "description": "string",
  "links": {},
  "service_sid": "string",
  "sid": "string",
  "unique_name": "string",
  "url": "https://example.com"
}
Response examples (201) 
{
  "account_sid": "string",
  "date_created": "2024-05-04T09:42:00+00:00",
  "date_updated": "2024-05-04T09:42:00+00:00",
  "description": "string",
  "links": {},
  "service_sid": "string",
  "sid": "string",
  "unique_name": "string",
  "url": "https://example.com"
}