campaigns

post/api/campaigns

Request

  • Base URL: https://app.heykairon.com (the document declares no server; this is the origin it was published from)
  • URL: https://app.heykairon.com/api/campaigns
  • Auth: API key in header x-api-key

Request body

namestring required

The campaign's name, for the operator to recognise it in a list. Not seen by any lead.

channelAccountIdsstring[] required

The sending seats — connected LinkedIn accounts in this org, one or more. Each new lead goes to one of them and hears from that seat for the whole sequence; every seat enrolls up to the campaign's dailyEnrollmentLimit a day, so the campaign's daily volume grows with each seat. Duplicates collapse. Get the ids from seat_list — the seats that can send right now. (identity_get's seatId names your own account even when it is not sendable, so a campaign built on it is created, publishes fine, and is then refused by campaign_activate with sender_not_connected.)

icpIdstring

The ICP to gate enrollment on. There is no default and nothing is selected for you: omitting this creates an UNGATED campaign. ASK the operator before calling, every time — never decide it for them and never leave it unasked. Show them their ICPs (icp_list) and say in one line what each answer means: gated, and only people who qualify for that ICP are contacted while everyone else on their lists is skipped and never messaged; ungated, and everyone on their lists is contacted, except the people its Enrollment Filter skips (a new campaign skips anyone your seats are already in touch with: a conversation, or an invitation, message or comment a campaign sent). "No gate" is a fine answer, but it has to be one they gave.

Changes

No recorded changes to this operation across all 6 revisions of this API.