POST
/
api
/
teams
/
{teamId}
/
campaigns
/
goal

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
headerrequired

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
goal
enum<string>

The goal of the campaign that was completed.

Available options:
SCHEDULE_MEETING,
CUSTOM_API_GOAL,
CLICK_LINK,
REPLY
email
string

The email address of the contact.

contactId
string

The unique ID of the contact, starting with con_.

campaignContactId
string

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

data
object

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

Response

200 - application/json
id
string

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

createdAt
string

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

updatedAt
string

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

status
enum<string>

The status of the campaign contact.

Available options:
OPEN,
WON,
LOST
data
object

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

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_.

campaign
object
List campaigns