getstarted.ae

Update a location

PATCHhttps://api.getstarted.ae/v1/business-entities/{id}/locations/{locationId}

Updates the location. address is replaced whole.

Path parameters

  • idstringrequired

    ID of the business entity, e.g. ent_01J9ZKC5TR8F4K.

  • locationIdstringrequired

    ID of the location, e.g. loc_01J9ZKD2XN9G5H.

Body parameters

  • typeenum

    REGISTERED_OFFICE, OPERATING_ADDRESS or MAILING_ADDRESS.

  • addressobject

    The address.

    • address.line1stringrequired

      Street address.

    • address.line2string

      Unit, floor or building.

    • address.citystringrequired

      City or town.

    • address.regionstring

      State, province or emirate.

    • address.postalCodestring

      Postal or ZIP code. Required where the country uses one.

    • address.countrystringrequired

      ISO 3166-1 alpha-2 country code.

Responses

  • 200OK. Returns the object shown in the example.
  • 400unknown_field The body contains a key the endpoint does not accept.
  • 404resource_not_found No location with that ID exists in this environment.
  • 422invalid_value A value fails type or format validation.
  • Every endpoint can also return 401 for a missing or invalid key. See Errors.
curl -X PATCH "https://api.getstarted.ae/v1/business-entities/ent_01J9ZKC5TR8F4K/locations/loc_01J9ZKD2XN9G5H" \
  -H "Authorization: Bearer $GETSTARTED_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "address": {
    "line1": "18 Robinson Road",
    "line2": "#14-02",
    "city": "Singapore",
    "region": null,
    "postalCode": "048547",
    "country": "SG"
  }
}'
Response · 200
{
  "id": "loc_01J9ZKD2XN9G5H",
  "object": "location",
  "businessEntityId": "ent_01J9ZKC5TR8F4K",
  "type": "REGISTERED_OFFICE",
  "address": {
    "line1": "18 Robinson Road",
    "line2": "#14-02",
    "city": "Singapore",
    "region": null,
    "postalCode": "048547",
    "country": "SG"
  },
  "createdAt": "2026-09-20T08:25:11Z",
  "updatedAt": "2026-09-21T10:10:00Z"
}