Sign in

v52

OpenAPI 3.1.0raw.githubusercontent.com2026-07-311,1941,9384.1 MB
Display Identity Records

Update a DIR

Edit a DIR. DIRs in draft, rejected, unsuccessful, or suspended can be edited freely: PATCH is a pure edit, status is never changed, and you re-vet by calling POST /v2/dir/{dir_id}/submit explicitly. A verified DIR can also be edited in place: a PATCH that changes any value returns the DIR to draft and branded delivery stops until you re-submit and the DIR is approved again, while a PATCH that changes nothing (an empty body or values identical to the current ones) leaves the DIR verified, so idempotent retries are safe. DIRs in any other status (submitted, in_review, expired, infringement_claimed, permanently_rejected) cannot be edited.

patch/dir/{dir_id}

Path parameters

dir_idstring uuid required
Example:16635d38-75a6-4481-82e8-69af60e05011

The DIR id. Lowercase UUID.

Request body

authorizer_emailstring email

Contact email of the authorizer. Telnyx may send verification or infringement notices here.

authorizer_namestring

Name of the person at your enterprise authorizing this DIR. Must be a real individual.

call_reasonsstring[]

1–10 reasons your business calls customers. Validate phrasing against POST /call_reasons/validate.

certify_brand_is_accurateboolean

Certification that the DIR information is accurate. Must be true for the DIR to be submitted for vetting.

certify_ip_ownershipboolean

Certification of ownership of any logos/trademarks shown. Must be true for the DIR to be submitted for vetting.

certify_no_shaft_contentboolean

Certification that this DIR is not used for SHAFT content (Sex, Hate, Alcohol, Firearms, Tobacco) where prohibited. Must be true for the DIR to be submitted for vetting.

display_namestring

Name shown to call recipients. 1–35 characters, no emoji, not whitespace-only.

logo_urlstring uri

Publicly accessible HTTPS URL (max 128 chars) to a 256x256 BMP logo (max 1 MB).

resellingboolean

Set to true if your organization places calls on behalf of other enterprises (BPO/reseller). Updating this triggers re-vetting on next submit.

Example request

{
  "certify_brand_is_accurate": true,
  "certify_ip_ownership": true,
  "certify_no_shaft_content": true,
  "documents": [
    {
      "description": "Certificate of incorporation.",
      "document_id": "2a7e8337-e803-4057-a4ae-26c40eb0bc6c",
      "document_type": "business_registration"
    }
  ]
}

Response

DIR updated.

Example response

{
  "data": {
    "authorizer_email": "sam@acmeplumbing.example.com",
    "authorizer_name": "Sam Owner",
    "call_reasons": [
      {
        "created_at": "2026-04-26T18:06:51.940749Z",
        "reason": "Appointment reminders"
      }
    ],
    "certify_brand_is_accurate": true,
    "certify_ip_ownership": true,
    "certify_no_shaft_content": true,
    "created_at": "2026-04-26T18:06:51.940749Z",
    "display_name": "Acme Plumbing",
    "documents": [
      {
        "description": "Certificate of incorporation.",
        "document_id": "2a7e8337-e803-4057-a4ae-26c40eb0bc6c",
        "document_type": "business_registration"
      }
    ],
    "enterprise_id": "4a6192a4-573d-446d-b3ce-aff9117272a6",
    "expiring_at": "2027-04-26T18:07:29.537981Z",
    "id": "16635d38-75a6-4481-82e8-69af60e05011",
    "logo_url": "https://acmeplumbing.example.com/logo-256.bmp",
    "rejection_reasons": [
      {
        "code": "documentation_incomplete",
        "detail": "Provided documents do not establish business identity.",
        "message": "Please re-upload a clearer scan of the certificate.",
        "title": "Documentation incomplete"
      }
    ],
    "submitted_at": "2026-04-26T18:07:03.716411Z",
    "updated_at": "2026-04-26T18:09:24.785211Z",
    "verified_at": "2026-04-26T18:07:29.537926Z"
  }
}