Manage campaign membership

Each procedure changes the membership in one campaign. Choose the procedure you need.

Before you start

Complete the HTTP quickstart. Set LINKT_API_URL and LINKT_API_KEY.
Create a campaign. Set CAMPAIGN_ID to the returned id.
Use an API key with effective permissions for the reads and changes in this guide. See Permissions.
This procedure starts no research and uses no credits.

Add accounts

Find existing account IDs with search_accounts. Set ACCOUNT_ID to an ID, then send:

curl --fail-with-body --request POST "$LINKT_API_URL/v2/campaigns/$CAMPAIGN_ID/accounts" \
  --header "x-api-key: $LINKT_API_KEY" \
  --header "Content-Type: application/json" \
  --data "$(jq -cn --arg ACCOUNT_ID "$ACCOUNT_ID" '{"ids":["0190a4e2-0000-7000-8000-000000000002"]} | walk(if . == "0190a4e2-0000-7000-8000-000000000002" then $ACCOUNT_ID else . end)')"

API reference: add_accounts_to_campaign

Rules: Add.

Add people

Find existing person IDs with search_people. Set PERSON_ID to an ID, then send:

curl --fail-with-body --request POST "$LINKT_API_URL/v2/campaigns/$CAMPAIGN_ID/people" \
  --header "x-api-key: $LINKT_API_KEY" \
  --header "Content-Type: application/json" \
  --data "$(jq -cn --arg PERSON_ID "$PERSON_ID" '{"ids":["0190a4e2-0000-7000-8000-000000000003"]} | walk(if . == "0190a4e2-0000-7000-8000-000000000003" then $PERSON_ID else . end)')"

API reference: add_people_to_campaign

Rules: Add.

Remove an account

Set ACCOUNT_ID to the account ID in this campaign.

curl --fail-with-body --request DELETE "$LINKT_API_URL/v2/campaigns/$CAMPAIGN_ID/accounts/$ACCOUNT_ID" \
  --header "x-api-key: $LINKT_API_KEY"

API reference: remove_account_from_campaign

The response has status 204. Rules: Remove.

Remove a person

Set PERSON_ID to the person ID in this campaign.

curl --fail-with-body --request DELETE "$LINKT_API_URL/v2/campaigns/$CAMPAIGN_ID/people/$PERSON_ID" \
  --header "x-api-key: $LINKT_API_KEY"

API reference: remove_person_from_campaign