Update a number order document

PATCH 
/number_order_documents/:number_order_document_id

Updates a number order document.

Request

Path Parameters

number_order_document_id stringrequired

The number order document ID.

application/json

Body

required

file_id string

The id of the file to associate as a number order document.

requirements_id string

Unique id for a requirement.

customer_reference string

A customer reference string for customer look ups.

Responses

200: Successful response with details about a number order document.

application/json

• Schema
• Example (from schema)

Schema

data

NumberOrderDocument

id uuid

record_type string

file_id string

The id of the file to associate as a number order document.

requirements_id string

Unique id for a requirement.

customer_reference string

A customer reference string for customer look ups.

requirement_type string

Possible values: [address_proof, identification, reg_form]

created_at datetime

An ISO 8901 datetime string denoting when the number order document was uploaded.

{
  "data": {
    "id": "387d1e31-a218-4375-8151-103f2d5e2d2c",
    "record_type": "number_order_document",
    "file_id": "1e3c5822-0362-4702-8e46-5a129f0d3976",
    "requirements_id": "36aaf27d-986b-493c-bd1b-de16af2e4292",
    "customer_reference": "MY REF 001",
    "requirement_type": "address_proof",
    "created_at": "2018-01-01T00:00:00.000000Z"
  }
}

default: Unexpected error

application/json

• Schema
• Example (from schema)

Schema

errors

Error[]

Array [

code integerrequired

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

url string

URL with additional information on the error.

]

{
  "errors": [
    {
      "code": "10007",
      "title": "Unexpected error",
      "detail": "An unexpected error occured.",
      "source": {
        "pointer": "/base",
        "parameter": "string"
      },
      "meta": {
        "url": "https://developers.telnyx.com/docs/overview/errors/10015"
      }
    }
  ]
}

Request samples

• cURL

---

curl -L -X PATCH 'https://api.telnyx.com/v2/number_order_documents/:number_order_document_id' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>' \
-d '{
  "id": "387d1e31-a218-4375-8151-103f2d5e2d2c",
  "record_type": "number_order_document",
  "file_id": "1e3c5822-0362-4702-8e46-5a129f0d3976",
  "requirements_id": "36aaf27d-986b-493c-bd1b-de16af2e4292",
  "customer_reference": "MY REF 001",
  "requirement_type": "address_proof",
  "created_at": "2018-01-01T00:00:00.000000Z"
}'

Response samples

• 200
• default

---

{
  "data": {
    "id": "387d1e31-a218-4375-8151-103f2d5e2d2c",
    "record_type": "number_order_document",
    "file_id": "1e3c5822-0362-4702-8e46-5a129f0d3976",
    "requirements_id": "36aaf27d-986b-493c-bd1b-de16af2e4292",
    "customer_reference": "MY REF 001",
    "requirement_type": "address_proof",
    "created_at": "2018-01-01T00:00:00.000000Z"
  }
}

{
  "errors": [
    {
      "code": "10007",
      "title": "Unexpected error",
      "detail": "An unexpected error occured.",
      "source": {
        "pointer": "/base",
        "parameter": "string"
      },
      "meta": {
        "url": "https://developers.telnyx.com/docs/overview/errors/10015"
      }
    }
  ]
}