Create a location

post

https://api.usestable.com/v1/locations

Creates a single location.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

Body required in the request

locationCode

string

enum

required

Identifies the location to create. Either:

A CMRA airport code (IATA-style, e.g. "ATL3") for a CMRA location, or
A 2-letter US state or territory abbreviation (e.g. "WY") for a registered agent (RA) location.

autoScan

boolean

Whether incoming mail should be auto-scanned. Defaults to true. For RA locations, only true is permitted.

metadata

object

Arbitrary key/value pairs to attach to the location. Values must be strings or numbers.

platformPrefill

object

Pre-fill data for the new location. Only allowed for CMRA locations; not allowed for RA locations.

companyId

string

UUID of an existing company. Required for RA locations. Not allowed for CMRA locations.

additionalInformation

object

Additional information required for certain RA jurisdictions (e.g. Wyoming). Only allowed for RA locations; not allowed for CMRA locations.

Headers

x-api-key

string

required

Responses

Language

Credentials

Header

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Success