Send the business owner a connection link

Email the business owner a link to your branded connection page, where they authorize response posting for the location's sites. The link is also returned to you, so you can show it in your own app or resend it. One invite covers every site on the location. Send the store_id or client_location_id, the owner's email, and optionally their name. Returns whether the email was sent, queued, skipped, or failed, plus the connect_url and token so you can deliver the link your own way. If a connection later breaks, send this again; the same page shows a Fix option.

Prerequisites: a bearer token, the location's store_id (or your client_location_id), and the owner's email address.

Authentication: Partner or Account token. The location must be inside your own account tree (a Partner token reaches any location under the partner, an Account token only its own account's locations); otherwise 422.

Rate limit: 60 requests per minute, counted per user (the token’s user).

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
integer
Defaults to 3007

The location. Required unless you send client_location_id. Must exist and be inside your account tree.

string
length ≤ 255
Defaults to docs-test-loc-001

Your own id for the location, used instead of store_id. Up to 255 characters.

string
required

Who receives the invite. Must be a valid address on a domain that accepts mail (it's checked with a DNS lookup), so test domains like example.com are rejected with 422.

string
length ≤ 120
Defaults to Jane Smith

The recipient's name, shown in the email. Up to 120 characters; no < or >.

Responses

Language
Credentials
Bearer
JWT
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json