---
title: "Create address"
method: POST
path: "/public/v2/addresses"
tags: ["Addresses"]
---

# Create address

`POST /public/v2/addresses`

## Request

- Base URL: `https://starlink.com/api`
- URL: `https://starlink.com/api/public/v2/addresses`
- Auth: HTTP bearer

Required permission: Account information, Edit.

## Request body

- AddressCreateRequest
  - `addressLines` string[], required: The address lines for the address. Example: 1 Rocket Road
  - `locality` string, nullable: The town/locality of the address. Example: Hawthorne
  - `administrativeArea` string, nullable: The administrative area of the address. Example: California
  - `administrativeAreaCode` string, nullable: Deprecated field: value will be ignored. Administrative area code will be determined from latitude and longitude.
  - `region` string, nullable: The region of the address. Example: United States
  - `regionCode` string, nullable: Deprecated field: value will be ignored. Region Code will be determined from latitude and longitude.
  - `postalCode` string, nullable: The postal code of the address. Example: 90250-6844
  - `metadata` string, nullable: Optional field that can be used to store information about the address for external purposes
  - `formattedAddress` string, required: A user readable address. Example: 1 Rocket Road, Hawthorne, CA 90250-6844, US
  - `latitude` number, double, required: The required latitude of the address. Example: 33.92
  - `longitude` number, double, required: The required longitude of the address. Example: -118.32

## Response `201`

Address created

- AddressResponseServiceResponse
  - `errors` ValidationResult[], nullable
    - `memberNames` string[], nullable
    - `errorMessage` string, nullable
  - `warnings` ValidationResult[], nullable
    - `memberNames` string[], nullable
    - `errorMessage` string, nullable
  - `information` string[], nullable
  - `isValid` boolean
  - `content` AddressResponse
    - `addressReferenceId` string, uuid: Reference identifier for address. Example: 55ec6574-10d8-bd9c-1951-d4184f4ae467
    - `addressLines` string[]: The address lines for the address. Example: 1 Rocket Road
    - `locality` string, nullable: The town/locality of the address. Example: Hawthorne
    - `administrativeArea` string, nullable: The administrative area of the address. Example: California
    - `administrativeAreaCode` string: The administrative area code of the address. Example: CA
    - `region` string, nullable: The region of the address. Example: United States
    - `regionCode` string: The region code of the address. Example: US
    - `postalCode` string: The postal code of the address. Example: 90250
    - `metadata` string, nullable: Optional field that can be used to store information about the address for external purposes
    - `formattedAddress` string: A user readable address. Example: 1 Rocket Road, Hawthorne, CA 90250-6844, US
    - `latitude` number, double: The latitude of the address: Example 33.92
    - `longitude` number, double: The longitude of the address. Example: -118.32

## Other responses

- `400`: Bad Request
- `401`: Unauthorized
- `403`: Missing required permission for this endpoint or resource
- `422`: Failed to create address

---

[API](https://skmtc.dev/starlink/apis/starlink-management-api.md) - [All operations](https://skmtc.dev/starlink/apis/starlink-management-api/llms.txt) - [OpenAPI document](https://skmtc.dev/starlink/apis/starlink-management-api/revisions/dfd7014cfd6d?raw)