Locations / Update

patch deprecatedhttps://{tenantUrl}/public-api/resources/locations/v1.0/{location}

Update a location

time	status	user agent
Retrieving recent requests…

Loading…

Path Params

location

integer

required

Body Params

name

object

Locales that have been created and are not provided on an update will be deleted. Please provide values in all locales that you wish to keep.

description

object

Locales that have been created and are not provided on an update will be deleted. Please provide values in all locales that you wish to keep.

detailed_description

object

Locales that have been created and are not provided on an update will be deleted. Please provide values in all locales that you wish to keep.

additional_description

object

Locales that have been created and are not provided on an update will be deleted. Please provide values in all locales that you wish to keep.

geoposition

object

address

object

Locales that have been created and are not provided on an update will be deleted. Please provide values in all locales that you wish to keep.

post_code

string

region

city

string

country

string

external_id

string | null

The field should have unique value

timezone

string | null

A valid timezone in the form of Area/Location, required when Allow Multiple Time Zones option is turned on in the Timezone Setting.

working_hours

object

Show Deprecated

Responses

Response body

object

integer

public_charge_points

integer

The number of the charge points in that location that are both public and active

public_charge_points_ids

array of integers

The ids of the charge points in that location that are both public and active

public_charge_points_ids

name

object

required

Locales that have been created and are not provided on an update will be deleted. Please provide values in all locales that you wish to keep.

Has additional fields

status

string

deprecated

active disabled

description

object

Locales that have been created and are not provided on an update will be deleted. Please provide values in all locales that you wish to keep.

Has additional fields

detailed_description

object

Locales that have been created and are not provided on an update will be deleted. Please provide values in all locales that you wish to keep.

Has additional fields

additional_description

object

Locales that have been created and are not provided on an update will be deleted. Please provide values in all locales that you wish to keep.

Has additional fields

geoposition

object

required

latitude

number

required

-90 to 90

longitude

number

required

-180 to 180

address

object

Locales that have been created and are not provided on an update will be deleted. Please provide values in all locales that you wish to keep.

Has additional fields

post_code

string

required

region

required

city

string

required

country

string

required

AF AX AL DZ AS AD AO AI AQ AG AR AM AW AU AT AZ BS BH BD BB BY BE BZ BJ BM BT BO BQ BA BW BV BR IO BN BG BF BI KH CM CA CV KY CF TD CL CN CX CC CO KM CG CD CK CR CI HR CU CW CY CZ DK DJ DM DO EC EG SV GQ ER EE ET FK FO FJ FI FR GF PF TF GA GM GE DE GH GI GR GL GD GP GU GT GG GN GW GY HT HM VA HN HK HU IS IN ID IR IQ IE IM IL IT JM JP JE JO KZ KE KI KP KR XK KW KG LA LV LB LS LR LY LI LT LU MO MK MG MW MY MV ML MT MH MQ MR MU YT MX FM MD MC MN ME MS MA MZ MM NA NR NP NL NC NZ NI NE NG NU NF MP NO OM PK PW PS PA PG PY PE PH PN PL PT PR QA RE RO RU RW BL SH KN LC MF PM VC WS SM ST SA SN RS SC SL SG SX SK SI SB SO ZA GS SS ES LK SD SR SJ SZ SE CH SY TW TJ TZ TH TL TG TK TO TT TN TR TM TC TV UG UA AE GB US UM UY UZ VU VE VN VG VI WF EH YE ZM ZW

external_id

string | null

The field should have unique value

timezone

string | null

A valid timezone in the form of Area/Location, required when Allow Multiple Time Zones option is turned on in the Timezone Setting.

location_image

object | null

original

string

required

URL to the original image

thumbnail

string

URL to a thumbnail image

mimeType

string

required

images

array of objects

images

object

original

string

required

URL to the original image

thumbnail

string

URL to a thumbnail image

mimeType

string

required

working_hours

object

is_always_open

boolean

required

Indicates that the location is always open for charging. If set to false, the hours field is required, otherwise it should be ignored.

stop_session_outside_working_hours

boolean | null

If a User has initiated a charging session during Working hours but it is already outside of the Working hours, the session will be terminated by the system. This is valid only for Users that are not included in one of the User Groups for which the Location is available 24/7.

hours

object | null

The times should be considered to be in the location/tenant timezone.
If a day does not have any entries, it will be treated as closed for the whole day.

always_open_for_user_group_ids

array of numbers | null

always_open_for_user_group_ids

lastUpdatedAt

date-time

ISO 8601 formatted date

422

The payload you provided is invalid

Language

Credentials

Bearer

API Token

URL


xxxxxxxxxx
1
curl --request PATCH \
2
     --url https://example.com/public-api/resources/locations/v1.0/location \
3
     --header 'accept: application/json' \
4
     --header 'content-type: application/json'

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Location and updated successfully

401Access token is missing or invalid

403You do not have permission to perform the action

404The record is not found