Skip to main content

Update a document

PATCH 
/documents/:id

Update a document.

Request ​

Path Parameters

    id uuidrequired

    Identifies the resource.

Body

required

    filename string

    The filename of the document.

    customer_reference string

    Optional reference string for customer tracking.

Responses ​

200: Successful response

Schema

    data

    object

    id uuid

    Identifies the resource.

    record_type string

    Identifies the type of the resource.

    created_at string

    ISO 8601 formatted date-time indicating when the resource was created.

    updated_at string

    ISO 8601 formatted date-time indicating when the resource was updated.

    content_type string

    The document's content_type.

    size

    object

    Indicates the document's filesize

    unit string

    Identifies the unit

    amount integer

    The number of bytes

    Indicates the document's filesize

    status string

    Possible values: [pending, verified, denied]

    Indicates the current document reviewing status

    sha256 string

    The document's SHA256 hash provided for optional verification purposes.

    filename string

    The filename of the document.

    customer_reference string

    Optional reference string for customer tracking.

default: Unexpected error

Schema

    errors

    Error[]

  • Array [

    • code intrequired
    title stringrequired
    detail string

    source

    object

    pointer json-pointer

    JSON pointer (RFC6901) to the offending entity.

    parameter string

    Indicates which query parameter caused the error.

    meta object

  • ]

Request samples

curl -L -X PATCH 'https://api.telnyx.com/v2/documents/:id' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>' \
-d '{
  "filename": "test-document.pdf",
  "customer_reference": "MY REF 001"
}'

Response samples

{
  "data": {
    "id": "6a09cdc3-8948-47f0-aa62-74ac943d6c58",
    "record_type": true,
    "created_at": "2018-02-02T22:25:27.521Z",
    "updated_at": "2018-02-02T22:25:27.521Z",
    "content_type": "application/pdf",
    "size": {
      "unit": "bytes",
      "amount": 123456
    },
    "status": "pending",
    "sha256": "08a96c641c3a74e44eb59afb61a24f2cb9f4d7188748e76ba4bb5edfa3cb7d1c",
    "filename": "test-document.pdf",
    "customer_reference": "MY REF 001"
  }
}