Import Segment

Imports subscribers into a segment from a file or email list.

Path Params
integer
required

The segment ID

Body Params

Body Params

boolean
required

True if you want the segment to be cleared before the import. False if you do not want the segment to be cleared, but instead added to.

boolean

Set activeStatus to true for subscriber to be 'Active', false for 'inactive', null or empty is a 'lead'. When subscriptionAction is 'update_only' and activeStatus is null, existing subscription statuses will not be changed.

string
enum

Subscription management action: 'none' (leads only), 'create_only' (new subscriptions only), 'update_only' (existing subscriptions only), 'create_or_update' (both new and existing).

Allowed:
integer

When activeStatus is true or false, define the source campaign that is associated with the created subscriptions. A campaign effort will be created automatically.

integer

When activeStatus is true or false, define the source partner for the campaign effort.

boolean

Whether to create SMS addons for subscribers.

integer

Variable ID containing the phone number for SMS addons.

boolean

Whether to send SMS confirmation messages.

boolean

Whether to suppress funnel events during import.

file
required

CSV File

🚧

CSV File

The file sent to be imported must be a CSV file separated by commas. The first row must be the header containing the fields that are being imported. The first column must be called email and contain the importing emails.

Example

email,first_name,last_name [email protected],example,last name

Response

Language
Credentials
Bearer
JWT
URL
Response
Choose an example:
application/json