Skip to main content
PUT
Set the default location

Authorizations

Authorization
string
header
required

A Searchable API key, created under Manage Account → Integrations → API Keys. Send as Authorization: Bearer sea_xxxxx. Every key carries one or more scopes (read, write, admin) and may optionally be bound to a single project — see Getting started.

Path Parameters

projectId
string<uuid>
required

The project id.

Body

application/json
country
string
required

ISO 3166-1 alpha-2 country code, e.g. US. Alone, it makes the whole country the default.

Required string length: 2
state
string

The state: alone for the whole state (e.g. California), or with city for the state the city is in (e.g. Oregon for Portland). A US code such as TX works; elsewhere write the name.

Maximum string length: 200
city
string

The city, e.g. Austin. A state's name here is taken as the state. A US city found in more than one state needs state.

Maximum string length: 200
dryRun
boolean

Preview the change without making it.

Response

The default location was changed, or would be on a dry run.

location
object
required
previousLocation
string | null
required

The previous default, as the app names it.

promptsMoved
integer
required

Tracked prompts that moved to the new place (would move, on a dry run).

promptsKeepingOwnLocation
integer
required

Tracked prompts that keep their own location.

success
boolean

Present when the change was made (not on a dry run).

dryRun
boolean

Present, true, on a dry run.

changed
boolean

false when the place already was the default. Absent on a dry run.