Update an existing Supporting Document.

POST /v1/SupportingDocuments/{Sid}
Account sid auth token

Update an existing Supporting Document.

Path parameters

  • Sid string Required

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

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

application/x-www-form-urlencoded

Body

  • FriendlyName string

    The string that you assigned to describe the resource.

  • Attributes

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

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
    • sid string | null

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

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

    • account_sid string | null

      The SID of the Account that created the Document resource.

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

    • friendly_name string | null

      The string that you assigned to describe the resource.

    • mime_type string | null

      The image type uploaded in the Supporting Document container.

    • status string

      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.

    • attributes

      The set of parameters that are the attributes of the Supporting Documents resource which are listed in the Supporting Document Types.

    • date_created string(date-time) | null

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

    • date_updated string(date-time) | null

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

    • url string(uri) | null

      The absolute URL of the Supporting Document resource.
POST /v1/SupportingDocuments/{Sid} 
curl \
 --request POST 'https://trusthub.twilio.com/v1/SupportingDocuments/{Sid}' \
 --user "username:password" \
 --header "Content-Type: application/x-www-form-urlencoded" \
 --data 'Attributes=%7B%7D&FriendlyName=friendly_name'
Request example 
{"Attributes"=>"{}", "FriendlyName"=>"friendly_name"}
Response examples (200) 
{
  "sid": "RDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
  "url": "https://trusthub.twilio.com/v1/SupportingDocuments/RDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
  "type": "customer_profile_address",
  "status": "DRAFT",
  "mime_type": null,
  "attributes": {
    "address_sids": "ADaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"
  },
  "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
  "date_created": "2021-02-11T17:23:00Z",
  "date_updated": "2021-02-11T17:23:00Z",
  "friendly_name": "friendly_name"
}