Integrations

Send people to a connected tool

Sends the people of one of your Argorant campaigns, or the rows of one of your exports, into a campaign in the connected tool. Send campaign_id or export_id, not both. People who bounced, unsubscribed or are on your blocklist are never sent. An export that is still being built is fine: the people go as soon as the file is ready. To send a list, export it first (POST /api/v1/lists/{list_id}/export) and send that export. Up to 100,000 people per call. The campaign in the tool is not started and no email is sent. The answer is the push; read its progress with GET /api/v1/integrations/pushes/{push_id}.

CostWhat it doesKey scopes
Free, from the Pro plan. Exports are paid when they run.Writesargorant:manage_lists
post/api/v1/integrations/{integration_id}/pushes

Request

  • Base URL: https://app.argorant.com
  • URL: https://app.argorant.com/api/v1/integrations/{integration_id}/pushes
  • Auth: HTTP bearer

Path parameters

integration_idinteger required

The connected tool's id from GET /api/v1/integrations.

Headers

Idempotency-Keystring

Any unique text up to 128 characters. A retry with the same key and the same body within 24 hours returns the first answer (with the header Idempotent-Replayed: true) instead of doing the work twice. The same key with another body answers 409 idempotency_conflict.

X-Request-Idstring

Your own id for this request, 8 to 64 letters, digits, dot, dash or underscore. Returned as X-Request-Id; one is made for you when you send none.

Request body

campaign_idstring uuid

Send the people of one of your Argorant campaigns.

export_idinteger

Send the rows of one of your exports. It may still be running.

target_campaign_idstring required

The campaign in the tool, from GET /api/v1/integrations/{integration_id}/campaigns.

resultsstring[]

For an export, which email results to send, from valid, catch_all and risky. Default valid.

only_not_contactedboolean

For a campaign, send only people who were not emailed yet. Default false.

Response

Accepted

push_idstring
toolstring
tool_namestring
integration_idstring
target_campaign_idstring
statusstring
totalinteger
sentinteger
already_thereinteger
not_acceptedinteger
messagestring
created_atstring
completed_atstring nullable

Changes

No recorded changes to this operation across all 1 revision of this API.