campaigns

Add CRM records (up to 100 ids per call) to a campaign; returns how many were added and why others were skipped

Add CRM records (up to 100 ids per call) to a campaign; returns how many were added and why others were skipped.

post/campaigns/{sequenceId}/people

Request

  • Base URL
    https://www.dench.com/api/v1
  • Auth
    • HTTP bearer
    • or HTTP bearer

Path parameters

sequenceIdstring required

Request body

objectNamestring required

CRM object the ids belong to, e.g. lead or people.

entryIdsstring[] required
emailFieldNamestring

Column holding the email when it is not "Email".

linkedinUrlFieldNamestring

Column holding the LinkedIn profile URL.

nameFieldNamestring
relationFieldNamestring

Follow this relation to the person record first.

relationDirection'reverse'
checkDuplicatesAcrossWorkspaceboolean

Default true: skip people active in another campaign.

Response

Successful response

addednumber required
requestednumber required
cappedAtLimitnumber nullable required

The campaign's people cap when it cut the batch short (300), else null.

duplicatesnumber required

Already in this campaign.

mergednumber required

Duplicates that gained a missing email or LinkedIn URL.

duplicatesElsewherenumber required

Active in another campaign; skipped unless checkDuplicatesAcrossWorkspace is false.

suppressednumber required
invalidnumber required
skippedNoIdentitynumber required

No usable email or LinkedIn URL on the record.

skippedSamplenumber required
skippedMissingInfonumber required

Launched campaigns only: a merge token the steps use is empty for them.

Changes

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