Skip to main content
POST
local.location.update

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}$
Pramaan-Account
string

Optional. One of your account ids (GET /v1/accounts): run on that account, whatever your routing rules say. The response header X-Pramaan-Account names the account that ran.

Pramaan-End-User
string

Optional. Your own tag for your end user: a sticky: end_user rule keeps them on the account that first served them.

Maximum string length: 256
Pramaan-End-User-Group
string

Optional. Your end user's group, matched by rules with endUserGroup.

Maximum string length: 64

Body

application/json
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

New business description, up to 750 characters.

Required string length: 1 - 750
websiteUrl
string

New website, a public http or https URL.

hours
object[]

Replaces all regular opening hours. 1 to 50 periods.

Required array length: 1 - 50 elements

Response

The result

status
string
required

Always updated; a failure is an error instead.

Allowed value: "updated"
updatedFields
enum<string>[]
required

Which of description, websiteUrl and hours were changed.

Available options:
description,
websiteUrl,
hours