Update an existing Geo

Request

Updates an existing Geo resource with the input city. city can only be added once.

Security

basic_auth

Path

idstringrequired

ID of the Geo.

Bodyapplication/jsonrequired

citystring or null

Updates the Geo with the input city.

Example:"San Francisco"

curl -i -X POST \
  -u '<username>:<password>' \
  'https://docs.checkr.com/_mock/apis/openapi/geos/{id}' \
  -H 'Content-Type: application/json' \
  -d '{
    "city": "San Francisco"
  }'

Responses

Geo was successfully updated

Bodyapplication/json

idstring(ResourceId)read-only

ID of the resource.

Example:"e44aa283528e6fde7d542194"

objectstringread-only

Value:"geo"

uristring(ResourceURI)read-only

URI of the resource.

Example:"/v1/geos/e44aa283528e6fde7d542194"

created_atstring, (date-time)

Time at which the Geo was created.

Example:"2015-01-18T12:34:00Z"

namestring

Human-readable name of the Geo.

Example:"SF CA"

citystring

City for the Geo.

Example:"San Francisco"

statestring

State for the Geo.

Example:"CA"

deleted_atstring or null, (date-time)

Time at which the Geo was deleted.

Example:null

Response

{
  "id": "e44aa283528e6fde7d542194",
  "object": "geo",
  "uri": "/v1/geos/e44aa283528e6fde7d542194",
  "created_at": "2015-01-18T12:34:00Z",
  "name": "SF CA",
  "city": "San Francisco",
  "state": "CA",
  "deleted_at": null
}