Skip to main content
POST
local.media.create

Authorizations

Authorization
string
header
required

API key: sk_live_…

Headers

Idempotency-Key
string
required

Required: this capability has an external effect.

Maximum string length: 255
Pramaan-Max-Price-Micro
string

Optional. The most this request may be priced at, in micro-USD (a whole number above 0). It replaces the capability's own price ceiling for this request, lower or higher. Sources that could cost more are left out; when none is left the answer is 400 with the lowest limit that would work.

Pattern: ^[1-9]\d{0,14}$

Body

application/json
sourceUrl
string
required

Publicly reachable image URL the listing copies it from, e.g. https://example.com/photos/interior.jpg.

accountId
string

The connected business account, from local.locations.list. Optional when only one is connected.

Required string length: 1 - 256
locationId
string

A location id from local.locations.list. Omit to use the selected location.

Required string length: 1 - 256
description
string

Caption.

Required string length: 1 - 750
category
enum<string>

Where the photo appears on the listing.

Available options:
cover,
profile,
logo,
exterior,
interior,
product,
food_and_drink,
menu,
common_area,
rooms,
teams,
at_work,
additional
format
enum<string>

photo (default) or video.

Available options:
photo,
video

Response

The result

id
string

Pass to local.media.delete.

url
string

Where the media can be viewed.

format
enum<string>

photo or video.

Available options:
photo,
video