Skip to main content
POST
blog.site.connect.token

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
platform
enum<string>
required

Which kind of blog source to connect.

Available options:
shopify,
wordpress,
webflow
siteToken
string

Site API token with site read and CMS read/write access.

Required string length: 1 - 512
shop
string

The store's myshopify.com domain, e.g. your-store.myshopify.com.

Required string length: 1 - 255
Pattern: ^[a-zA-Z0-9][a-zA-Z0-9-]*(\.[a-zA-Z0-9-]+)*$
accessToken
string

The store custom app's Admin API access token.

Required string length: 1 - 1024
siteUrl
string

HTTPS base URL of the site, including a subdirectory path when there is one.

username
string

The site login name. Create an application password first; never send the login password.

Required string length: 1 - 255
Pattern: ^[^:\r\n]+$
applicationPassword
string

The application password created for the site user. Spaces are accepted.

Required string length: 1 - 1024

Response

The result

accountId
string
required

Pass to the blog.* capabilities as accountId, and to social.account.disconnect.

platform
string
required

Lowercase platform name of the connected account.

handle
string

The store domain, or the site hostname.

displayName
string

Display name of the store or site.