API documentation | API docs for agents | OpenAPI 3.1

{locationId}

ark.update_location

Updates a visible location profile and address fields.

Availability: Core preview
Scopes: locations:write
ARK permissions: canEditLocation
Team visibility: Required and enforced
Idempotency-Key: Required for this write
Approval: No MCP approval on REST API-token calls
Rate limit: API credential and organization budgets

Parameters

locationIdpathstringrequired: format: uuid
Idempotency-Keyheaderstringrequired: Required for external write operations. Reuse the same key only for exact retries of the same request body.; min length: 1; max length: 200

Request body

customerIdstring | null

format: uuid

namestring

min length: 1; max length: 200

companystring | null

max length: 200

addressstring | null

max length: 500

address2string | null

max length: 500

citystring | null

max length: 200

statestring | null

max length: 20

zipstring | null

max length: 30

phonestring | null

max length: 50

emailstring | null

max length: 500

notesstring | null

max length: 5000

internalNotesstring | null

max length: 5000

latitudenumber | null

longitudenumber | null

timezoneIdstring | null

max length: 100

countrystring

one of: USA, CAN, MEX; default: "USA"

Example request

Shell

curl -X PATCH 'https://arktms.com/api/v1/locations/<locationId>' \
  -H "Authorization: Bearer $ARK_API_TOKEN" \
  -H "Idempotency-Key: <unique-key>" \
  -H "Content-Type: application/json" \
  -d '{}'

Success response

Updated location

objectstringrequired

one of: api_response

okbooleanrequired

one of: true

api_versionstringrequired

one of: 2026-05-31

request_idstringrequired

dataobjectrequired

data.idstringrequired

format: uuid

data.teamIdstring | nullrequired

format: uuid

data.namestring | nullrequired

data.notesstring | nullrequired

data.internalNotesstring | nullrequired

data.addressobjectrequired

data.customerobject | nullrequired

data.createdAtstringrequired

format: date-time

Errors

HTTP 400: Invalid request
HTTP 401: Authentication required
HTTP 403: Permission, scope, team, or entitlement denied
HTTP 404: Resource not found