Skip to main content

Update the caller's location

POST 
/api/v1/enduser/update-location

Sets the caller's coordinates. The IANA timezone is derived server-side from the coordinates and returned on the response — do not send a timezone.

Coordinates (0, 0) are a real location, not a deletion command. This operation does not offer a location-clear control.

The following access conditions are preserved as declared intent and are not implemented by generated code: Authorized scoped domain action.

Use this in a guide: Build an agent preferences screen

Request​

Responses​

Location updated; response carries the derived timezone

Set the authenticated end user’s location to the supplied coordinates.​

Section ID: DOC-CP-identity-access-api-updateLocation#example-end-users-updateLocation-request

Request example

{
  "latitude": 37.7749,
  "longitude": -122.4194
}

Guide request for Variant: use location for local-time context. Replace example resource identifiers with your own authorized values.​

Section ID: DOC-CP-identity-access-api-updateLocation#example-cookbook-core-platform-identity-access-end-users-05-request

Request example

{
  "latitude": 51.5072,
  "longitude": -0.1276
}

Illustrative response shape; omitted default fields and actual outcomes depend on the operation.​

Section ID: DOC-CP-identity-access-api-updateLocation#example-end-users-updateLocation-response

Response example

{
  "location": {
    "latitude": 1,
    "longitude": 1,
    "city": "example",
    "timezone": "example",
    "updatedAt": "2026-09-16T12:00:00Z"
  }
}

Illustrative response for Variant: use location for local-time context. Replace example resource identifiers with your own authorized values.​

Section ID: DOC-CP-identity-access-api-updateLocation#example-cookbook-core-platform-identity-access-end-users-json-06-response

Response example

{
  "location": {
    "latitude": 51.5072,
    "longitude": -0.1276,
    "timezone": "Europe/London",
    "updatedAt": "2026-08-14T09:31:02Z"
  }
}

Document ID: DOC-CP-identity-access-api-updateLocation. Section identities and revisions.

SectionStable reference
Update the caller's locationDOC-CP-identity-access-api-updateLocation#overview
RequestDOC-CP-identity-access-api-updateLocation#request
ResponsesDOC-CP-identity-access-api-updateLocation#responses