Display Identity Records

Update a DIR

Changed on

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; the currently approved identity keeps displaying, and the edited content goes live only after you re-submit and the DIR is approved again. A PATCH that changes nothing (an empty body or values identical to the current ones) leaves the DIR verified, so idempotent retries are safe. Changing only bpo_authorizations or webhook_url is the exception: the DIR stays verified. Each BPO authorization is reviewed on its own instead. DIRs in any other status (submitted, in_review, expired, infringement_claimed, permanently_rejected) cannot be edited.

patch/dir/{dir_id}

Request

  • Base URL: https://api.telnyx.com/v2
  • URL: https://api.telnyx.com/v2/dir/{dir_id}
  • Auth: HTTP bearer

Path parameters

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

The DIR id. Lowercase UUID.

Request body

display_namestring

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

resellingboolean

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

authorizer_namestring

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

authorizer_emailstring email

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

logo_urlstring uri

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

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_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.

certify_ip_ownershipboolean

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

webhook_urlstring uri nullable

Optional https:// URL that receives webhook notifications when this DIR's compliance review completes. Send null to clear. Changing only this field on a verified DIR does not re-vet it. Maximum 2048 characters.

Example request

{
  "certify_brand_is_accurate": true,
  "certify_no_shaft_content": true,
  "certify_ip_ownership": true,
  "documents": [
    {
      "document_id": "2a7e8337-e803-4057-a4ae-26c40eb0bc6c",
      "document_type": "business_registration",
      "description": "Certificate of incorporation."
    }
  ],
  "webhook_url": "https://mapleridge.example.com/webhooks/branded-calling",
  "bpo_authorizations": [
    {
      "bpo_enterprise_id": "4a6192a4-573d-446d-b3ce-aff9117272a6",
      "loa_document_id": "2a7e8337-e803-4057-a4ae-26c40eb0bc6c"
    }
  ]
}

Response

DIR updated.

Example response

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

Changes

  • 3f89a75a499fRevision changes
    • warning

      added the new bank_reference_letter enum value to the /// response property for the response status

    • warning

      added the new business_credit_report enum value to the /// response property for the response status

    • warning

      added the new certificate_of_good_standing enum value to the /// response property for the response status

    • info

      added the new bank_reference_letter enum value to the request property //

    • info

      added the new business_credit_report enum value to the request property //

    • info

      added the new certificate_of_good_standing enum value to the request property //

  • 27a8076ac294Revision changes
    • warning

      added the new delete_requested enum value to the / response property for the response status

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status