Send review-site connection-request invite

Emails a tokenized review-site connection invite for a store and echoes the connect URL + token so the UI can also show copy/resend. The response reflects the real dispatch outcome (sent / queued / skipped / failed).

Auth: Both — authentication. The store is targeted by store_id OR client_location_id (resolved to a store id scoped to the caller's company), and both pass an ownership check, so the store must be in the auth user's hierarchy. Partner can invite for any store under its tree, Account only its own account's stores.

Rate limit: No rate limit.

Request

  • Body:
FieldTypeRequiredNotes
store_idintegerrequired without client_location_idMust be an existing location inside your own account tree.
client_location_idstringoptionalMax 255; resolved to store_id; an ownership check.
emailstring (email)yesValidated email:rfc,dns — recipient of the invite.
namestringnoMax 120; NameNoAngleBrackets; recipient display name in the email.

Response{ data. } envelope.

  • status (string) — always success on the happy path.
  • delivered (bool) — true when delivery status is sent or pending(queued).
  • delivery_status (string) — sent | pending | skipped | failed.
  • skip_reason (string|null) — e.g. template disabled / recipient suppressed.
  • message (string) — human summary matching the delivery status.
  • connect_url (string) — the store's connect-review-sites URL.
  • token (string) — raw hashid of [store_id, 15] for copy/resend.
  • recipient (string) — echoed email.
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
integer
string
string
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