Skip to main content
POST
/
v3
/
profiles
/
{profile}
/
addresses
Add Profile Address
curl --request POST \
  --url https://api.{tenant}.getomneo.com/api/v3/profiles/{profile}/addresses \
  --header 'Content-Type: application/json' \
  --data '
{
  "address_line_1": "<string>",
  "city": "<string>",
  "postcode": "<string>",
  "country": "<string>",
  "address_line_2": "<string>",
  "address_line_3": "<string>",
  "company": "<string>",
  "state": "<string>",
  "notes": "<string>",
  "is_default": true,
  "external_id": "<string>",
  "meta": [
    "<string>"
  ],
  "name": "<string>",
  "phone": "<string>",
  "iso": "<string>",
  "iso_state": "<string>",
  "custom_fields": [
    {
      "namespace": "<string>",
      "handle": "<string>",
      "value": "<string>"
    }
  ]
}
'
{
  "data": {
    "id": 123,
    "address_line_1": "<string>",
    "address_line_2": "<string>",
    "address_line_3": "<string>",
    "company": "<string>",
    "latitude": 123,
    "longitude": 123,
    "city": "<string>",
    "postcode": "<string>",
    "state": "<string>",
    "country": "<string>",
    "notes": "<string>",
    "external_id": "<string>",
    "is_default": true,
    "created_at": "<string>",
    "updated_at": "<string>",
    "meta": [
      "<unknown>"
    ],
    "name": "<string>",
    "type": "<string>",
    "phone": "<string>",
    "iso": "<string>",
    "iso_state": "<string>",
    "profile_id": "<string>",
    "custom_fields": {}
  }
}

Path Parameters

​
profile
string<uuid>
required

The profile ID

Body

application/json
​
address_line_1
string
required
​
city
string
required
​
postcode
string
required
​
country
string
required
​
address_line_2
string | null
​
address_line_3
string | null
​
company
string | null
​
state
string
​
notes
string | null
​
is_default
boolean | null
​
external_id
string | null
​
meta
string[] | null
​
name
string | null
​
type
enum<string> | null
Available options:
home,
business,
billing,
holiday,
hotel,
recipient,
other
​
phone
string | null
​
iso
string | null
Required string length: 2
​
iso_state
string | null
Required string length: 1 - 3
​
custom_fields
object[]

Response

Address

​
data
Address · object
required