Correct Resource Request

import requests

response = requests.post(
    "https://api.tracklysms.com/api/v2/number-requests/665f0a1b2c3d4e5f60718293/correction",
    headers={
        "X-Api-Key": "trk_your_api_key_here",
        "Idempotency-Key": "number-request-correction-665f0a1b",
    },
    json={},
)

{
  "result": "awaiting_carrier_review",
  "request": {
    "id": "665f0a1b2c3d4e5f60718293",
    "targetCountries": ["CA"],
    "internationalAcquisitionStatus": "PENDING_REVIEW",
    "internationalAcquisitionFeedback": {},
    "status": "approved",
    "provisioningStatus": "in_progress"
  }
}

POST

number-requests

{request_id}

correction

import requests

response = requests.post(
    "https://api.tracklysms.com/api/v2/number-requests/665f0a1b2c3d4e5f60718293/correction",
    headers={
        "X-Api-Key": "trk_your_api_key_here",
        "Idempotency-Key": "number-request-correction-665f0a1b",
    },
    json={},
)

{
  "result": "awaiting_carrier_review",
  "request": {
    "id": "665f0a1b2c3d4e5f60718293",
    "targetCountries": ["CA"],
    "internationalAcquisitionStatus": "PENDING_REVIEW",
    "internationalAcquisitionFeedback": {},
    "status": "approved",
    "provisioningStatus": "in_progress"
  }
}

Submits a complete correction to the existing provider Resource Request. Correction is allowed only when the stored provider status is:

UPDATE_REQUESTED; or
UPDATE_REQUESTED_BY_INTERNAL_REVIEWER.

The NumberRequest must still have its original provider request id.

Correction PATCHes the same provider request with the full requirement array. It never resets the NumberRequest, cancels the provider request, clears its id, or creates a replacement.

Send an Idempotency-Key when retrying a correction. The key is bound to this concrete request path and payload; an exact retry replays the first successful response. See Idempotency.

Path parameters

string

required

Number request id.

Optional body

When saved requirement and document data is already complete, omit the request body or send {}. To save changes and submit them in the same operation, send any of the three fields accepted by Update International Requirements:

internationalAcquisitionFormData;
internationalAcquisitionDocuments;
internationalAcquisitionDocumentRemovedKeys.

When present, the local request-owned values are saved first and then used to build the complete provider update. Any present body must be a JSON object with Content-Type: application/json. JSON null, malformed JSON, and a body sent with another content type return 400 validation_failed.

Behavior

Before calling the provider, Trackly:

loads the live requirement schema;
preserves user-entered and provider-returned values;
prefills only exact known keys from the NumberRequest;
verifies every required field and document;
rebuilds the full {key, value} requirement array;
updates the same provider request id.

No carrier identifier value is returned or included in safe error text.

Example

import requests

response = requests.post(
    "https://api.tracklysms.com/api/v2/number-requests/665f0a1b2c3d4e5f60718293/correction",
    headers={
        "X-Api-Key": "trk_your_api_key_here",
        "Idempotency-Key": "number-request-correction-665f0a1b",
    },
    json={},
)

{
  "result": "awaiting_carrier_review",
  "request": {
    "id": "665f0a1b2c3d4e5f60718293",
    "targetCountries": ["CA"],
    "internationalAcquisitionStatus": "PENDING_REVIEW",
    "internationalAcquisitionFeedback": {},
    "status": "approved",
    "provisioningStatus": "in_progress"
  }
}

Error codes

HTTP	Code	Meaning
400	`validation_failed`	A present body is JSON `null`, malformed JSON, has the wrong content type, or is not a JSON object. An omitted body remains valid.
400	Acquisition payload errors	Optional form or document fields are invalid.
400	`carrier_identifier_not_editable`	A carrier-identifier requirement was supplied directly. Update request-owned `taxId` and `identifierType` through Update Number Request.
403	`acquisition_update_unavailable`	Provider account cannot update this Resource Request. The existing id is preserved.
403	`business_verification_required`	The account no longer has an active verified business. Complete verification before submitting the correction.
403	`sandbox_read_only`	A sandbox key attempted a correction.
404	`not_found`	Request does not belong to the API-key account.
409	`acquisition_correction_not_allowed`	Provider status is not correctable or the request has no provider id.
409	`acquisition_not_available`	Request has no dynamic acquisition path.
422	`acquisition_requirements_incomplete`	Required form values or documents are missing.
422	`tax_id_invalid`	Request-owned carrier identifier is invalid.
422	`identifier_type_required`	Multi-option address country needs a type.
422	`identifier_type_invalid`	Type does not belong to the address country.
502	`provider_request_failed`	Another provider failure was surfaced without replacement or reset.
503	`acquisition_requirements_unavailable`	Provider requirements are temporarily unavailable. Retry later.

Provider update permission cannot be proven by read-only lookup. A 403 is returned as the safe acquisition_update_unavailable capability error.

API Reference

V2 API Reference

Partner Accounts (v2)

Messages (v2)

Contacts (v2)

Lists (v2)

Number Requests (v2)

Business Profiles (v2)

Creatives (v2)

Audiences (v2)

Offers (v2)

Schedules (v2)

Revenue (v2)

Usage & Billing (v2)

Data Import (v2)

Links (v2)

Clicks (v2)

Webhooks (v2)

Phone Validation (v1)

API Reference (v1 - Deprecated)

Correct Resource Request

Path parameters

Optional body

Behavior

Example

Error codes

Next steps

Get Requirements

Get Number Request

​Path parameters

​Optional body

​Behavior

​Example

​Error codes

​Next steps

Get Requirements

Get Number Request

Path parameters

Optional body

Behavior

Example

Error codes

Next steps