Skip to main content
POST
Register or replace a dispatchable emergency location

Authorizations

Authorization
string
header
required

Dashboard JWT token from Clerk

Headers

Idempotency-Key
string

Stripe-style idempotency token. Pass a stable, client-generated value (1-255 chars) to dedupe retries on transient timeouts. The same key+credential+path replays the original response for 24h on 2xx (5min on 4xx, 30s on 5xx). Returns 409 if a concurrent request with the same key is already in flight; replayed responses include the Idempotency-Replay: true response header.

Required string length: 1 - 255
X-Test-Mode
enum<string>

Sandbox opt-in for Clerk-session-authenticated requests. Set to true to route the call through the test-mode pipeline: no real provider delivery, no credits deducted, response meta.test_mode: true. Ignored for live API keys (dv_live_sk_*) — server-to-server clients must use a test-prefixed key (dv_test_sk_*) to exercise sandbox. Test-prefixed keys unconditionally enable sandbox regardless of this header.

Available options:
true,
false

Path Parameters

id
string
required

Resource identifier

Minimum string length: 1

Body

application/json
address_line_1
string
required

House number + street.

Required string length: 1 - 200
city
string
required
Required string length: 1 - 120
region
string
required
Required string length: 1 - 120
postal
string
required
Required string length: 1 - 16
country
string
required

ISO-3166 alpha-2 country code; normalized to upper-case.

Pattern: ^[A-Za-z]{2}$
source
enum<string>
required

How this location was captured.

Available options:
manual,
softphone,
api
device_key
string
required

Identifier of the roaming extension / device the location belongs to — the same identifier the device registers with.

Required string length: 1 - 128
Pattern: ^[a-zA-Z0-9._-]{1,128}$
caller_name
string
Maximum string length: 120
device_label
string
Maximum string length: 120
line_2
string

Apartment / suite / floor.

Maximum string length: 200
lat
number
Required range: -90 <= x <= 90
lng
number
Required range: -180 <= x <= 180

Response

The stored dispatchable location after the write.

The stored dispatchable location after the write.

data
object
meta
object