Follow
Follows the store for the signed-in customer.
Authorization
clientKey customerToken The connection's key (Dashboard → Channels → Headless API; keys are also listed in Settings → Connections). pk_… public keys are for browser code and only work from a website listed on the connection (a website connection never accepts *; a development connection on a dev store also allows localhost); sk_… private keys are for servers and native apps and need no Origin.
In: header
The customer access credential from any sign-in session answer (access_token). Account operations only — send as Authorization: Bearer <access_token> ALONGSIDE X-Client-Key. It is bound to one store: a credential issued for another vendor answers 403 here.
In: header
Header Parameters
Your connection's key (Dashboard → Channels → Headless API; keys are also listed in Settings → Connections). pk_… public keys are for browser code and only work from a website listed on the connection (a website connection never accepts *; a development connection on a dev store also allows localhost); sk_… private keys are for servers and native apps and need no Origin.
Your own correlation id (8–128 chars, ^[A-Za-z0-9_.:-]+$). Echoed back on the response and on every log line of the request; one is generated when you omit it.
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Follow the store. contact_opt_in is optional and defaults to false: the shopper's name, email and phone are shared
with the store only when it is true. Any other field, including the older share_contact that earlier storefronts
sent pre-ticked, is ignored and shares nothing.
Response Body
application/json
application/json
application/json
application/json
application/json
application/json
curl -X POST "https://example.com/store/follow" \ -H "X-Client-Key: {{clientKey}}" \ -H "Content-Type: application/json" \ -d '{ "contact_opt_in": false }'{ "status": "success", "message": "Following", "data": { "following": true, "shared_contact": false, "followers_count": 1204 }}Unfollows the store for the signed-in customer.
Authorization
clientKey customerToken The connection's key (Dashboard → Channels → Headless API; keys are also listed in Settings → Connections). pk_… public keys are for browser code and only work from a website listed on the connection (a website connection never accepts *; a development connection on a dev store also allows localhost); sk_… private keys are for servers and native apps and need no Origin.
In: header
The customer access credential from any sign-in session answer (access_token). Account operations only — send as Authorization: Bearer <access_token> ALONGSIDE X-Client-Key. It is bound to one store: a credential issued for another vendor answers 403 here.
In: header
Header Parameters
Your connection's key (Dashboard → Channels → Headless API; keys are also listed in Settings → Connections). pk_… public keys are for browser code and only work from a website listed on the connection (a website connection never accepts *; a development connection on a dev store also allows localhost); sk_… private keys are for servers and native apps and need no Origin.
Your own correlation id (8–128 chars, ^[A-Za-z0-9_.:-]+$). Echoed back on the response and on every log line of the request; one is generated when you omit it.
Response Body
application/json
application/json
application/json
application/json
curl -X DELETE "https://example.com/store/follow" \ -H "X-Client-Key: {{clientKey}}"{ "status": "success", "message": "Unfollowed", "data": { "following": false, "followers_count": 1203 }}Whether the signed-in customer follows this store.
Authorization
clientKey customerToken The connection's key (Dashboard → Channels → Headless API; keys are also listed in Settings → Connections). pk_… public keys are for browser code and only work from a website listed on the connection (a website connection never accepts *; a development connection on a dev store also allows localhost); sk_… private keys are for servers and native apps and need no Origin.
In: header
The customer access credential from any sign-in session answer (access_token). Account operations only — send as Authorization: Bearer <access_token> ALONGSIDE X-Client-Key. It is bound to one store: a credential issued for another vendor answers 403 here.
In: header
Header Parameters
Your connection's key (Dashboard → Channels → Headless API; keys are also listed in Settings → Connections). pk_… public keys are for browser code and only work from a website listed on the connection (a website connection never accepts *; a development connection on a dev store also allows localhost); sk_… private keys are for servers and native apps and need no Origin.
Your own correlation id (8–128 chars, ^[A-Za-z0-9_.:-]+$). Echoed back on the response and on every log line of the request; one is generated when you omit it.
Response Body
application/json
application/json
application/json
application/json
application/json
curl -X GET "https://example.com/store/follow/status" \ -H "X-Client-Key: {{clientKey}}"{ "status": "success", "message": "Follow status", "data": { "following": true, "shared_contact": false, "followers_count": 1204 }}