Skip to content

Create office

Request

This endpoint creates an office.

Security
Bearer
Path
companyIdstring, (uuid)required

Identifier for company.

Example:4974a66b-7493-4f41-908c-58ba81093947
legalEntityIdstring, (uuid)required

Identifier for legal-entity.

Example:4974a66b-7493-4f41-908c-58ba81093946
Bodyapplication/jsonrequired
addressobject(PostalAddress)

Postal Address Details

namestring
Example:"Office name"
latlngobject(Latlng)

Latitude and Longitude for a Location

externalIdstring
Example:"external-id"
taxIdstring
Example:"123232"
curl -i -X POST \
  https://api-ext-sboxmeta.partners.spotnana.com/v2/companies/4974a66b-7493-4f41-908c-58ba81093947/legal-entities/4974a66b-7493-4f41-908c-58ba81093946/offices \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "address": {
      "addressLines": [
        "Golden Gate Bridge"
      ],
      "administrativeArea": "CA",
      "administrativeAreaName": "California",
      "description": "San Francisco Home",
      "isDefault": true,
      "languageCode": "en",
      "locality": "San Francisco",
      "locationCode": "LAX",
      "organization": "Spotnana",
      "postalCode": "94130",
      "continentCode": "AF",
      "recipients": [
        "string"
      ],
      "regionCode": "US",
      "regionName": "America",
      "revision": 1,
      "sortingCode": "Jamaica",
      "sublocality": "string",
      "timezone": "America/Los_Angeles",
      "coordinates": {
        "latitude": 77.1025,
        "longitude": 28.7041
      }
    },
    "name": "Office name",
    "latlng": {
      "latitude": 77.1025,
      "longitude": 28.7041
    },
    "externalId": "external-id",
    "taxId": "123232"
  }'

Responses

Created

Bodyapplication/json
idstring, (uuid)required
Example:"b93dc51f-12dd-46c7-b7d6-1cb12cd3f5b3"
Response
{ "id": "b93dc51f-12dd-46c7-b7d6-1cb12cd3f5b3" }