Create Location

Create location

curl --request POST \
  --url https://api.wellapp.ai/v1/locations \
  --header 'Authorization: <authorization>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "type": "location",
  "attributes": {
    "address_line1": "123 Turing Way",
    "address_line2": "",
    "city": "London",
    "region": "Greater London",
    "postal_code": "E1 6AN",
    "country": "GB",
    "latitude": 37.7749,
    "longitude": -122.4194,
    "is_primary": true,
    "is_registered": true
  },
  "relationships": {
    "persons": {
      "data": [
        {
          "type": "people",
          "id": "people1"
        }
      ]
    },
    "companies": {
      "data": [
        {
          "type": "company",
          "id": "company_tenant"
        }
      ]
    },
    "workspaces": {
      "data": [
        {
          "type": "workspace",
          "id": "workspace_tenant"
        }
      ]
    }
  }
}
'

{
  "data": {
    "type": "location",
    "id": "loc1",
    "attributes": {
      "full_address": "123 Turing Way, London, Greater London, E1 6AN, GB",
      "address_line1": "123 Turing Way",
      "address_line2": "",
      "city": "London",
      "region": "Greater London",
      "postal_code": "E1 6AN",
      "country": "GB",
      "latitude": 37.7749,
      "longitude": -122.4194,
      "is_primary": true,
      "is_registered": true,
      "created_at": "2025-06-01T10:00:00Z",
      "updated_at": "2025-06-01T10:00:00Z"
    },
    "relationships": {
      "persons": {
        "data": [
          {
            "type": "people",
            "id": "people1"
          }
        ]
      },
      "companies": {
        "data": [
          {
            "type": "company",
            "id": "company_tenant"
          }
        ]
      },
      "workspaces": {
        "data": [
          {
            "type": "workspace",
            "id": "workspace_tenant"
          }
        ]
      }
    }
  },
  "included": [
    {
      "type": "people",
      "id": "people1",
      "attributes": {
        "first_name": "Alan",
        "last_name": "Turing",
        "full_name": "Alan Turing",
        "created_at": "2025-06-01T09:00:00Z",
        "updated_at": "2025-06-01T09:00:00Z"
      }
    },
    {
      "type": "company",
      "id": "company_tenant",
      "attributes": {
        "name": "Tech Innovations Ltd",
        "description": "Leading technology research company",
        "locale": "en",
        "domain_name_primary_link_url": "techinnovations.com",
        "tax_id": {
          "value": "GB123456789",
          "type": "VAT"
        },
        "registration": {
          "trade_name": "Tech Innovations",
          "registered_name": "Tech Innovations Limited"
        },
        "registration_number": {
          "business_type": "Ltd",
          "value": "12345678",
          "registry_name": "Companies House",
          "registry_country": "GB"
        },
        "created_at": "2025-05-15T08:00:00Z",
        "updated_at": "2025-05-15T08:00:00Z"
      }
    },
    {
      "type": "workspace",
      "id": "workspace_tenant",
      "attributes": {
        "name": "UK Operations Workspace",
        "description": "Workspace for UK-based operations and teams",
        "avatar_color": "#2E86AB",
        "external_workspace_id": "uk_ops_ws_001",
        "auto_extract_enabled": true,
        "created_at": "2025-05-20T10:00:00Z",
        "updated_at": "2025-05-20T10:00:00Z"
      }
    }
  ]
}

POST

locations

Create location

curl --request POST \
  --url https://api.wellapp.ai/v1/locations \
  --header 'Authorization: <authorization>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "type": "location",
  "attributes": {
    "address_line1": "123 Turing Way",
    "address_line2": "",
    "city": "London",
    "region": "Greater London",
    "postal_code": "E1 6AN",
    "country": "GB",
    "latitude": 37.7749,
    "longitude": -122.4194,
    "is_primary": true,
    "is_registered": true
  },
  "relationships": {
    "persons": {
      "data": [
        {
          "type": "people",
          "id": "people1"
        }
      ]
    },
    "companies": {
      "data": [
        {
          "type": "company",
          "id": "company_tenant"
        }
      ]
    },
    "workspaces": {
      "data": [
        {
          "type": "workspace",
          "id": "workspace_tenant"
        }
      ]
    }
  }
}
'

{
  "data": {
    "type": "location",
    "id": "loc1",
    "attributes": {
      "full_address": "123 Turing Way, London, Greater London, E1 6AN, GB",
      "address_line1": "123 Turing Way",
      "address_line2": "",
      "city": "London",
      "region": "Greater London",
      "postal_code": "E1 6AN",
      "country": "GB",
      "latitude": 37.7749,
      "longitude": -122.4194,
      "is_primary": true,
      "is_registered": true,
      "created_at": "2025-06-01T10:00:00Z",
      "updated_at": "2025-06-01T10:00:00Z"
    },
    "relationships": {
      "persons": {
        "data": [
          {
            "type": "people",
            "id": "people1"
          }
        ]
      },
      "companies": {
        "data": [
          {
            "type": "company",
            "id": "company_tenant"
          }
        ]
      },
      "workspaces": {
        "data": [
          {
            "type": "workspace",
            "id": "workspace_tenant"
          }
        ]
      }
    }
  },
  "included": [
    {
      "type": "people",
      "id": "people1",
      "attributes": {
        "first_name": "Alan",
        "last_name": "Turing",
        "full_name": "Alan Turing",
        "created_at": "2025-06-01T09:00:00Z",
        "updated_at": "2025-06-01T09:00:00Z"
      }
    },
    {
      "type": "company",
      "id": "company_tenant",
      "attributes": {
        "name": "Tech Innovations Ltd",
        "description": "Leading technology research company",
        "locale": "en",
        "domain_name_primary_link_url": "techinnovations.com",
        "tax_id": {
          "value": "GB123456789",
          "type": "VAT"
        },
        "registration": {
          "trade_name": "Tech Innovations",
          "registered_name": "Tech Innovations Limited"
        },
        "registration_number": {
          "business_type": "Ltd",
          "value": "12345678",
          "registry_name": "Companies House",
          "registry_country": "GB"
        },
        "created_at": "2025-05-15T08:00:00Z",
        "updated_at": "2025-05-15T08:00:00Z"
      }
    },
    {
      "type": "workspace",
      "id": "workspace_tenant",
      "attributes": {
        "name": "UK Operations Workspace",
        "description": "Workspace for UK-based operations and teams",
        "avatar_color": "#2E86AB",
        "external_workspace_id": "uk_ops_ws_001",
        "auto_extract_enabled": true,
        "created_at": "2025-05-20T10:00:00Z",
        "updated_at": "2025-05-20T10:00:00Z"
      }
    }
  ]
}

Headers

Authorization

string

required

Bearer token for authentication

Body

application/json

data

object

required

Show child attributes

data.type

string

required

Allowed value: "location"

data.attributes

object

required

Show child attributes

data.attributes.address_line1

string

required

Primary address line

data.attributes.country

string

required

Two-letter ISO country code (e.g., 'US', 'GB')

data.attributes.address_line2

string

Secondary address line (optional)

data.attributes.city

string

City name

data.attributes.region

string

State, province, or region

data.attributes.postal_code

string

Postal or ZIP code

data.attributes.latitude

number<float>

Geographic latitude coordinate

data.attributes.longitude

number<float>

Geographic longitude coordinate

data.attributes.is_primary

boolean

default:false

Whether this is the primary location

data.attributes.is_registered

boolean

default:false

Whether this is a registered business address

data.attributes.label

enum<string>

Email label type. See all available labels for complete list.

Available options:

work,

personal,

other,

...

data.relationships

object

Show child attributes

data.relationships.persons

object

Show child attributes

data.relationships.persons.data

object[]

Show child attributes

data.relationships.persons.data.type

enum<string>

required

Available options:

people

data.relationships.persons.data.id

string

required

UUID of an existing people or temp-id that references an people defined in the included array

data.relationships.companies

object

Show child attributes

data.relationships.companies.data

object[]

Show child attributes

data.relationships.companies.data.type

enum<string>

required

Available options:

company

data.relationships.companies.data.id

string

required

UUID of an existing companies or temp-id that references an companies defined in the included array

data.relationships.workspaces

object

Show child attributes

data.relationships.workspaces.data

object[]

Option 1
Option 2

Show child attributes

data.relationships.workspaces.data.type

enum<string>

required

Available options:

workspace

data.relationships.workspaces.data.external_workspace_id

string

required

External workspace identifier

Response

Location created successfully

data

object

Show child attributes

data.type

string

Example:

"location"

data.id

string<uuid>

data.attributes

object

Show child attributes

data.attributes.full_address

string

Complete formatted address

data.attributes.address_line1

string

Primary address line

data.attributes.address_line2

string

Secondary address line

data.attributes.city

string

City name

data.attributes.region

string

State, province, or region

data.attributes.postal_code

string

Postal or ZIP code

data.attributes.country

string

Two-letter ISO country code

data.attributes.latitude

number<float>

Geographic latitude coordinate

data.attributes.longitude

number<float>

Geographic longitude coordinate

data.attributes.is_primary

boolean

Whether this is the primary location

data.attributes.is_registered

boolean

Whether this is a registered business address

data.attributes.label

string

Custom label for the location

data.attributes.created_at

string<date-time>

Date and time when the location was created

data.attributes.updated_at

string<date-time>

Date and time when the location was last updated

data.relationships

object

Show child attributes

data.relationships.persons

object

Show child attributes

data.relationships.persons.data

object[]

Show child attributes

data.relationships.persons.data.type

enum<string>

Available options:

people

data.relationships.persons.data.id

string

Person ID

data.relationships.persons.data.attributes

object

Person attribute data

Show child attributes

data.relationships.persons.data.attributes.first_name

string

required

Person's first name

Required string length: 1 - 100

Example:

"Marie"

data.relationships.persons.data.attributes.last_name

string

required

Person's last name

Required string length: 1 - 100

Example:

"Dubois"

data.relationships.persons.data.attributes.created_at

string<date-time>

required

Person creation timestamp (UTC)

Example:

"2024-01-15T10:30:00Z"

data.relationships.persons.data.attributes.full_name

string

Auto-computed full name (first + last)

Example:

"Marie Dubois"

data.relationships.persons.data.attributes.updated_at

string<date-time> | null

Last modification timestamp (UTC)

Example:

"2024-01-16T14:20:00Z"

data.relationships.companies

object

Show child attributes

data.relationships.companies.data

object[]

Show child attributes

data.relationships.companies.data.type

enum<string>

Available options:

company

data.relationships.companies.data.id

string

Company ID

data.relationships.companies.data.attributes

object

Show child attributes

data.relationships.companies.data.attributes.description

string

data.relationships.companies.data.attributes.domain_name_primary_link_url

string<url>

The domain url from the website or email address of the company. Used as unique identifier in some cases.

Maximum string length: 500

data.relationships.companies.data.attributes.tax_id

object

Show child attributes

data.relationships.companies.data.attributes.tax_id.value

string

Tax ID issued by local or national tax authority.

data.relationships.companies.data.attributes.tax_id.type

string

Type of tax ID, useful for applying formatting and validation rules.

data.relationships.companies.data.attributes.registration

object

Show child attributes

data.relationships.companies.data.attributes.registration.trade_name

string

Commercial or branding name (if different from registered name).

data.relationships.companies.data.attributes.registration.registered_name

string

Legal company name.

Required string length: 1 - 100

data.relationships.companies.data.attributes.registration_number

object

Show child attributes

data.relationships.companies.data.attributes.registration_number.business_type

string

Legal entity structure type.

data.relationships.companies.data.attributes.registration_number.value

string

Official company registration number.

data.relationships.companies.data.attributes.registration_number.registry_name

string

Name of the official registration body.

data.relationships.companies.data.attributes.registration_number.registry_country

string

Country of the registry authority. (string (ISO 3166-1 alpha-2))

data.relationships.companies.data.attributes.workspace_id

string<uuid>

UUID of the workspace associated with this company

data.relationships.companies.data.attributes.created_at

string<date-time>

data.relationships.companies.data.attributes.updated_at

string<date-time>

data.relationships.workspaces

object

Show child attributes

data.relationships.workspaces.data

object[]

Show child attributes

data.relationships.workspaces.data.type

enum<string>

Available options:

workspace

data.relationships.workspaces.data.id

string

Workspace ID

data.relationships.workspaces.data.attributes

object

Show child attributes

data.relationships.workspaces.data.attributes.name

string

Workspace name

data.relationships.workspaces.data.attributes.desription

string

Workspace description

data.relationships.workspaces.data.attributes.external_workspace_id

string<uuid>

external workspace id

data.relationships.workspaces.data.attributes.avatar_color

string<colors>

Color of the avatar

data.relationships.workspaces.data.attributes.created_at

string<date-time>

Timestamp when the workspace was created

data.relationships.workspaces.data.attributes.updated_at

string<date-time>

Timestamp when the workspace was last updated

Delete Media Get Location

⌘I

Main Resources

Atomic Resources

System

Headers

Body

Response