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

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
returnUrl
string
required

URL the person returns to afterwards. Added to its query string: status (connected, failed or pending), platform, accountId when connected, and error (plus retry=true when trying again can fix it) when failed. Accepts a public URL, or http on localhost for a local install.

shop
string

The store's myshopify.com domain, e.g. your-store.myshopify.com (the bare your-store prefix works too). Required when platform is a store platform.

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

Response

The result

connectUrl
string
required

Send the person here to sign in on the platform and approve access.

ref
string

Reference to what this call created. Pass it as ref to social.account.connect.status.