Create a goal completion

Mark campaign contacts as won.

This endpoint is used to mark a campaign contact as “won” using the API.

You are required to provide a way to find the contact, for example by email, ID, or nested custom data. At least property is required to identify the contact.

You can also choose to provide the goal, for example “meeting scheduled”, and we will find the contact in the most recent campaign with that goal and mark them as “won”. If you don’t provide a goal, we will select the contact in the most recent campaign.

Authorizations

Bearer API key

string

header

required

The API key used to authenticate requests, learn how to generate an API key on the Authentication page.

Path Parameters

teamId

string

required

Team ID, starting with tea_

Body

application/json

campaignContactId

string

The unique ID of the campaign contact, starting with cpc_.

contactId

string

The unique ID of the contact, starting with con_.

data

object

The data associated with the campaign contact added when using an integration.

Show child attributes

data.equals

string

The value to compare the key with.

data.path

string[]

The path to the key in the data object.

email

string

The email address of the contact.

goal

enum<string>

The goal of the campaign that was completed.

Available options:

SCHEDULE_MEETING,

CUSTOM_API_GOAL,

CLICK_LINK,

REPLY

Response

200 - application/json

campaign

object

Show child attributes

campaign.createdAt

string

The date and time the contact was created.

campaign.goal

enum<string>

The goal of the campaign.

Available options:

SCHEDULE_MEETING,

CUSTOM_API_GOAL,

CLICK_LINK,

REPLY

campaign.goalUrl

string

The URL associated with the goal of the campaign.

campaign.id

string

The unique ID of the contact, starting with con_.

campaign.name

string

The name of the campaign.

campaign.offeringDescription

string

The description of the offering associated with the campaign.

campaign.offeringName

string

The name of the offering associated with the campaign.

campaign.status

enum<string>

The status of the campaign.

Available options:

DRAFT,

RUNNING,

PAUSED,

ARCHIVED,

EXHAUSTING,

EXHAUSTED

campaign.updatedAt

string

The date and time the contact was last updated.

campaignId

string

The unique ID of the campaign the campaign contact is associated with, starting with cpg_.

contactId

string

The unique ID of the contact the campaign contact is associated with, starting with con_.

createdAt

string

The date and time the contact was added to this campaign.

data

object

The data associated with the campaign contact added when using an integration.

id

string

The unique ID of this contact in a campaign, starting with cpc_.

status

enum<string>

The status of the campaign contact.

Available options:

OPEN,

WON,

LOST

updatedAt

string

The date and time the contact was last updated in this campaign.