Get Campaign

GET

campaign

Copy
curl --request GET \
  --url https://api.themagicdrip.com/v1/campaign \
  --header 'x-api-key: <api-key>'

Copy
{
  "campaigns": [
    {
      "workflowId": "workflow-123",
      "userId": "user-456",
      "name": "My Campaign",
      "sequence": [
        {
          "nodeId": 1,
          "delay": 5000,
          "taskType": {
            "typeId": 1,
            "typeName": "Type A"
          },
          "taskData": {
            "note": "Optional note",
            "message": "Hello, world!"
          },
          "neighbors": [
            {
              "nodeId": 2
            }
          ]
        },
        {
          "nodeId": 2,
          "delay": 3000,
          "taskType": {
            "typeId": 2,
            "typeName": "Type B"
          },
          "taskData": {
            "altMessage": "Alternative message"
          },
          "neighbors": []
        }
      ],
      "active": true,
      "archived": false,
      "totalLeadsAdded": 100,
      "totalLeadsAccepted": 50,
      "connectionRequestCount": 20,
      "messageCount": 30,
      "profileViewCount": 40,
      "likeCount": 10,
      "followCount": 5,
      "inMailCount": 15,
      "withdrawCount": 8,
      "replyCount": 25,
      "acceptCount": 12,
      "excludeLeadsFoundInOtherWorkflows": true,
      "excludeLeadsWithNoPhoto": false,
      "createdAt": "2023-01-15T12:00:00Z",
      "updatedAt": "2023-06-30T09:30:00Z"
    }
  ]
}

Authorizations

x-api-key

string

header

required

Response

200

application/json

Campaign response

campaigns

object[]

required

List of campaigns

campaigns.workflowId

string

required

ID of the workflow

campaigns.userId

string

required

ID of the user who owns the campaign

campaigns.name

string

required

Name of the campaign

campaigns.sequence

object[]

required

List of sequences in the campaign

campaigns.active

boolean

required

Whether the campaign is active

campaigns.archived

boolean

required

Whether the campaign is archived

campaigns.totalLeadsAdded

integer

required

Total number of leads added to the campaign

campaigns.totalLeadsAccepted

integer

required

Total number of leads accepted by the campaign

campaigns.connectionRequestCount

integer

required

Count of connection requests sent

campaigns.messageCount

integer

required

Count of messages sent

campaigns.profileViewCount

integer

required

Count of profile views

campaigns.likeCount

integer

required

Count of likes received

campaigns.followCount

integer

required

Count of follows received

campaigns.inMailCount

integer

required

Count of InMail messages sent

campaigns.withdrawCount

integer

required

Count of withdraw actions

campaigns.replyCount

integer

required

Count of replies received

campaigns.acceptCount

integer

required

Count of accept actions

campaigns.excludeLeadsFoundInOtherWorkflows

boolean

required

Whether to exclude leads found in other workflows

Example:

true

campaigns.excludeLeadsWithNoPhoto

boolean

required

Whether to exclude leads with no photo. Currently this functionality is not available.

Example:

true

campaigns.excludeLeadsFirstDegreeConnection

boolean

required

Whether to exclude leads with first degree connection

Example:

true

campaigns.sendConnectionNoteAsMessageIfAlreadyConnected

boolean

required

Whether to send connection note as message if already connected

Example:

true

campaigns.waitUntilConnectionRequestAccepted

boolean

required

Whether to wait until connection request is accepted

Example:

true

campaigns.waitUntilConnectionRequestAcceptedDelay

integer

required

Delay in days (7-21) to wait until connection request is accepted

Example:

14

campaigns.createdAt

string

required

Date and time when the campaign was created

campaigns.updatedAt

string

required

Date and time when the campaign was last updated

Introduction Add Leads to Campaign

Copy
curl --request GET \
  --url https://api.themagicdrip.com/v1/campaign \
  --header 'x-api-key: <api-key>'

Copy
{
  "campaigns": [
    {
      "workflowId": "workflow-123",
      "userId": "user-456",
      "name": "My Campaign",
      "sequence": [
        {
          "nodeId": 1,
          "delay": 5000,
          "taskType": {
            "typeId": 1,
            "typeName": "Type A"
          },
          "taskData": {
            "note": "Optional note",
            "message": "Hello, world!"
          },
          "neighbors": [
            {
              "nodeId": 2
            }
          ]
        },
        {
          "nodeId": 2,
          "delay": 3000,
          "taskType": {
            "typeId": 2,
            "typeName": "Type B"
          },
          "taskData": {
            "altMessage": "Alternative message"
          },
          "neighbors": []
        }
      ],
      "active": true,
      "archived": false,
      "totalLeadsAdded": 100,
      "totalLeadsAccepted": 50,
      "connectionRequestCount": 20,
      "messageCount": 30,
      "profileViewCount": 40,
      "likeCount": 10,
      "followCount": 5,
      "inMailCount": 15,
      "withdrawCount": 8,
      "replyCount": 25,
      "acceptCount": 12,
      "excludeLeadsFoundInOtherWorkflows": true,
      "excludeLeadsWithNoPhoto": false,
      "createdAt": "2023-01-15T12:00:00Z",
      "updatedAt": "2023-06-30T09:30:00Z"
    }
  ]
}

API Documentation

Endpoints

Authorizations

Response