---
title: "Update request-owned identity before or after a failed local step"
method: PATCH
path: "/v2/number-requests/{request_id}"
tags: ["number-requests-v2"]
---

# Update request-owned identity before or after a failed local step

`PATCH /v2/number-requests/{request_id}`

## Request

- Base URL: `https://api.tracklysms.com/api`
- URL: `https://api.tracklysms.com/api/v2/number-requests/{request_id}`
- Auth: API key in header `X-Api-Key`

Edit draft facts, or correct inactive campaign/support fields on the same provider-backed request. Provider brand identity changes require administrator reconciliation; agent drafts use owner revision routes.

## Request body

- NumberRequestUpdate
  - `addressCity` string: City
  - `addressCountry` string: ISO 3166-1 alpha-2 business country; changing it clears a stale implicit identifier type
  - `addressPostalCode` string: Postal code
  - `addressState` string: State/province
  - `addressStreet` string: Street
  - `brandName` string: Brand name
  - `businessContactEmail` string: Authorized representative email, independent of public support
  - `businessContactFirstName` string: Authorized brand contact first name
  - `businessContactLastName` string: Authorized brand contact last name
  - `businessDescription` string: Business description
  - `companyLegalName` string: Registered legal entity name
  - `contactEmail` string: Brand contact email
  - `contactPhone` string: Brand support phone
  - `estimatedMonthlyVolume` string: Estimated monthly segment volume
  - `exampleSmsMessage` string: Example messages, one per line; 10DLC sends your first four plus the opt-out confirmation sample, each 20 to 320 characters
  - `identifierType` string: Country-scoped carrier identifier type; omit for a single-option address country
  - `industry` string: Industry
  - `listName` string: Sending list name
  - `messagingType` string: Messaging use case
  - `optInFormUrl` string: Public customer-hosted opt-in URL
  - `phoneNumberType` string: Current immutable number type; a different value is rejected
  - `privacyPolicyUrl` string: Privacy policy URL
  - `promotionSummary` string: Messaging program summary
  - `targetCountries` string[]: Exactly one ISO 3166-1 alpha-2 target country
  - `taxId` string: Carrier registration identifier value
  - `termsConditionsUrl` string: Terms & Conditions URL
  - `vertical` string: TCR business vertical
  - `websiteUrl` string: Business website URL

## Response `200`

Updated

- NumberRequestResponse
  - `request` PublicNumberRequest, required
    - `addressCity` string
    - `addressCountry` string
    - `addressPostalCode` string
    - `addressState` string
    - `addressStreet` string
    - `brandName` string
    - `businessContactEmail` string
    - `businessContactFirstName` string
    - `businessContactLastName` string
    - `businessVerification` object: Confirmed business identity, verification state, and readiness.
    - `campaignStage` string
    - `companyLegalName` string
    - `contactEmail` string
    - `contactPhone` string
    - `createdAt` string: ISO-8601 creation time
    - `estimatedMonthlyVolume` string
    - `id` string
    - `identifierType` string: Country-scoped carrier identifier type; the identifier value is never returned
    - `industry` string
    - `internationalAcquisitionDocuments` NumberRequestAcquisitionDocument[]
      - `contentType` string: Validated media type
      - `filename` string: Stored display filename
      - `requirementKey` string: Provider requirement key
      - `size` integer: Stored byte count
      - `uploadedAt` string: ISO-8601 upload time
    - `internationalAcquisitionFeedback` object
    - `internationalAcquisitionFormData` object
    - `internationalAcquisitionStatus` string
    - `listName` string
    - `messagingType` string
    - `optInFormUrl` string
    - `phoneNumberType` string
    - `privacyPolicyUrl` string
    - `provisionedPhoneNumber` string
    - `provisioningStatus` string
    - `rejectionReason` string
    - `status` string
    - `targetCountries` string[]
    - `termsConditionsUrl` string
    - `updatedAt` string: ISO-8601 update time
    - `vertical` string
    - `websiteUrl` string

## Other responses

- `400`: Invalid update
- `401`: Authentication error
- `403`: Sandbox mutation denied
- `404`: Not found
- `409`: Request, carrier identity, or acquisition correction is locked
- `422`: Carrier identity is invalid

---

[API](https://skmtc.dev/tracklysms/apis/trackly-sms-api.md) · [All operations](https://skmtc.dev/tracklysms/apis/trackly-sms-api/llms.txt) · [OpenAPI document](https://skmtc.dev/tracklysms/apis/trackly-sms-api/revisions/ac1ad22cb2a9?raw)
