Skip to content

Area: Developers

POST

Start a subscriber sync

Path
/subscribers/sync
Auth
Secret key · server only
POST
/subscribers/sync
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.

Accepted for asynchronous processing.

Media typeapplication/json
object
0

Example

{}

Authorization header missing, malformed, not a UUID, or unknown.

Media typeapplication/json
object
message
required

Human-readable error. Several validation errors are joined with a space.

string

Examples

{
"message": "Authorization header is missing."
}

The domain is disabled.

Media typeapplication/json
object
message
required

Human-readable error. Several validation errors are joined with a space.

string

Example

{
"message": "Domain is disabled. Please reach out to support@releva.ai to enable it."
}

Unexpected server error.

Media typeapplication/json
object
message
required

Human-readable error. Several validation errors are joined with a space.

string

Example

{
"message": "An internal error occurred."
}