Connectors › Instantly

Instantly add to campaign

Add a person to an Instantly campaign, named by its id; preflights the campaign and attests each lead by re-reading it.

Use it

Install it from the registry. The command downloads the build for your platform and refuses it unless its checksum matches the one the index pins.

gtme adapters add instantly/add-to-campaign

It prints the credentials the adapter will ask for, then pins the gtme release it installed. Then, in a pipeline file:

steps:
  - id: add-to-campaign
    use: instantly/add-to-campaign
    with:
      campaign: CAMPAIGN

Replace the placeholder:

• CAMPAIGN: the campaign's id, a lowercase UUID (in the campaign's URL in Instantly), never its name: the id is the dedupe scope, so a renamed campaign stays the same destination (ADR-062). Preflight prints the name.

gtme plan pipeline.yaml checks the credential is set and that every field this step needs is provided by a step before it, without calling anyone.

Needs

Whatever fields the step's uses: line names. The runner checks them at plan time.

Provides

Nothing. A deliver step writes to the target and records a receipt.

Config

On this page, connector means what gtme calls an adapter. This one is a process adapter from the registry, prebuilt for your platform. Two adapter tiers explains the difference.