Update an existing Supporting Document

POST /v2/RegulatoryCompliance/SupportingDocuments/{Sid}

TODO: Resource-level docs

Update an existing Supporting Document.

Path parameters

  • Sid string Required

    The unique string created by Twilio to identify the Supporting Document resource.

Body

  • Attributes

    The set of parameters that are the attributes of the Supporting Document resource which are derived Supporting Document Types.

  • FriendlyName string

    The string that you assigned to describe the resource.

Responses

  • 200

    OK

    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}$.

    • attributes

      The set of parameters that compose the Supporting Documents resource

    • date_created string(date-time) | null

      The ISO 8601 date and time in GMT when the resource was created

    • date_updated string(date-time) | null

      The ISO 8601 date and time in GMT when the resource was last updated

    • failure_reason string | null

      The failure reason of the Supporting Document Resource.

    • friendly_name string | null

      The string that you assigned to describe the resource

    • mime_type string | null

      The image type of the file

    • sid string | null

      The unique string that identifies the resource

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

    • status string | null

      The verification status of the Supporting Document resource

      Values are draft, pending-review, rejected, approved, expired, or provisionally-approved.

    • type string | null

      The type of the Supporting Document

    • url string(uri) | null

      The absolute URL of the Supporting Document resource
POST /v2/RegulatoryCompliance/SupportingDocuments/{Sid} 
curl \
 -X POST https://numbers.twilio.com/v2/RegulatoryCompliance/SupportingDocuments/{Sid} \
 --user "username:password" \
 -H "Content-Type: application/x-www-form-urlencoded" \
 -d 'FriendlyName=string'
Request example 
{
  "FriendlyName": "string"
}
Request examples 
{
  "FriendlyName": "string"
}
Response examples (200) 
{
  "account_sid": "string",
  "date_created": "2023-05-04T09:42:00+00:00",
  "date_updated": "2023-05-04T09:42:00+00:00",
  "failure_reason": "string",
  "friendly_name": "string",
  "mime_type": "string",
  "sid": "string",
  "status": "draft",
  "type": "string",
  "url": "https://example.com"
}
Response examples (200) 
{
  "account_sid": "string",
  "date_created": "2024-05-04T09:42:00+00:00",
  "date_updated": "2024-05-04T09:42:00+00:00",
  "failure_reason": "string",
  "friendly_name": "string",
  "mime_type": "string",
  "sid": "string",
  "status": "draft",
  "type": "string",
  "url": "https://example.com"
}