Skip to main content
POST
/
v1
/
subscriber_list
/
{list_id}
/
start_sync
Start Sync
curl --request POST \
  --url https://hub.suprsend.com/v1/subscriber_list/{list_id}/start_sync \
  --header 'Authorization: Bearer <token>'
{
  "list_id": "_list_id_",
  "list_name": "_list_name_",
  "list_description": "a brief of what type of users are part of this list",
  "list_type": "static_list",
  "subscribers_count": 0,
  "source": null,
  "is_readonly": false,
  "status": "draft",
  "track_user_entry": false,
  "track_user_exit": false,
  "requested_for_delete": false,
  "created_at": "2025-04-06T23:18:59.601000Z",
  "updated_at": "2025-04-06T23:18:59.601000Z",
  "version_id": "01JR6PCW8H9K3H40XZV4A5R4KQ"
}

Authorizations

​
Authorization
string
header
required

Pass as Bearer <API_KEY>. Get API Key from SuprSend dashboard Developers -> API Keys section.

Path Parameters

​
list_id
string
default:_list_id_
required

Unique identifier of the list on which the sync needs to start to create a draft version

Response

201

​
version_id
string

start sync creates a draft version of the list with version_id. Use this version to update users in the draft list.