API Reference
Contacts
Replace and read the operational contacts attached to a store.
Returns all contacts configured for the store.
Authorization
bearerAuth AuthorizationBearer <token>
In: header
Path Parameters
externalId*string
Store identifier from your system. This is the public store key used in API paths.
Response Body
application/json
application/json
curl -X GET "https://example.com/v1/stores/store-123/contacts"{ "externalId": "string", "items": [ { "contactId": "b5ec5d98-4bee-4da1-ad24-dde86346cb1d", "contactType": "store", "name": "string", "phone": "string", "email": "user@example.com", "hasWhatsapp": true, "createdAt": "2019-08-24T14:15:22Z" } ]}{ "error": { "code": "not_configured", "message": "string", "issues": [ { "path": "string", "message": "string", "code": "string" } ] }}Replaces the full contact list for the store. Send an empty items array to clear contacts.
Authorization
bearerAuth AuthorizationBearer <token>
In: header
Path Parameters
externalId*string
Store identifier from your system. This is the public store key used in API paths.
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/json
application/json
curl -X PUT "https://example.com/v1/stores/store-123/contacts" \ -H "Content-Type: application/json" \ -d '{ "contacts": [ { "name": "string", "phone": "string" } ] }'{ "externalId": "string", "items": [ { "contactId": "b5ec5d98-4bee-4da1-ad24-dde86346cb1d", "contactType": "store", "name": "string", "phone": "string", "email": "user@example.com", "hasWhatsapp": true, "createdAt": "2019-08-24T14:15:22Z" } ]}{ "error": { "code": "not_configured", "message": "string", "issues": [ { "path": "string", "message": "string", "code": "string" } ] }}{ "error": { "code": "not_configured", "message": "string", "issues": [ { "path": "string", "message": "string", "code": "string" } ] }}