Skip to main content
POST
Export Social Selling engagers to a list

Authorizations

x-api-key
string
header
required

Headers

Idempotency-Key
string

Same as the body field idempotencyKey. Ignored when the body sends one (the body wins); an empty header counts as absent.

Required string length: 1 - 128
Pattern: ^[a-zA-Z0-9._:-]+$

Body

application/json
target
object
required

Where the contacts land: { "listName": … } (new list) or { "listId": … }.

prospectIds
integer[]

Export exactly these engagers (prospectId from the engagers lists), 1–1000. Do not combine with postId, dateFrom/dateTo or identityIds.

Required array length: 1 - 1000 elements
Example:
postId
integer

Filter: every engager of this tracked post (id from the posts list, not publishingPostId). Wins over dateFrom/dateTo.

dateFrom
string

Filter: engagers of the posts published from this day (UTC, inclusive). Required with dateTo unless postId is set.

Pattern: ^\d{4}-\d{2}-\d{2}$
Example:

"2026-09-01"

dateTo
string

Filter: engagers of the posts published until this day (UTC, inclusive).

Pattern: ^\d{4}-\d{2}-\d{2}$
Example:

"2026-09-01"

identityIds
integer[]

Filter: only engagers of these identities’ posts. Defaults to every identity the caller may see; ids outside that scope match nothing.

Required array length: 1 - 500 elements
interaction
enum<string>
default:all

Which engagers: all, only those who commented, or only those who reacted.

Available options:
all,
commented,
reacted
contacts
enum<string>
default:all

new keeps only engagers that are not contacts in Enginy yet.

Available options:
all,
new
scrapeFromLinkedIn
boolean
default:false

Enrich every exported contact with LinkedIn profile data after the export. Costs creditsPerContact credits per enriched contact; off by default.

maxCredits
number

Refuse (422 MAX_CREDITS_EXCEEDED, nothing created) when the enrichment estimate is above this many credits. Recommended with scrapeFromLinkedIn.

Required range: x >= 0
idempotencyKey
string

Optional idempotency key, unique per export (1–128 letters, digits, ., _, : or -); also accepted as the Idempotency-Key header, the body wins. Reuse it only to retry the same request: the same key with the same request returns the first export with replayed: true, starts no new export and charges nothing, and the same key with a different request answers 409 IDEMPOTENCY_KEY_REUSED. A key is bound only once its export starts: a request refused with 400, 404 or 422 does not use it up. It is then remembered while the export runs and for at least 24 hours after it finishes, and always answers with that first export whatever its outcome: use a new key to try again.

Required string length: 1 - 128
Pattern: ^[a-zA-Z0-9._:-]+$
Example:

"september-engagers-2026-10-01"

Response

Export started, contacts land in the list when it finishes; or, with replayed: true, the export this idempotencyKey started first

status
enum<string>
required
Available options:
success
message
string
required
data
object
required