Update a specific Sink

POST /v1/Sinks/{Sid}

Sink destination to send events to

Path parameters

Sid string Required

A 34 character string that uniquely identifies this Sink.

Body

Description string Required

A human readable description for the Sink This value should not contain PII.

Responses

200

OK
Hide response attributes Show response attributes object
- date_created string(date-time) | null
  
  The date this Sink was created
- date_updated string(date-time) | null
  
  The date this Sink was updated
- description string | null
  
  Sink Description
- links object(uri-map) | null
  
  Nested resource URLs.
- sid string | null
  
  A string that uniquely identifies this Sink.
  
  Minimum length is 34, maximum length is 34. Format should match the following pattern: ^DG[0-9a-fA-F]{32}$.
- sink_configuration
  
  JSON Sink configuration.
- sink_type string | null
  
  Sink type.
  
  Values are kinesis, webhook, or segment.
- status string | null
  
  The Status of this Sink
  
  Values are initialized, validating, active, or failed.
- url string(uri) | null
  
  The URL of this resource.

POST /v1/Sinks/{Sid}

curl \
 -X POST https://events.twilio.com/v1/Sinks/{Sid} \
 --user "username:password" \
 -H "Content-Type: application/x-www-form-urlencoded" \
 -d 'Description=string'

Request example

{
  "Description": "string"
}

Request examples

{
  "Description": "string"
}

Response examples (200)

{
  "date_created": "2023-05-04T09:42:00+00:00",
  "date_updated": "2023-05-04T09:42:00+00:00",
  "description": "string",
  "links": {},
  "sid": "string",
  "sink_type": "kinesis",
  "status": "initialized",
  "url": "https://example.com"
}

Response examples (200)

{
  "date_created": "2024-05-04T09:42:00+00:00",
  "date_updated": "2024-05-04T09:42:00+00:00",
  "description": "string",
  "links": {},
  "sid": "string",
  "sink_type": "kinesis",
  "status": "initialized",
  "url": "https://example.com"
}