Skip to content

Upload location image​

POST
/locations/{locationId}/images

Uploads an image as multipart form data. The response is a text/event-stream with status events (queued, running, paused, waiting, complete, errored, or terminated); an error event may include a message. The image ID is also returned in the image-id response header. Wait for complete before using the image. A running event looks like data {"id":"opaque-image-id","status":"running"}.

Use cases

  • Add a categorized site photo or branding image for location clients.

Related endpoints

  • GET /locations/{locationId}/images — list image metadata and IDs.
  • GET /locations/{locationId}/images/{imageId}/download — retrieve a PNG rendition.

Authorizations​

bearerAuth

Generate an API token here

Type
HTTP (bearer)

Parameters​

Header Parameters

compatibility-date*

API compatibility date in YYYY-MM-DD format. Must be a date after 2025-11-01.

Type
string
Required
Example"2025-11-02"
Pattern
^\d{4}-\d{2}-\d{2}$
organization-id*

Routes the request to the organization named by this ID. The bearer token must be authorized for that organization.

Type
string
Required
Example"3b241101-e2bb-4255-8caf-4136c566a962"
Min Length
1
Max Length
40

Path Parameters

locationId*

ID returned by POST /locations or GET /locations. It scopes location updates and image operations to one site.

Type
string
Required
Example"2ABCDEFGHJKLMNPQRSTU"
Min Length
1
Max Length
40

Request Body​

application/json

Binary image content sent as the multipart file part.

Choose the label that best matches the image content:

Category Use for
CHARGER Charger hardware.
ENTRANCE The site entrance or access route.
LOCATION A general view of the site.
NETWORK Charging-network branding.
OPERATOR The site or charging-station operator.
OTHER Content that does not fit another category.
OWNER The site owner.
Valid values"CHARGER""ENTRANCE""LOCATION""NETWORK""OPERATOR""OTHER""OWNER"

Responses​

raw

application/json

Playground​

Authorization
Headers
Variables
Key
Value
Body

Samples​