Create a campaign

A campaign holds your targeting criteria and records. Creating the campaign starts no research.

Before you start

• Complete the HTTP quickstart. Set LINKT_API_URL and LINKT_API_KEY.
• Use an API key with effective campaign write access and permissions for any custom fields or recurring configuration. See Permissions.
• This procedure uses no credits.

Create the campaign

Describe the target companies and people. Supply separate account and person criteria when the two record types need different rules.

curl --fail-with-body --request POST "$LINKT_API_URL/v2/campaigns" \
  --header "x-api-key: $LINKT_API_KEY" \
  --header "Content-Type: application/json" \
  --data '{"description":"Companies that need data integration software","entity_types":["company","person"],"name":"Example campaign"}'

The response has status 201. Set CAMPAIGN_ID to its id. Keep the campaign ID for the next procedures.

Set fields and criteria

Send explicit criteria before discovery to change the research target. Read Targeting rules for description updates and separate criteria.

curl --fail-with-body --request PATCH "$LINKT_API_URL/v2/campaigns/$CAMPAIGN_ID" \
  --header "x-api-key: $LINKT_API_KEY" \
  --header "Content-Type: application/json" \
  --data '{"fields":{"account":{"add":[{"description":"Number of people on the data team.","name":"data_team_size","type":"integer"}]}}}'

Rules: Targeting and fields.

Next steps