Skip to content
FacilydevelopersDashboard
Build with Facily
DocsREST APIsSet Tenant Address
Search the full API reference Esc to close

Set Tenant Address

Tenants · REST API reference

Get support
POST/v1/tenants/{tenant_id}/address
Set the tenant's primary mailing address. The one it replaces is kept, not primary.

Authentication

Bearer API key or Facily session, subject to permissions and facility scope.

Authentication and scope

Request example

Replace bracketed path values with real IDs from your environment. The body, where shown, is generated from the schema and uses illustrative values.

cURL
curl --request POST \
  --url 'https://api.staging.facily.ai/v1/tenants/<TENANT_ID>/address' \
  --header "Authorization: Bearer $FACILY_API_KEY" \
  --header 'Content-Type: application/json' \
  --data '{
  "city": "string",
  "state": "st",
  "street": "string",
  "zip": "string",
  "country": "US",
  "street_2": "string"
}'
An example for building your request, not an executed call. Check required fields, allowed values, and environment configuration before sending.

Parameters

tenant_idpath · stringrequired

Format: uuid

Request body

application/json · Required

citystringrequired

Min length: 1 · Max length: 100

countrystring

ISO 3166-1 alpha-2 code.

Default: "US" · Min length: 2 · Max length: 2

statestringrequired

Two-letter state or region code.

Min length: 2 · Max length: 2

streetstringrequired

Min length: 1 · Max length: 255

street_2string | null

Max length: 255

Show street_2 schema
string | null
Variant 1: string
string
Variant 2: null
null
zipstringrequired

Min length: 1 · Max length: 10

Responses

Expand a status to inspect its schema. Generated examples show structure and synthetic values.

200Successful Response
JSON · generated example
{
  "data": {
    "address_type": "string",
    "city": "string",
    "id": "00000000-0000-4000-8000-000000000001",
    "is_primary": false,
    "state": "string",
    "street": "string",
    "zip": "string",
    "country": "US",
    "latitude": "<VALUE_MATCHING_PATTERN>",
    "longitude": "<VALUE_MATCHING_PATTERN>",
    "street_2": "string",
    "verification_status": "string"
  },
  "meta": {
    "request_id": "string"
  }
}

application/json

dataAddressResponserequired
Show data schema
address_typestringrequired

What the address is used for, for example physical, billing, or mailing.

citystringrequired

City or town.

countrystring

ISO 3166-1 alpha-2 country code.

Default: "US"

idstringrequired

Unique identifier for this address.

Format: uuid

is_primarybooleanrequired

True for the address used by default when only one is needed.

latitudestring | null

Latitude in decimal degrees, where the address has been geocoded.

Pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$

Show latitude schema
string | null

Latitude in decimal degrees, where the address has been geocoded.

Variant 1: string
string
Variant 2: null
null
longitudestring | null

Longitude in decimal degrees, where the address has been geocoded.

Pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$

Show longitude schema
string | null

Longitude in decimal degrees, where the address has been geocoded.

Variant 1: string
string
Variant 2: null
null
statestringrequired

State, province, or region.

streetstringrequired

First line of the street address.

street_2string | null

Second line, for a unit, suite, or apartment number.

Show street_2 schema
string | null

Second line, for a unit, suite, or apartment number.

Variant 1: string
string
Variant 2: null
null
verification_statusstring | null

Outcome of address validation, for example verified, unverified, or corrected.

Show verification_status schema
string | null

Outcome of address validation, for example verified, unverified, or corrected.

Variant 1: string
string
Variant 2: null
null
verified_atstring | null

When the address was last validated against a postal database.

Format: date-time

Show verified_at schema
string | null

When the address was last validated against a postal database.

Variant 1: string
string
Variant 2: null
null
zipstringrequired

Postal or ZIP code.

metaMetarequired

Envelope metadata. Every response carries one.

Show meta schema
request_idstringrequired
400Validation error
JSON · generated example
{
  "error": {
    "code": "string",
    "message": "string",
    "details": {}
  },
  "meta": {
    "request_id": "string"
  }
}

application/json

errorErrorBodyrequired

The shape of error.* in an error response.

Show error schema
codestringrequired
detailsobject | null
Show details schema
object | null
Variant 1: object
object
Variant 2: null
null
messagestringrequired
metaMetarequired

Envelope metadata. Every response carries one.

Show meta schema
request_idstringrequired
401Unauthenticated
JSON · generated example
{
  "error": {
    "code": "string",
    "message": "string",
    "details": {}
  },
  "meta": {
    "request_id": "string"
  }
}

application/json

errorErrorBodyrequired

The shape of error.* in an error response.

Show error schema
codestringrequired
detailsobject | null
Show details schema
object | null
Variant 1: object
object
Variant 2: null
null
messagestringrequired
metaMetarequired

Envelope metadata. Every response carries one.

Show meta schema
request_idstringrequired
403Permission denied
JSON · generated example
{
  "error": {
    "code": "string",
    "message": "string",
    "details": {}
  },
  "meta": {
    "request_id": "string"
  }
}

application/json

errorErrorBodyrequired

The shape of error.* in an error response.

Show error schema
codestringrequired
detailsobject | null
Show details schema
object | null
Variant 1: object
object
Variant 2: null
null
messagestringrequired
metaMetarequired

Envelope metadata. Every response carries one.

Show meta schema
request_idstringrequired
404Not found
JSON · generated example
{
  "error": {
    "code": "string",
    "message": "string",
    "details": {}
  },
  "meta": {
    "request_id": "string"
  }
}

application/json

errorErrorBodyrequired

The shape of error.* in an error response.

Show error schema
codestringrequired
detailsobject | null
Show details schema
object | null
Variant 1: object
object
Variant 2: null
null
messagestringrequired
metaMetarequired

Envelope metadata. Every response carries one.

Show meta schema
request_idstringrequired
409Business logic error
JSON · generated example
{
  "error": {
    "code": "string",
    "message": "string",
    "details": {}
  },
  "meta": {
    "request_id": "string"
  }
}

application/json

errorErrorBodyrequired

The shape of error.* in an error response.

Show error schema
codestringrequired
detailsobject | null
Show details schema
object | null
Variant 1: object
object
Variant 2: null
null
messagestringrequired
metaMetarequired

Envelope metadata. Every response carries one.

Show meta schema
request_idstringrequired
503Temporary failure
JSON · generated example
{
  "error": {
    "code": "string",
    "message": "string",
    "details": {}
  },
  "meta": {
    "request_id": "string"
  }
}

application/json

errorErrorBodyrequired

The shape of error.* in an error response.

Show error schema
codestringrequired
detailsobject | null
Show details schema
object | null
Variant 1: object
object
Variant 2: null
null
messagestringrequired
metaMetarequired

Envelope metadata. Every response carries one.

Show meta schema
request_idstringrequired
Continue exploringAll tenants operations
Build something that works beautifully.

Facily API · Contract v1.200 · Reviewed October 29, 2026

Set Tenant Address | Facily Developers