Skip to main content
POST
local.place-action.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
url
string
required

The link, e.g. https://order.example.com/synthetic-pizza. It opens when someone taps the button.

type
enum<string>
required

What the link does.

Available options:
appointment,
online_appointment,
dining_reservation,
food_ordering,
food_delivery,
food_takeout,
shop_online
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

Response

The result

id
string

Pass to local.place-action.update or local.place-action.delete.

url
string

The link.

type
string

What the link does, e.g. food_ordering.