Start a subscriber sync
- Path
/subscribers/sync- Auth
- Secret key · server only
const url = 'https://releva.ai/api/v0/subscribers/sync';const options = {method: 'POST', headers: {Authorization: 'Bearer <token>'}};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request POST \ --url https://releva.ai/api/v0/subscribers/sync \ --header 'Authorization: Bearer <token>'Queues a pull of your shop’s subscriber list from the Subscriber Sync API URL configured for the domain
(Settings › Messaging › General, field Subscriber Sync API). A request already queued is not duplicated. No request body.
Releva then calls GET {url}?page=<n>[&cursor=<c>] with authorization and x-rlv-authorization
headers and upserts each subscriber it receives. If no URL is configured, nothing happens.
Authorizations
Section titled “Authorizations”Responses
Section titled “Responses”Accepted for asynchronous processing.
object
Example
{}Authorization header missing, malformed, not a UUID, or unknown.
object
Human-readable error. Several validation errors are joined with a space.
Examples
{ "message": "Authorization header is missing."}{ "message": "Authorization header is malformed. It should look like `Bearer <string>`."}{ "message": "Authorization header contains an invalid Bearer token."}{ "message": "Domain with the provided secret key cannot be found."}The domain is disabled.
object
Human-readable error. Several validation errors are joined with a space.
Example
{ "message": "Domain is disabled. Please reach out to support@releva.ai to enable it."}Unexpected server error.
object
Human-readable error. Several validation errors are joined with a space.
Example
{ "message": "An internal error occurred."}