Contacts

Approve a lead

Accepts the lead for its campaign, like Approve in the app: readyForCampaign is set to true and it leaves the review queue (review=to_review on GET /v1/contact). Use it on review-mode campaigns (isManual=true), where leads are not contacted until approved; the campaign picks the lead up at its next launch. Approving a rejected lead also clears its rejection (rejectedAt, rejectedByUserId and the reason), so no unreject call is needed first. When the lead belongs to a review-mode campaign and a connected CRM integration is set to send every lead, the lead is also queued for sync to that CRM, unless it was already synced there. The sync runs in the background: the response does not wait for it, and a failure to queue it does not fail the approval. Approving an already-approved lead keeps it approved. To take an approved lead out of the campaign, reject it with POST /v1/contact//reject.

POST

https://ext.gojiberry.ai

contact

{id}

approve

Approve a lead

curl --request POST \
  --url https://ext.gojiberry.ai/v1/contact/{id}/approve \
  --header 'Authorization: Bearer <token>'

const options = {method: 'POST', headers: {Authorization: 'Bearer <token>'}};

fetch('https://ext.gojiberry.ai/v1/contact/{id}/approve', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://ext.gojiberry.ai/v1/contact/{id}/approve",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://ext.gojiberry.ai/v1/contact/{id}/approve"

	req, _ := http.NewRequest("POST", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://ext.gojiberry.ai/v1/contact/{id}/approve")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "id": 123,
  "firstName": "<string>",
  "lastName": "<string>",
  "fullName": "<string>",
  "bounced": false,
  "unsubscribed": false,
  "redListed": false,
  "blocked": false,
  "companyBlocked": false,
  "emailEnriched": false,
  "phoneEnriched": false,
  "enrichingEmail": false,
  "enrichingPhone": false,
  "userId": 123,
  "user": {},
  "readyForCampaign": false,
  "hasStartedCampaign": false,
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z",
  "profileBaseline": "<string>",
  "location": "<string>",
  "companyLocation": "<string>",
  "jobTitle": "<string>",
  "positionDates": "<string>",
  "company": "<string>",
  "companySize": "<string>",
  "companyUrl": "<string>",
  "website": "<string>",
  "industry": "<string>",
  "email": "<string>",
  "email_2": "<string>",
  "email_3": "<string>",
  "secondEmail": "<string>",
  "thirdEmail": "<string>",
  "phone": "<string>",
  "phone_2": "<string>",
  "phone_3": "<string>",
  "secondPhone": "<string>",
  "thirdPhone": "<string>",
  "profileId": "<string>",
  "linkedinMemberId": 123,
  "profileUrl": "<string>",
  "picture": "<string>",
  "openToWork": true,
  "skills": [
    "<string>"
  ],
  "linkedinIdentifier": "<string>",
  "note": "<string>",
  "user_note": "<string>",
  "intent": "<string>",
  "intent_scoring": 123,
  "total_scoring": 123,
  "intent_type": {},
  "intent_keyword": "<string>",
  "scoring": 123,
  "score_reasoning": "<string>",
  "fit": "qualified",
  "rejectedAt": "2023-11-07T05:31:56Z",
  "rejectedByUserId": 123,
  "rejectionReason": "<string>",
  "rejectionReasonText": "<string>",
  "legalDeletionRequestedAt": "2023-11-07T05:31:56Z",
  "deepResearchStartedAt": "2023-11-07T05:31:56Z",
  "deepResearchEndedAt": "2023-11-07T05:31:56Z",
  "email_template": {},
  "linkedin_template": "<string>",
  "personalizedMessages": [
    "<string>"
  ],
  "destinationStatus": [
    "<string>"
  ],
  "customFields": {},
  "campaignStatus": [
    "<string>"
  ],
  "signals": [
    "<string>"
  ],
  "agentId": 123,
  "agent": {
    "id": 123,
    "name": "<string>",
    "targetJobTitles": [
      "<string>"
    ],
    "targetIndustries": [
      "<string>"
    ],
    "targetCompanySizes": [
      "<string>"
    ],
    "targetLocations": [
      "<string>"
    ],
    "targetCompanyTypes": [
      "<string>"
    ],
    "agentType": "autopilot",
    "scriptInstalled": false,
    "currentCreditUsage": 0,
    "paused": false,
    "excludeServiceProviders": false,
    "skipIcpFilter": false,
    "includeOpenToWorkProfiles": false,
    "leadWaterfall": true,
    "userId": 123,
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z",
    "additionalCriteria": "<string>",
    "variables": [
      "<string>"
    ],
    "ignoredCompanies": [
      "<string>"
    ],
    "mandatoryKeywords": [
      "<string>"
    ],
    "trackingScriptId": "<string>",
    "maxCreditUsage": 200,
    "lastRun": "2023-11-07T05:31:56Z",
    "minLeadScore": 0.75,
    "listId": 123
  },
  "listId": 123,
  "list": {
    "id": 123,
    "name": "<string>",
    "userId": 123,
    "user": {},
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z",
    "campaignId": 123,
    "campaign": {
      "id": 123,
      "name": "<string>",
      "userId": 123,
      "active": true,
      "excludeFirstDegreeFromCampaigns": true,
      "splitLinkedinMessagesIntoConversation": false,
      "isManual": false,
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z",
      "steps": [
        {}
      ],
      "skipInvitationAfterDays": 123,
      "language": "<string>",
      "tone": "professional",
      "goal": "conversations",
      "linkedinSeatId": 123
    },
    "customFields": [
      "<string>"
    ]
  },
  "state": "finished"
}

Authorizations

Authorization

string

header

required

Enter API Key

Headers

x-impersonate-user-id

string

ID of an organization member to act on behalf of. The API key user must be the owner of the organization and the target user must belong to the same organization.

Path Parameters

number

required

Response

The approved contact, with readyForCampaign true and the rejection fields cleared

number

required

Unique identifier for the contact

firstName

string

required

First name of the contact

lastName

string

required

Last name of the contact

fullName

string

required

read-only

Full name (auto-generated from firstName and lastName)

bounced

boolean

default:false

required

Whether the contact email has bounced

unsubscribed

boolean

default:false

required

Whether the contact has unsubscribed from emails

redListed

boolean

default:false

required

Whether the contact is on the global GDPR red list (do-not-contact)

blocked

boolean

default:false

required

Whether the contact matches the organization people blocklist

companyBlocked

boolean

default:false

required

Set once a campaign pass skipped the contact because its company is on the organization blocklist

emailEnriched

boolean

default:false

required

Whether email has been enriched

phoneEnriched

boolean

default:false

required

Whether phone has been enriched

enrichingEmail

boolean

default:false

required

Whether an email enrichment job currently holds the billing lease

enrichingPhone

boolean

default:false

required

Whether a phone enrichment job currently holds the billing lease

userId

number

required

User ID who owns this contact

user

object

required

Associated user account

readyForCampaign

boolean

default:false

required

Whether the contact can be enrolled in the campaign. On a manual campaign (isManual=true), false with no rejectedAt means the contact is in review: the user must review and accept it before the agent adds it. A contact with rejectedAt set is rejected whatever this flag says. On an automatic campaign (isManual=false), the agent sets it to true itself when the contact is needed.

hasStartedCampaign

boolean

default:false

required

Has started campaign flag

createdAt

string<date-time>

required

Creation timestamp

updatedAt

string<date-time>

required

Last update timestamp

profileBaseline

string

Profile baseline information

location

string

Location of the contact

companyLocation

string

Location of the contact company

jobTitle

string

Job title of the contact

positionDates

string

Position dates information

company

string

Company name

companySize

string

Company size

companyUrl

string

Company URL

website

string

Website URL

industry

string

Industry

string

Primary email address

email_2

string

Secondary email address

email_3

string

Tertiary email address

secondEmail

string

Second email alias

thirdEmail

string

Third email alias

phone

string

Primary phone number

phone_2

string

Secondary phone number

phone_3

string

Tertiary phone number

secondPhone

string

Second phone alias

thirdPhone

string

Third phone alias

profileId

string

LinkedIn profile ID

linkedinMemberId

number

Numeric LinkedIn member ID decoded from the profile URN

profileUrl

string

LinkedIn profile URL

picture

string

Profile picture URL

openToWork

boolean

Open to work status

skills

string[]

Array of skills

linkedinIdentifier

string

LinkedIn identifier for the profile

note

string

Additional notes about the contact

user_note

string

User personal notes about the contact

intent

string

Intent or activity description

intent_scoring

number

AI scoring for intent relevance between 0 and 3

total_scoring

number

Total scoring (intent_scoring + scoring)

intent_type

object

Type or category of the intent

intent_keyword

string

Keyword extracted from the intent

scoring

number

AI scoring result between 0 and 1 (0 = no match, 1 = perfect match)

score_reasoning

string

Reasoning for the AI scoring result

fit

enum<string>

Contact fit classification

Available options:

qualified,

unknown,

out-of-scope

rejectedAt

string<date-time> | null

When this contact was rejected

rejectedByUserId

number | null

User who rejected this contact

rejectionReason

string | null

Stable rejection reason

rejectionReasonText

string | null

Free-text reason when Other was submitted with text

legalDeletionRequestedAt

string<date-time> | null

When we matched a deletion request this person filed through California's Delete Request and Opt-out Platform (DROP). The contact was then anonymized: name, job title, email, phone and LinkedIn profile removed, and taken out of campaigns and lists.

deepResearchStartedAt

string<date-time>

When the latest deep research started for this contact

deepResearchEndedAt

string<date-time>

When the latest deep research ended for this contact

email_template

object

Email template in JSON format with subject and body

linkedin_template

string

LinkedIn template text (deprecated)

personalizedMessages

string[]

Personalized messages for the contact

destinationStatus

string[]

Destination sync status information

customFields

object

Custom fields imported from CSV, keyed by normalized snake_case name (rendered with the custom_ prefix)

campaignStatus

string[]

Campaign status information. Useful to know what is the achieved step of the contact in the campaign — i.e. how far the contact has progressed through the campaign's sequence. The stepNumber matches the campaign's step numbers (the steps defined on the campaign), so a stepNumber of 2 means the contact has reached step 2 of that campaign.

signals

string[]

Every signal recorded for the contact, most recent first (agents and LinkedIn pools)

agentId

number

Associated agent ID

agent

object

Associated agent

Show child attributes

listId

number

Associated list ID

list

object

Associated list

Show child attributes

state

enum<string> | null

Campaign outreach state; null while the contact is waiting for or going through its campaign. See the state filter of GET /v1/contact for what each value means.

Available options:

finished,

paused,

1stnetwork,

excluded,

answered,

onhold

Approve a lead

curl --request POST \
  --url https://ext.gojiberry.ai/v1/contact/{id}/approve \
  --header 'Authorization: Bearer <token>'

const options = {method: 'POST', headers: {Authorization: 'Bearer <token>'}};

fetch('https://ext.gojiberry.ai/v1/contact/{id}/approve', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://ext.gojiberry.ai/v1/contact/{id}/approve",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://ext.gojiberry.ai/v1/contact/{id}/approve"

	req, _ := http.NewRequest("POST", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://ext.gojiberry.ai/v1/contact/{id}/approve")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "id": 123,
  "firstName": "<string>",
  "lastName": "<string>",
  "fullName": "<string>",
  "bounced": false,
  "unsubscribed": false,
  "redListed": false,
  "blocked": false,
  "companyBlocked": false,
  "emailEnriched": false,
  "phoneEnriched": false,
  "enrichingEmail": false,
  "enrichingPhone": false,
  "userId": 123,
  "user": {},
  "readyForCampaign": false,
  "hasStartedCampaign": false,
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z",
  "profileBaseline": "<string>",
  "location": "<string>",
  "companyLocation": "<string>",
  "jobTitle": "<string>",
  "positionDates": "<string>",
  "company": "<string>",
  "companySize": "<string>",
  "companyUrl": "<string>",
  "website": "<string>",
  "industry": "<string>",
  "email": "<string>",
  "email_2": "<string>",
  "email_3": "<string>",
  "secondEmail": "<string>",
  "thirdEmail": "<string>",
  "phone": "<string>",
  "phone_2": "<string>",
  "phone_3": "<string>",
  "secondPhone": "<string>",
  "thirdPhone": "<string>",
  "profileId": "<string>",
  "linkedinMemberId": 123,
  "profileUrl": "<string>",
  "picture": "<string>",
  "openToWork": true,
  "skills": [
    "<string>"
  ],
  "linkedinIdentifier": "<string>",
  "note": "<string>",
  "user_note": "<string>",
  "intent": "<string>",
  "intent_scoring": 123,
  "total_scoring": 123,
  "intent_type": {},
  "intent_keyword": "<string>",
  "scoring": 123,
  "score_reasoning": "<string>",
  "fit": "qualified",
  "rejectedAt": "2023-11-07T05:31:56Z",
  "rejectedByUserId": 123,
  "rejectionReason": "<string>",
  "rejectionReasonText": "<string>",
  "legalDeletionRequestedAt": "2023-11-07T05:31:56Z",
  "deepResearchStartedAt": "2023-11-07T05:31:56Z",
  "deepResearchEndedAt": "2023-11-07T05:31:56Z",
  "email_template": {},
  "linkedin_template": "<string>",
  "personalizedMessages": [
    "<string>"
  ],
  "destinationStatus": [
    "<string>"
  ],
  "customFields": {},
  "campaignStatus": [
    "<string>"
  ],
  "signals": [
    "<string>"
  ],
  "agentId": 123,
  "agent": {
    "id": 123,
    "name": "<string>",
    "targetJobTitles": [
      "<string>"
    ],
    "targetIndustries": [
      "<string>"
    ],
    "targetCompanySizes": [
      "<string>"
    ],
    "targetLocations": [
      "<string>"
    ],
    "targetCompanyTypes": [
      "<string>"
    ],
    "agentType": "autopilot",
    "scriptInstalled": false,
    "currentCreditUsage": 0,
    "paused": false,
    "excludeServiceProviders": false,
    "skipIcpFilter": false,
    "includeOpenToWorkProfiles": false,
    "leadWaterfall": true,
    "userId": 123,
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z",
    "additionalCriteria": "<string>",
    "variables": [
      "<string>"
    ],
    "ignoredCompanies": [
      "<string>"
    ],
    "mandatoryKeywords": [
      "<string>"
    ],
    "trackingScriptId": "<string>",
    "maxCreditUsage": 200,
    "lastRun": "2023-11-07T05:31:56Z",
    "minLeadScore": 0.75,
    "listId": 123
  },
  "listId": 123,
  "list": {
    "id": 123,
    "name": "<string>",
    "userId": 123,
    "user": {},
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z",
    "campaignId": 123,
    "campaign": {
      "id": 123,
      "name": "<string>",
      "userId": 123,
      "active": true,
      "excludeFirstDegreeFromCampaigns": true,
      "splitLinkedinMessagesIntoConversation": false,
      "isManual": false,
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z",
      "steps": [
        {}
      ],
      "skipInvitationAfterDays": 123,
      "language": "<string>",
      "tone": "professional",
      "goal": "conversations",
      "linkedinSeatId": 123
    },
    "customFields": [
      "<string>"
    ]
  },
  "state": "finished"
}

Getting Started

API reference

Approve a lead

Authorizations

Headers

Path Parameters

Response