Campaigns

Create a campaign

Create a campaign with its steps, lead source lists and sending seats. A campaign is the campaign agent — the outreach half of a Full Cycle agent: create the list first (POST /v1/list), then the source agent that fills it with leads (POST /v1/agent), then this campaign to reach out to them. At least one list (lead source) is required. The campaign reaches out to the contacts of its lists; lists are typically filled by a source agent (the lead finder, see POST /v1/agent) or by importing contacts. If the campaign contains any LinkedIn step (invitation, invitationNote, message, voiceMessage, visitProfile, likePosts), a linkedinSeatId is required. If it contains email steps, at least one emailSeatId is required; multiple email seats (up to 100) are only allowed when the campaign has email steps exclusively. Step rules: at most one Connection Request step, an invitation cannot come after a LinkedIn message or voice message, and delayAfterLastStep must be at least 1 day (see the steps field for per-type fields and limits). When the campaign has a Connection Request step, 1st-degree connections are excluded from the campaign by default. Once activated, the campaign starts the outreach automatically on a daily basis. The launch hours can be configured in the LinkedIn seat settings.

POST

https://ext.gojiberry.ai

campaign

Create a campaign

curl --request POST \
  --url https://ext.gojiberry.ai/v1/campaign \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "Q1 Sales Campaign",
  "steps": [
    {
      "type": "invitationNote",
      "note": "Hi [FirstName], let’s connect!",
      "delayAfterLastStep": 1
    },
    {
      "type": "message",
      "messageMode": "ai",
      "delayAfterLastStep": 2
    },
    {
      "type": "email",
      "subject": "Quick question",
      "message": "Hi [FirstName], ...",
      "delayAfterLastStep": 3
    }
  ],
  "listIds": [
    1
  ],
  "linkedinSeatId": 1,
  "emailSeatIds": [
    1
  ],
  "active": true,
  "language": "en-US"
}
'

import requests

url = "https://ext.gojiberry.ai/v1/campaign"

payload = {
    "name": "Q1 Sales Campaign",
    "steps": [
        {
            "type": "invitationNote",
            "note": "Hi [FirstName], let’s connect!",
            "delayAfterLastStep": 1
        },
        {
            "type": "message",
            "messageMode": "ai",
            "delayAfterLastStep": 2
        },
        {
            "type": "email",
            "subject": "Quick question",
            "message": "Hi [FirstName], ...",
            "delayAfterLastStep": 3
        }
    ],
    "listIds": [1],
    "linkedinSeatId": 1,
    "emailSeatIds": [1],
    "active": True,
    "language": "en-US"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    name: 'Q1 Sales Campaign',
    steps: [
      {
        type: 'invitationNote',
        note: 'Hi [FirstName], let’s connect!',
        delayAfterLastStep: 1
      },
      {type: 'message', messageMode: 'ai', delayAfterLastStep: 2},
      {
        type: 'email',
        subject: 'Quick question',
        message: 'Hi [FirstName], ...',
        delayAfterLastStep: 3
      }
    ],
    listIds: [1],
    linkedinSeatId: 1,
    emailSeatIds: [1],
    active: true,
    language: 'en-US'
  })
};

fetch('https://ext.gojiberry.ai/v1/campaign', 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/campaign",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'name' => 'Q1 Sales Campaign',
    'steps' => [
        [
                'type' => 'invitationNote',
                'note' => 'Hi [FirstName], let’s connect!',
                'delayAfterLastStep' => 1
        ],
        [
                'type' => 'message',
                'messageMode' => 'ai',
                'delayAfterLastStep' => 2
        ],
        [
                'type' => 'email',
                'subject' => 'Quick question',
                'message' => 'Hi [FirstName], ...',
                'delayAfterLastStep' => 3
        ]
    ],
    'listIds' => [
        1
    ],
    'linkedinSeatId' => 1,
    'emailSeatIds' => [
        1
    ],
    'active' => true,
    'language' => 'en-US'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

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

curl_close($curl);

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

package main

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

func main() {

	url := "https://ext.gojiberry.ai/v1/campaign"

	payload := strings.NewReader("{\n  \"name\": \"Q1 Sales Campaign\",\n  \"steps\": [\n    {\n      \"type\": \"invitationNote\",\n      \"note\": \"Hi [FirstName], let’s connect!\",\n      \"delayAfterLastStep\": 1\n    },\n    {\n      \"type\": \"message\",\n      \"messageMode\": \"ai\",\n      \"delayAfterLastStep\": 2\n    },\n    {\n      \"type\": \"email\",\n      \"subject\": \"Quick question\",\n      \"message\": \"Hi [FirstName], ...\",\n      \"delayAfterLastStep\": 3\n    }\n  ],\n  \"listIds\": [\n    1\n  ],\n  \"linkedinSeatId\": 1,\n  \"emailSeatIds\": [\n    1\n  ],\n  \"active\": true,\n  \"language\": \"en-US\"\n}")

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

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://ext.gojiberry.ai/v1/campaign")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"Q1 Sales Campaign\",\n  \"steps\": [\n    {\n      \"type\": \"invitationNote\",\n      \"note\": \"Hi [FirstName], let’s connect!\",\n      \"delayAfterLastStep\": 1\n    },\n    {\n      \"type\": \"message\",\n      \"messageMode\": \"ai\",\n      \"delayAfterLastStep\": 2\n    },\n    {\n      \"type\": \"email\",\n      \"subject\": \"Quick question\",\n      \"message\": \"Hi [FirstName], ...\",\n      \"delayAfterLastStep\": 3\n    }\n  ],\n  \"listIds\": [\n    1\n  ],\n  \"linkedinSeatId\": 1,\n  \"emailSeatIds\": [\n    1\n  ],\n  \"active\": true,\n  \"language\": \"en-US\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://ext.gojiberry.ai/v1/campaign")

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"Q1 Sales Campaign\",\n  \"steps\": [\n    {\n      \"type\": \"invitationNote\",\n      \"note\": \"Hi [FirstName], let’s connect!\",\n      \"delayAfterLastStep\": 1\n    },\n    {\n      \"type\": \"message\",\n      \"messageMode\": \"ai\",\n      \"delayAfterLastStep\": 2\n    },\n    {\n      \"type\": \"email\",\n      \"subject\": \"Quick question\",\n      \"message\": \"Hi [FirstName], ...\",\n      \"delayAfterLastStep\": 3\n    }\n  ],\n  \"listIds\": [\n    1\n  ],\n  \"linkedinSeatId\": 1,\n  \"emailSeatIds\": [\n    1\n  ],\n  \"active\": true,\n  \"language\": \"en-US\"\n}"

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

{
  "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
}

Authorizations

Authorization

string

header

required

API key from Settings → API. Send it as Authorization: Bearer .

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.

Body

application/json

name

string

required

Campaign name

Example:

"Q1 Sales Campaign"

steps

object[]

required

Campaign steps, executed in order. Valid types: invitation, invitationNote, message, voiceMessage, visitProfile, likePosts, email. Ordering rules: at most one Connection Request step (invitation or invitationNote); an invitation cannot come after a message or voiceMessage step. Common fields: delayAfterLastStep in days (integer >= 1, default 2). stepNumber is assigned automatically from the array order and unknown fields are ignored. message and email steps take a messageMode: 'ai' (content is generated by AI for each contact, the default when no content is provided) or 'same' (the provided content is sent as-is, supports the [FirstName], [LastName], [Company], [JobTitle], [SenderFirstName], [SenderName], [SenderFullName] and [SenderCompany] variables; an empty value removes the tag). In 'same' mode, message is required (max 1900 chars for LinkedIn messages) and email steps also require subject. invitationNote requires note (max 180 chars, 280 with a Sales Navigator seat); voiceMessage requires url to the audio file; likePosts accepts numberOfPosts (1-3, default 1); visitProfile and invitation need no extra fields.

Example:

[
  {
    "type": "invitationNote",
    "note": "Hi [FirstName], let’s connect!",
    "delayAfterLastStep": 1
  },
  {
    "type": "message",
    "messageMode": "ai",
    "delayAfterLastStep": 2
  },
  {
    "type": "email",
    "subject": "Quick question",
    "message": "Hi [FirstName], ...",
    "delayAfterLastStep": 3
  }
]

listIds

string[]

required

IDs of the lists used as lead source. At least one list is required.

Example:

[1]

linkedinSeatId

number

LinkedIn seat sending the LinkedIn steps. Required when the campaign contains any LinkedIn step; not allowed on email-only campaigns.

Example:

1

emailSeatIds

string[]

Email seats sending the email steps. Required when the campaign contains email steps. Multiple seats (up to 100) are only allowed on email-only campaigns. Use GET /v1/email-seat to list your email seats and their IDs.

Example:

[1]

active

boolean

default:true

Whether the campaign starts active. Once active, the campaign starts the outreach automatically on a daily basis; the launch hours can be configured in the LinkedIn seat settings.

Example:

true

language

string

Campaign language

Example:

"en-US"

Response

Campaign created

number

required

Unique identifier for the campaign

name

string

required

Name of the campaign

userId

number

required

User ID who owns this campaign

active

boolean

default:true

required

Whether the campaign is active

excludeFirstDegreeFromCampaigns

boolean

default:true

required

Exclude first degree connections from campaigns

splitLinkedinMessagesIntoConversation

boolean

default:false

required

When enabled, LinkedIn message steps may be sent as multiple shorter messages when it feels natural

isManual

boolean

default:false

required

Whether the campaign is manual

createdAt

string<date-time>

required

Creation timestamp

updatedAt

string<date-time>

required

Last update timestamp

steps

object[]

Campaign steps

skipInvitationAfterDays

number

Number of days after which a pending invitation is skipped and only email steps are sent

language

string | null

Campaign language

tone

enum<string>

Campaign tone

Available options:

professional,

direct,

conversational

goal

enum<string>

Campaign goal

Available options:

conversations,

demos

linkedinSeatId

number

LinkedIn seat ID for this campaign

⌘I

Create a campaign

curl --request POST \
  --url https://ext.gojiberry.ai/v1/campaign \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "Q1 Sales Campaign",
  "steps": [
    {
      "type": "invitationNote",
      "note": "Hi [FirstName], let’s connect!",
      "delayAfterLastStep": 1
    },
    {
      "type": "message",
      "messageMode": "ai",
      "delayAfterLastStep": 2
    },
    {
      "type": "email",
      "subject": "Quick question",
      "message": "Hi [FirstName], ...",
      "delayAfterLastStep": 3
    }
  ],
  "listIds": [
    1
  ],
  "linkedinSeatId": 1,
  "emailSeatIds": [
    1
  ],
  "active": true,
  "language": "en-US"
}
'

import requests

url = "https://ext.gojiberry.ai/v1/campaign"

payload = {
    "name": "Q1 Sales Campaign",
    "steps": [
        {
            "type": "invitationNote",
            "note": "Hi [FirstName], let’s connect!",
            "delayAfterLastStep": 1
        },
        {
            "type": "message",
            "messageMode": "ai",
            "delayAfterLastStep": 2
        },
        {
            "type": "email",
            "subject": "Quick question",
            "message": "Hi [FirstName], ...",
            "delayAfterLastStep": 3
        }
    ],
    "listIds": [1],
    "linkedinSeatId": 1,
    "emailSeatIds": [1],
    "active": True,
    "language": "en-US"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    name: 'Q1 Sales Campaign',
    steps: [
      {
        type: 'invitationNote',
        note: 'Hi [FirstName], let’s connect!',
        delayAfterLastStep: 1
      },
      {type: 'message', messageMode: 'ai', delayAfterLastStep: 2},
      {
        type: 'email',
        subject: 'Quick question',
        message: 'Hi [FirstName], ...',
        delayAfterLastStep: 3
      }
    ],
    listIds: [1],
    linkedinSeatId: 1,
    emailSeatIds: [1],
    active: true,
    language: 'en-US'
  })
};

fetch('https://ext.gojiberry.ai/v1/campaign', 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/campaign",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'name' => 'Q1 Sales Campaign',
    'steps' => [
        [
                'type' => 'invitationNote',
                'note' => 'Hi [FirstName], let’s connect!',
                'delayAfterLastStep' => 1
        ],
        [
                'type' => 'message',
                'messageMode' => 'ai',
                'delayAfterLastStep' => 2
        ],
        [
                'type' => 'email',
                'subject' => 'Quick question',
                'message' => 'Hi [FirstName], ...',
                'delayAfterLastStep' => 3
        ]
    ],
    'listIds' => [
        1
    ],
    'linkedinSeatId' => 1,
    'emailSeatIds' => [
        1
    ],
    'active' => true,
    'language' => 'en-US'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

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

curl_close($curl);

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

package main

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

func main() {

	url := "https://ext.gojiberry.ai/v1/campaign"

	payload := strings.NewReader("{\n  \"name\": \"Q1 Sales Campaign\",\n  \"steps\": [\n    {\n      \"type\": \"invitationNote\",\n      \"note\": \"Hi [FirstName], let’s connect!\",\n      \"delayAfterLastStep\": 1\n    },\n    {\n      \"type\": \"message\",\n      \"messageMode\": \"ai\",\n      \"delayAfterLastStep\": 2\n    },\n    {\n      \"type\": \"email\",\n      \"subject\": \"Quick question\",\n      \"message\": \"Hi [FirstName], ...\",\n      \"delayAfterLastStep\": 3\n    }\n  ],\n  \"listIds\": [\n    1\n  ],\n  \"linkedinSeatId\": 1,\n  \"emailSeatIds\": [\n    1\n  ],\n  \"active\": true,\n  \"language\": \"en-US\"\n}")

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

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://ext.gojiberry.ai/v1/campaign")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"Q1 Sales Campaign\",\n  \"steps\": [\n    {\n      \"type\": \"invitationNote\",\n      \"note\": \"Hi [FirstName], let’s connect!\",\n      \"delayAfterLastStep\": 1\n    },\n    {\n      \"type\": \"message\",\n      \"messageMode\": \"ai\",\n      \"delayAfterLastStep\": 2\n    },\n    {\n      \"type\": \"email\",\n      \"subject\": \"Quick question\",\n      \"message\": \"Hi [FirstName], ...\",\n      \"delayAfterLastStep\": 3\n    }\n  ],\n  \"listIds\": [\n    1\n  ],\n  \"linkedinSeatId\": 1,\n  \"emailSeatIds\": [\n    1\n  ],\n  \"active\": true,\n  \"language\": \"en-US\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://ext.gojiberry.ai/v1/campaign")

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"Q1 Sales Campaign\",\n  \"steps\": [\n    {\n      \"type\": \"invitationNote\",\n      \"note\": \"Hi [FirstName], let’s connect!\",\n      \"delayAfterLastStep\": 1\n    },\n    {\n      \"type\": \"message\",\n      \"messageMode\": \"ai\",\n      \"delayAfterLastStep\": 2\n    },\n    {\n      \"type\": \"email\",\n      \"subject\": \"Quick question\",\n      \"message\": \"Hi [FirstName], ...\",\n      \"delayAfterLastStep\": 3\n    }\n  ],\n  \"listIds\": [\n    1\n  ],\n  \"linkedinSeatId\": 1,\n  \"emailSeatIds\": [\n    1\n  ],\n  \"active\": true,\n  \"language\": \"en-US\"\n}"

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

{
  "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
}

Getting Started

API reference

Create a campaign

Authorizations

Headers

Body

Response