Emelia API API Reference

Welcome the Emelia API reference. Here you can find all the different schemas you can use on Emelia. Our API is build on GraphQL. Feel free to check their docs if you're not familiar with GraphQL.

All of theses schemas are available to every users. You just have to send your API key in the headers.

API Endpoints

Endpoint::
https://graphql.emelia.io/graphql

Terms of Service: https://www.emelia.io/cgv

Contact: charles@bridgers-agency.com

Version: 1.0.0

Authentication

api_key

Provides API Key in 'Authorization' field in Header.

You can get one on your Emelia settings.

type

apiKey

name

Authorization

header

User Data

Available actions for your account

User Data

Get User Data

Get data from your user account

Example

Request Content-Types: application/json

Query

query me{
  me{
    showMailbox
    uid
    name
    email
    picture
    due_invoice
    joinedDate
  }
}

Try it now

200 OK

Successful operation

type

User

Response Content-Types: application/json

Response Example (200 OK)

{
  "data": {
    "me": {
      "showMailbox": "boolean",
      "uid": "string",
      "name": "string",
      "email": "string",
      "picture": "string",
      "due_invoice": "string",
      "joinedDate": "string"
    }
  }
}

Campaigns Action

Different actions available for a campaign

Campaigns Action

Get Campaigns

Get a basic listing of all campaigns including name, status, creation date and statistics

options:

object

(no description)

Example

Request Content-Types: application/json

Query

query all_campaigns($options: JSON){
  all_campaigns(options: $options){
    _id
    name
    status
    createdAt
    provider
    useManyProviders
    plannedStart
  }
}

Variables

{}

Try it now

200 OK

Successful operation

type

CampaignLine

Response Content-Types: application/json

Response Example (200 OK)

{
  "data": {
    "all_campaigns": [
      {
        "_id": "string",
        "name": "string",
        "createdAt": "string",
        "provider": "string",
        "useManyProviders": "boolean",
        "plannedStart": "string"
      }
    ]
  }
}

Campaigns Action

Get a campaign

Get a specific campaign by its id and get all data

id:

string

(no description)

Example

Request Content-Types: application/json

Query

query campaign($id: ID!){
  campaign(id: $id){
    _id
    name
    status
    createdAt
    schedule{
      bcc
      dailyContact
      dailyLimit
      minInterval
      maxInterval
      blacklistUnsub
      trackLinks
      trackOpens
      timeZone
      days
      start
      end
      eventToStopMails
    }
    useManyProviders
    provider
    providersUsed
    startAt
    recipients{
      processing
      total_count
    }
    estimatedEnd
    plannedStart
    lastRefreshed
  }
}

Variables

{
  "id": "string"
}

Try it now

200 OK

Successful operation

type

Campaign

Response Content-Types: application/json

Response Example (200 OK)

{
  "data": {
    "campaign": {
      "_id": "string",
      "name": "string",
      "createdAt": "string",
      "schedule": {
        "bcc": "string",
        "dailyContact": "integer",
        "dailyLimit": "integer",
        "minInterval": "integer",
        "maxInterval": "integer",
        "blacklistUnsub": "boolean",
        "trackLinks": "boolean",
        "trackOpens": "boolean",
        "timeZone": "string",
        "days": [
          "integer"
        ],
        "start": "string",
        "end": "string",
        "eventToStopMails": [
          null
        ]
      },
      "useManyProviders": "boolean",
      "provider": "string",
      "providersUsed": [
        "string"
      ],
      "startAt": "string",
      "recipients": {
        "processing": "boolean",
        "total_count": "integer"
      },
      "estimatedEnd": "string",
      "plannedStart": "string",
      "lastRefreshed": "string"
    }
  }
}

Campaigns Action

Create a campaign

Create a new campaign by providing a name

name:

string

(no description)

Example

Request Content-Types: application/json

Query

mutation createCampaign($name: String!){
  createCampaign(name: $name){
    _id
    name
    status
    createdAt
    useManyProviders
    provider
    providersUsed
    startAt
    estimatedEnd
    plannedStart
    lastRefreshed
  }
}

Variables

{
  "name": "string"
}

Try it now

200 OK

Successful operation

type

Campaign

Response Content-Types: application/json

Response Example (200 OK)

{
  "data": {
    "createCampaign": {
      "_id": "string",
      "name": "string",
      "createdAt": "string",
      "useManyProviders": "boolean",
      "provider": "string",
      "providersUsed": [
        "string"
      ],
      "startAt": "string",
      "estimatedEnd": "string",
      "plannedStart": "string",
      "lastRefreshed": "string"
    }
  }
}

Campaigns Action

Start a campaign

Start a cold-mailing campaign by providing its id. You must have a provider and contacts set.

id:

string

(no description)

Example

Request Content-Types: application/json

Query

mutation startCampaign($id: ID!){
  startCampaign(id: $id)
}

Variables

{
  "id": "string"
}

Try it now

200 OK

Successful operation

type

boolean

Response Content-Types: application/json

Response Example (200 OK)

{
  "data": {
    "startCampaign": "boolean"
  }
}

Campaigns Action

Pause a campaign

Pause a campaign with its id. The campaign must be in RUNNING mode

id:

string

(no description)

Example

Request Content-Types: application/json

Query

mutation pauseCampaign($id: ID!){
  pauseCampaign(id: $id)
}

Variables

{
  "id": "string"
}

Try it now

200 OK

Successful operation

type

boolean

Response Content-Types: application/json

Response Example (200 OK)

{
  "data": {
    "pauseCampaign": "boolean"
  }
}

Campaigns Action

Add Contact to a campaign

Add a contact to an existing campaign. If the campaign is the RUNNING, the contact is automatically added to the loop. If the campaign is in FINISHED state, the campaign will be automatically switched to RUNNING until the loop for the new contact is finished.

id:

string

(no description)

contact:

object

(no description)

Example

Request Content-Types: application/json

Query

mutation addContactToCampaignHook($id: ID!, $contact: JSON!){
  addContactToCampaignHook(id: $id, contact: $contact)
}

Variables

{
  "id": "string"
}

Try it now

200 OK

Successful operation

type

string

Response Content-Types: application/json

Response Example (200 OK)

{
  "data": {
    "addContactToCampaignHook": "string"
  }
}

Campaigns Action

Remove Contact from a Campaign

Delete a contact from an existing campaign using the email address

id:

string

(no description)

email:

string

(no description)

Example

Request Content-Types: application/json

Query

mutation removeOneContactFromCampaign($id: ID!, $email: String!){
  removeOneContactFromCampaign(id: $id, email: $email)
}

Variables

{
  "id": "string",
  "email": "string"
}

Try it now

200 OK

Successful operation

type

boolean

Response Content-Types: application/json

Response Example (200 OK)

{
  "data": {
    "removeOneContactFromCampaign": "boolean"
  }
}

Contacts Action

Different actions about contacts and contacts list on Emelia

Contacts Action

Get Contacts Lists

Return all contacts lists existants on your account

Example

Request Content-Types: application/json

Query

query contact_lists{
  contact_lists{
    _id
    name
    contactCount
    fields
    usedInCampaign
  }
}

Try it now

200 OK

Successful operation

type

ContactList

Response Content-Types: application/json

Response Example (200 OK)

{
  "data": {
    "contact_lists": [
      {
        "_id": "string",
        "name": "string",
        "contactCount": "integer",
        "fields": [
          "string"
        ],
        "usedInCampaign": "boolean"
      }
    ]
  }
}

Contacts Action

Add Contact to a List

Add a contact to an existing list. If this list is used in a campaign you must use the addContactToCampaignHook mutation instead.

id:

string

(no description)

contact:

object

(no description)

Example

Request Content-Types: application/json

Query

mutation addContactsToListHook($id: ID!, $contact: JSON!){
  addContactsToListHook(id: $id, contact: $contact)
}

Variables

{
  "id": "string"
}

Try it now

200 OK

Successful operation

type

string

Response Content-Types: application/json

Response Example (200 OK)

{
  "data": {
    "addContactsToListHook": "string"
  }
}

Linkedin Scraper

Different actions available with our Linkedin Scraper

Linkedin Scraper

Get Scraps

Get a basic listing of all the scraps you launched, with name, status, progression

Example

Request Content-Types: application/json

Query

query scraps{
  scraps{
    _id
    auth
    authes
    name
    url
    scrapIndex
    enrichIndex
    enrichFound
    nextRunningSegment
    enrichEnabled
    segmented
    totalContact
    date
    estimatedEnd
    status
    error
    webhooks{
      webhookUrl
      events
    }
    processing
    plannedStart
  }
}

Try it now

200 OK

Successful operation

type

Scrap

Response Content-Types: application/json

Response Example (200 OK)

{
  "data": {
    "scraps": [
      {
        "_id": "string",
        "auth": "string",
        "authes": [
          "string"
        ],
        "name": "string",
        "url": "string",
        "scrapIndex": "integer",
        "enrichIndex": "integer",
        "enrichFound": "integer",
        "nextRunningSegment": "string",
        "enrichEnabled": "boolean",
        "segmented": "boolean",
        "totalContact": "integer",
        "date": "string",
        "estimatedEnd": "string",
        "status": "string",
        "error": "string",
        "webhooks": [
          {
            "webhookUrl": "string",
            "events": [
              "string"
            ]
          }
        ],
        "processing": "boolean",
        "plannedStart": "string"
      }
    ]
  }
}

Linkedin Scraper

Get credentials

Get all the different credentials you saved for the scrapper

Example

Request Content-Types: application/json

Query

query scrap_authes{
  scrap_authes{
    _id
    name
    token
    status
    createdAt
  }
}

Try it now

200 OK

Successful operation

type

LinkedinAuth

Response Content-Types: application/json

Response Example (200 OK)

{
  "data": {
    "scrap_authes": [
      {
        "_id": "string",
        "name": "string",
        "token": "string",
        "status": "string",
        "createdAt": "string"
      }
    ]
  }
}

Linkedin Scraper

Launch a Scrap

Create a scrap by providing credential(s) ID(s), name and sales navigator URL

name:

string

(no description)

authes:

string[]

(no description)

url:

string

(no description)

plannedStart:

string

(no description)

Example

Request Content-Types: application/json

Query

mutation createScrap($name: String!, $authes: [ID]!, $url: String!, $plannedStart: String){
  createScrap(name: $name, authes: $authes, url: $url, plannedStart: $plannedStart)
}

Variables

{
  "name": "string",
  "authes": [
    "string"
  ],
  "url": "string",
  "plannedStart": "string"
}

Try it now

200 OK

Successful operation

type

string

Response Content-Types: application/json

Response Example (200 OK)

{
  "data": {
    "createScrap": "string"
  }
}

Linkedin Scraper

Create Credential

Create LinkedIn credentials using cookies, use the returned ID to attach it to a scrap

cookie:

string

(no description)

jsessionid:

string

(no description)

li_a:

string

(no description)

ua:

string

(no description)

Example

Request Content-Types: application/json

Query

mutation scrap_createAuth($cookie: String!, $jsessionid: String, $li_a: String, $ua: String){
  scrap_createAuth(cookie: $cookie, jsessionid: $jsessionid, li_a: $li_a, ua: $ua)
}

Variables

{
  "cookie": "string",
  "jsessionid": "string",
  "li_a": "string",
  "ua": "string"
}

Try it now

200 OK

Successful operation

type

string

Response Content-Types: application/json

Response Example (200 OK)

{
  "data": {
    "scrap_createAuth": "string"
  }
}

Linkedin Scraper

Update Credential

Update an existing credentials

id:

string

(no description)

cookie:

string

(no description)

jsessionid:

string

(no description)

li_a:

string

(no description)

ua:

string

(no description)

Example

Request Content-Types: application/json

Query

mutation scrap_updateAuth($id: ID!, $cookie: String!, $jsessionid: String, $li_a: String, $ua: String){
  scrap_updateAuth(id: $id, cookie: $cookie, jsessionid: $jsessionid, li_a: $li_a, ua: $ua)
}

Variables

{
  "id": "string",
  "cookie": "string",
  "jsessionid": "string",
  "li_a": "string",
  "ua": "string"
}

Try it now

200 OK

Successful operation

type

string

Response Content-Types: application/json

Response Example (200 OK)

{
  "data": {
    "scrap_updateAuth": "string"
  }
}

Linkedin Scraper

Pause a scrap

Pause a running scrap. Works for segmented scrap ONLY! (More than 2,500 contacts)

id:

string

(no description)

Example

Request Content-Types: application/json

Query

mutation pauseScrap($id: ID!){
  pauseScrap(id: $id)
}

Variables

{
  "id": "string"
}

Try it now

200 OK

Successful operation

type

boolean

Response Content-Types: application/json

Response Example (200 OK)

{
  "data": {
    "pauseScrap": "boolean"
  }
}

Linkedin Scraper

Resume a scrap

Resume a scrap that has been paused (for segmented scrap), or scrap that has rate limit or invalid cookie error (you must have had updated your linkedin credentials before)

id:

string

(no description)

Example

Request Content-Types: application/json

Query

mutation resumeScrap($id: ID!){
  resumeScrap(id: $id)
}

Variables

{
  "id": "string"
}

Try it now

200 OK

Successful operation

type

boolean

Response Content-Types: application/json

Response Example (200 OK)

{
  "data": {
    "resumeScrap": "boolean"
  }
}

Linkedin Scraper

Download a scrap

Download a scrap, this mutation returns a String in a CSV format

id:

string

(no description)

format:

integer

(no description)

Example

Request Content-Types: application/json

Query

mutation downloadScrap($id: ID!, $format: Int!){
  downloadScrap(id: $id, format: $format)
}

Variables

{
  "id": "string",
  "format": "integer"
}

Try it now

200 OK

Successful operation

type

string

Response Content-Types: application/json

Response Example (200 OK)

{
  "data": {
    "downloadScrap": "string"
  }
}

Linkedin Scraper

Add Webhook to a Scrap

Add a webhook to a scrap, for the moment only "FINISHED" and "ERROR" events are available. It will be requested as POST HTTP method containing the name, id, event and error if there is one.

id:

string

(no description)

webhookUrl:

string

(no description)

events:

string[]

(no description)

Example

Request Content-Types: application/json

Query

mutation addWebhookToScrap($id: ID!, $webhookUrl: String!, $events: [String]!){
  addWebhookToScrap(id: $id, webhookUrl: $webhookUrl, events: $events)
}

Variables

{
  "id": "string",
  "webhookUrl": "string",
  "events": [
    "string"
  ]
}

Try it now

200 OK

Successful operation

type

boolean

Response Content-Types: application/json

Response Example (200 OK)

{
  "data": {
    "addWebhookToScrap": "boolean"
  }
}

Linkedin Scraper

Remove Webhook to a Scrap

Remove a webhook from a Scrap using its ID and the used webhook URL

id:

string

(no description)

webhookUrl:

string

(no description)

Example

Request Content-Types: application/json

Query

mutation removeWebhookFromScrap($id: ID!, $webhookUrl: String!){
  removeWebhookFromScrap(id: $id, webhookUrl: $webhookUrl)
}

Variables

{
  "id": "string",
  "webhookUrl": "string"
}

Try it now

200 OK

Successful operation

type

boolean

Response Content-Types: application/json

Response Example (200 OK)

{
  "data": {
    "removeWebhookFromScrap": "boolean"
  }
}

Schema Definitions

APIKey: object

key: object
return: String arguments: object
created_at: object
return: String arguments: object
status: object
return: String arguments: object
last_usage: object
return: String arguments: object

Example

{
  "key": {
    "return": "string",
    "arguments": {}
  },
  "created_at": {
    "return": "string",
    "arguments": {}
  },
  "status": {
    "return": "string",
    "arguments": {}
  },
  "last_usage": {
    "return": "string",
    "arguments": {}
  }
}

Activities: object

total_count: object
return: Int arguments: object
activities: object
return: Activity arguments: object

Example

{
  "total_count": {
    "return": "number",
    "arguments": {}
  },
  "activities": {
    "return": [
      {
        "_id": {
          "return": "object",
          "arguments": {}
        },
        "contact": {
          "return": {
            "_id": {
              "return": "object",
              "arguments": {}
            },
            "firstName": {
              "return": "string",
              "arguments": {}
            },
            "lastName": {
              "return": "string",
              "arguments": {}
            },
            "phoneNumber": {
              "return": "string",
              "arguments": {}
            },
            "email": {
              "return": "string",
              "arguments": {}
            },
            "custom": {
              "return": "object",
              "arguments": {}
            },
            "interested": {
              "return": "string",
              "arguments": {}
            },
            "replyRate": {
              "return": "string",
              "arguments": {}
            },
            "mailsSent": {
              "return": "number",
              "arguments": {}
            },
            "status": {
              "return": "string",
              "arguments": {}
            },
            "lastContacted": {
              "return": "string",
              "arguments": {}
            },
            "lastReplied": {
              "return": "string",
              "arguments": {}
            },
            "lastOpen": {
              "return": "string",
              "arguments": {}
            },
            "campaigns": {
              "return": [
                "string"
              ],
              "arguments": {}
            }
          },
          "arguments": {}
        },
        "event": {
          "return": "string",
          "arguments": {}
        },
        "date": {
          "return": "string",
          "arguments": {}
        },
        "step": {
          "return": "number",
          "arguments": {}
        },
        "version": {
          "return": "number",
          "arguments": {}
        },
        "customData": {
          "return": {
            "link": {
              "return": "string",
              "arguments": {}
            },
            "repliedTo": {
              "return": "string"
            }
          }
        }
      }
    ]
  }
}

Activity: object

_id: object
return: ID arguments: object
contact: object
return: Contact arguments: object
event: object
return: MailEvent arguments: object
date: object
return: String arguments: object
step: object
return: Int arguments: object
version: object
return: Int arguments: object
customData: object
return: ActivityCustomData arguments: object

Example

{
  "_id": {
    "return": "object",
    "arguments": {}
  },
  "contact": {
    "return": {
      "_id": {
        "return": "object",
        "arguments": {}
      },
      "firstName": {
        "return": "string",
        "arguments": {}
      },
      "lastName": {
        "return": "string",
        "arguments": {}
      },
      "phoneNumber": {
        "return": "string",
        "arguments": {}
      },
      "email": {
        "return": "string",
        "arguments": {}
      },
      "custom": {
        "return": "object",
        "arguments": {}
      },
      "interested": {
        "return": "string",
        "arguments": {}
      },
      "replyRate": {
        "return": "string",
        "arguments": {}
      },
      "mailsSent": {
        "return": "number",
        "arguments": {}
      },
      "status": {
        "return": "string",
        "arguments": {}
      },
      "lastContacted": {
        "return": "string",
        "arguments": {}
      },
      "lastReplied": {
        "return": "string",
        "arguments": {}
      },
      "lastOpen": {
        "return": "string",
        "arguments": {}
      },
      "campaigns": {
        "return": [
          "string"
        ],
        "arguments": {}
      }
    },
    "arguments": {}
  },
  "event": {
    "return": "string",
    "arguments": {}
  },
  "date": {
    "return": "string",
    "arguments": {}
  },
  "step": {
    "return": "number",
    "arguments": {}
  },
  "version": {
    "return": "number",
    "arguments": {}
  },
  "customData": {
    "return": {
      "link": {
        "return": "string",
        "arguments": {}
      },
      "repliedTo": {
        "return": "string",
        "arguments": {}
      }
    },
    "arguments": {}
  }
}

ActivityCustomData: object

link: object
return: String arguments: object
repliedTo: object
return: String arguments: object

Example

{
  "link": {
    "return": "string",
    "arguments": {}
  },
  "repliedTo": {
    "return": "string",
    "arguments": {}
  }
}

ActivityReply: object

content: object
return: String arguments: object
rate: object
return: String arguments: object

Example

{
  "content": {
    "return": "string",
    "arguments": {}
  },
  "rate": {
    "return": "string",
    "arguments": {}
  }
}

ActivityResume: object

global: object
return: GlobalActivities arguments: object
steps: object
return: object[][] arguments: object

Example

{
  "global": {
    "return": {
      "sent": {
        "return": "number",
        "arguments": {}
      },
      "first_open": {
        "return": "number",
        "arguments": {}
      },
      "first_open_percent": {
        "return": "number",
        "arguments": {}
      },
      "opened": {
        "return": "number",
        "arguments": {}
      },
      "clicked": {
        "return": "number",
        "arguments": {}
      },
      "clicked_percent": {
        "return": "number",
        "arguments": {}
      },
      "replied": {
        "return": "number",
        "arguments": {}
      },
      "replied_percent": {
        "return": "number",
        "arguments": {}
      },
      "bounced": {
        "return": "number",
        "arguments": {}
      },
      "bounced_percent": {
        "return": "number",
        "arguments": {}
      },
      "unsubscribed": {
        "return": "number",
        "arguments": {}
      },
      "unsubscribed_percent": {
        "return": "number",
        "arguments": {}
      },
      "progress_percent": {
        "return": "number",
        "arguments": {}
      }
    },
    "arguments": {}
  },
  "steps": {
    "return": [
      [
        {
          "sent": {
            "return": "number",
            "arguments": {}
          },
          "to_send": {
            "return": "number",
            "arguments": {}
          },
          "delivered": {
            "return": "number",
            "arguments": {}
          },
          "first_open": {
            "return": "number",
            "arguments": {}
          },
          "first_open_percent": {
            "return": "number",
            "arguments": {}
          },
          "opened": {
            "return": "number",
            "arguments": {}
          },
          "clicked": {
            "return": "number",
            "arguments": {}
          },
          "clicked_percent": {
            "return": "number",
            "arguments": {}
          },
          "replied": {
            "return": "number",
            "arguments": {}
          },
          "replied_percent": {}
        }
      ]
    ]
  }
}

AdditionalEmail: object

expiration: object
return: String arguments: object
active: object
return: Boolean arguments: object
canceled: object
return: Boolean arguments: object
fromEmeliaSubscription: object
return: Boolean arguments: object

Example

{
  "expiration": {
    "return": "string",
    "arguments": {}
  },
  "active": {
    "return": "boolean",
    "arguments": {}
  },
  "canceled": {
    "return": "boolean",
    "arguments": {}
  },
  "fromEmeliaSubscription": {
    "return": "boolean",
    "arguments": {}
  }
}

Attachment: object

name: object
return: String arguments: object
url: object
return: String arguments: object

Example

{
  "name": {
    "return": "string",
    "arguments": {}
  },
  "url": {
    "return": "string",
    "arguments": {}
  }
}

BasicCampaign: object

_id: object
return: ID arguments: object
name: object
return: String arguments: object
status: object
return: CampaignStatus arguments: object
createdAt: object
return: String arguments: object
useManyProviders: object
return: Boolean arguments: object
provider: object
return: EmailProvider arguments: object
providersUsed: object
return: ID arguments: object
plannedStart: object
return: String arguments: object

Example

{
  "_id": {
    "return": "object",
    "arguments": {}
  },
  "name": {
    "return": "string",
    "arguments": {}
  },
  "status": {
    "return": "string",
    "arguments": {}
  },
  "createdAt": {
    "return": "string",
    "arguments": {}
  },
  "useManyProviders": {
    "return": "boolean",
    "arguments": {}
  },
  "provider": {
    "return": {
      "_id": {
        "return": "object",
        "arguments": {}
      },
      "customDomain": {
        "return": {
          "domainName": {
            "return": "string",
            "arguments": {}
          },
          "status": {
            "return": "string",
            "arguments": {}
          },
          "dateAdded": {
            "return": "string",
            "arguments": {}
          }
        },
        "arguments": {}
      },
      "senderName": {
        "return": "string",
        "arguments": {}
      },
      "senderEmail": {
        "return": "string",
        "arguments": {}
      },
      "senderPassword": {
        "return": "string",
        "arguments": {}
      },
      "emailType": {
        "return": "string",
        "arguments": {}
      },
      "smtp": {
        "return": {
          "login": {
            "return": "string",
            "arguments": {}
          },
          "password": {
            "return": "string",
            "arguments": {}
          },
          "server": {
            "return": "string",
            "arguments": {}
          },
          "port": {
            "return": "number",
            "arguments": {}
          },
          "ssl": {
            "return": "boolean",
            "arguments": {}
          }
        },
        "arguments": {}
      },
      "imap": {
        "return": {
          "login": {
            "return": "string",
            "arguments": {}
          },
          "password": {
            "return": "string",
            "arguments": {}
          },
          "server": {
            "return": "string",
            "arguments": {}
          },
          "port": {}
        }
      }
    }
  }
}

BillingInfo: object

name: object
return: String arguments: object
address_line1: object
return: String arguments: object
address_line2: object
return: String arguments: object
address_city: object
return: String arguments: object
address_zip: object
return: String arguments: object
address_country: object
return: String arguments: object
vat_number: object
return: String arguments: object

Example

{
  "name": {
    "return": "string",
    "arguments": {}
  },
  "address_line1": {
    "return": "string",
    "arguments": {}
  },
  "address_line2": {
    "return": "string",
    "arguments": {}
  },
  "address_city": {
    "return": "string",
    "arguments": {}
  },
  "address_zip": {
    "return": "string",
    "arguments": {}
  },
  "address_country": {
    "return": "string",
    "arguments": {}
  },
  "vat_number": {
    "return": "string",
    "arguments": {}
  }
}

Blacklist: object

_id: object
return: ID arguments: object
name: object
return: String arguments: object
blacklistContent: object
return: String arguments: object

Example

{
  "_id": {
    "return": "object",
    "arguments": {}
  },
  "name": {
    "return": "string",
    "arguments": {}
  },
  "blacklistContent": {
    "return": "string",
    "arguments": {}
  }
}

Boolean: boolean

The Boolean scalar type represents true or false.

Example

boolean

Campaign: object

_id: object
return: ID arguments: object
name: object
return: String arguments: object
status: object
return: CampaignStatus arguments: object
createdAt: object
return: String arguments: object
schedule: object
return: Schedule arguments: object
useManyProviders: object
return: Boolean arguments: object
provider: object
return: ID arguments: object
providersUsed: object
return: ID arguments: object
startAt: object
return: String arguments: object
steps: object
return: Step arguments: object
recipients: object
return: Recipients arguments: object
estimatedEnd: object
return: String arguments: object
plannedStart: object
return: String arguments: object
lastRefreshed: object
return: String arguments: object

Example

{
  "_id": {
    "return": "object",
    "arguments": {}
  },
  "name": {
    "return": "string",
    "arguments": {}
  },
  "status": {
    "return": "string",
    "arguments": {}
  },
  "createdAt": {
    "return": "string",
    "arguments": {}
  },
  "schedule": {
    "return": {
      "bcc": {
        "return": "string",
        "arguments": {}
      },
      "dailyContact": {
        "return": "number",
        "arguments": {}
      },
      "dailyLimit": {
        "return": "number",
        "arguments": {}
      },
      "minInterval": {
        "return": "number",
        "arguments": {}
      },
      "maxInterval": {
        "return": "number",
        "arguments": {}
      },
      "blacklistUnsub": {
        "return": "boolean",
        "arguments": {}
      },
      "trackLinks": {
        "return": "boolean",
        "arguments": {}
      },
      "trackOpens": {
        "return": "boolean",
        "arguments": {}
      },
      "timeZone": {
        "return": "string",
        "arguments": {}
      },
      "days": {
        "return": [
          "number"
        ],
        "arguments": {}
      },
      "start": {
        "return": "string",
        "arguments": {}
      },
      "end": {
        "return": "string",
        "arguments": {}
      },
      "eventToStopMails": {
        "return": [
          "string"
        ],
        "arguments": {}
      }
    },
    "arguments": {}
  },
  "useManyProviders": {
    "return": "boolean",
    "arguments": {}
  },
  "provider": {
    "return": "object",
    "arguments": {}
  },
  "providersUsed": {
    "return": [
      "object"
    ],
    "arguments": {}
  },
  "startAt": {
    "return": "string",
    "arguments": {}
  },
  "steps": {
    "return": [
      {
        "delay": {
          "return": {
            "amount": {}
          }
        }
      }
    ]
  }
}

CampaignLine: object

_id: object
return: ID arguments: object
name: object
return: String arguments: object
status: object
return: CampaignStatus arguments: object
createdAt: object
return: String arguments: object
provider: object
return: String arguments: object
useManyProviders: object
return: Boolean arguments: object
plannedStart: object
return: String arguments: object

Example

{
  "_id": {
    "return": "object",
    "arguments": {}
  },
  "name": {
    "return": "string",
    "arguments": {}
  },
  "status": {
    "return": "string",
    "arguments": {}
  },
  "createdAt": {
    "return": "string",
    "arguments": {}
  },
  "provider": {
    "return": "string",
    "arguments": {}
  },
  "useManyProviders": {
    "return": "boolean",
    "arguments": {}
  },
  "plannedStart": {
    "return": "string",
    "arguments": {}
  }
}

CampaignStat: object

mailsSent: object
return: Int arguments: object
uniqueOpensPercent: object
return: Float arguments: object
opens: object
return: Int arguments: object
linkClickedPercent: object
return: Float arguments: object
repliedPercent: object
return: Float arguments: object
bouncedPercent: object
return: Float arguments: object
unsubscribePercent: object
return: Float arguments: object
progressPercent: object
return: Float arguments: object

Example

{
  "mailsSent": {
    "return": "number",
    "arguments": {}
  },
  "uniqueOpensPercent": {
    "return": "number",
    "arguments": {}
  },
  "opens": {
    "return": "number",
    "arguments": {}
  },
  "linkClickedPercent": {
    "return": "number",
    "arguments": {}
  },
  "repliedPercent": {
    "return": "number",
    "arguments": {}
  },
  "bouncedPercent": {
    "return": "number",
    "arguments": {}
  },
  "unsubscribePercent": {
    "return": "number",
    "arguments": {}
  },
  "progressPercent": {
    "return": "number",
    "arguments": {}
  }
}

CampaignStatus: string

object RUNNING
object PAUSED
object DRAFT
object FINISHED
object ARCHIVED

Card: object

card_id: object
return: ID arguments: object
type: object
return: String arguments: object
last4: object
return: String arguments: object
exp: object
return: String arguments: object

Example

{
  "card_id": {
    "return": "object",
    "arguments": {}
  },
  "type": {
    "return": "string",
    "arguments": {}
  },
  "last4": {
    "return": "string",
    "arguments": {}
  },
  "exp": {
    "return": "string",
    "arguments": {}
  }
}

Contact: object

_id: object
return: ID arguments: object
firstName: object
return: String arguments: object
lastName: object
return: String arguments: object
phoneNumber: object
return: String arguments: object
email: object
return: String arguments: object
custom: object
return: JSON arguments: object
interested: object
return: String arguments: object
replyRate: object
return: String arguments: object
mailsSent: object
return: Int arguments: object
status: object
return: String arguments: object
lastContacted: object
return: String arguments: object
lastReplied: object
return: String arguments: object
lastOpen: object
return: String arguments: object
campaigns: object
return: String arguments: object

Example

{
  "_id": {
    "return": "object",
    "arguments": {}
  },
  "firstName": {
    "return": "string",
    "arguments": {}
  },
  "lastName": {
    "return": "string",
    "arguments": {}
  },
  "phoneNumber": {
    "return": "string",
    "arguments": {}
  },
  "email": {
    "return": "string",
    "arguments": {}
  },
  "custom": {
    "return": "object",
    "arguments": {}
  },
  "interested": {
    "return": "string",
    "arguments": {}
  },
  "replyRate": {
    "return": "string",
    "arguments": {}
  },
  "mailsSent": {
    "return": "number",
    "arguments": {}
  },
  "status": {
    "return": "string",
    "arguments": {}
  },
  "lastContacted": {
    "return": "string",
    "arguments": {}
  },
  "lastReplied": {
    "return": "string",
    "arguments": {}
  },
  "lastOpen": {
    "return": "string",
    "arguments": {}
  },
  "campaigns": {
    "return": [
      "string"
    ],
    "arguments": {}
  }
}

ContactList: object

_id: object
return: ID arguments: object
name: object
return: String arguments: object
contactCount: object
return: Int arguments: object
fields: object
return: String arguments: object
usedInCampaign: object
return: Boolean arguments: object
contacts: object
return: ContactsResult arguments: object page: Int perPage: Int event: MailEvent query: String

Example

{
  "_id": {
    "return": "object",
    "arguments": {}
  },
  "name": {
    "return": "string",
    "arguments": {}
  },
  "contactCount": {
    "return": "number",
    "arguments": {}
  },
  "fields": {
    "return": [
      "string"
    ],
    "arguments": {}
  },
  "usedInCampaign": {
    "return": "boolean",
    "arguments": {}
  },
  "contacts": {
    "return": {
      "list": {
        "return": [
          {
            "_id": {
              "return": "object",
              "arguments": {}
            },
            "firstName": {
              "return": "string",
              "arguments": {}
            },
            "lastName": {
              "return": "string",
              "arguments": {}
            },
            "phoneNumber": {
              "return": "string",
              "arguments": {}
            },
            "email": {
              "return": "string",
              "arguments": {}
            },
            "custom": {
              "return": "object",
              "arguments": {}
            },
            "interested": {
              "return": "string",
              "arguments": {}
            },
            "replyRate": {
              "return": "string",
              "arguments": {}
            },
            "mailsSent": {
              "return": "number",
              "arguments": {}
            },
            "status": {
              "return": "string",
              "arguments": {}
            },
            "lastContacted": {
              "return": "string",
              "arguments": {}
            },
            "lastReplied": {
              "return": "string",
              "arguments": {}
            },
            "lastOpen": {
              "return": "string",
              "arguments": {}
            },
            "campaigns": {
              "return": [
                "string"
              ],
              "arguments": {}
            }
          }
        ],
        "arguments": {}
      },
      "count": {
        "return": "number",
        "arguments": {}
      }
    },
    "arguments": {
      "page": "number",
      "perPage": "number",
      "event": [
        "string"
      ]
    }
  }
}

ContactsResult: object

list: object
return: Contact arguments: object
count: object
return: Int arguments: object

Example

{
  "list": {
    "return": [
      {
        "_id": {
          "return": "object",
          "arguments": {}
        },
        "firstName": {
          "return": "string",
          "arguments": {}
        },
        "lastName": {
          "return": "string",
          "arguments": {}
        },
        "phoneNumber": {
          "return": "string",
          "arguments": {}
        },
        "email": {
          "return": "string",
          "arguments": {}
        },
        "custom": {
          "return": "object",
          "arguments": {}
        },
        "interested": {
          "return": "string",
          "arguments": {}
        },
        "replyRate": {
          "return": "string",
          "arguments": {}
        },
        "mailsSent": {
          "return": "number",
          "arguments": {}
        },
        "status": {
          "return": "string",
          "arguments": {}
        },
        "lastContacted": {
          "return": "string",
          "arguments": {}
        },
        "lastReplied": {
          "return": "string",
          "arguments": {}
        },
        "lastOpen": {
          "return": "string",
          "arguments": {}
        },
        "campaigns": {
          "return": [
            "string"
          ],
          "arguments": {}
        }
      }
    ],
    "arguments": {}
  },
  "count": {
    "return": "number",
    "arguments": {}
  }
}

CouponRes: object

code: object
return: String arguments: object
coef: object
return: Float arguments: object
applied: object
return: Boolean arguments: object
valid: object
return: Boolean arguments: object

Example

{
  "code": {
    "return": "string",
    "arguments": {}
  },
  "coef": {
    "return": "number",
    "arguments": {}
  },
  "applied": {
    "return": "boolean",
    "arguments": {}
  },
  "valid": {
    "return": "boolean",
    "arguments": {}
  }
}

CustomDomain: object

domainName: object
return: String arguments: object
status: object
return: String arguments: object
dateAdded: object
return: String arguments: object

Example

{
  "domainName": {
    "return": "string",
    "arguments": {}
  },
  "status": {
    "return": "string",
    "arguments": {}
  },
  "dateAdded": {
    "return": "string",
    "arguments": {}
  }
}

Delay: object

amount: object
return: Int arguments: object
unit: object
return: DelayUnit arguments: object

Example

{
  "amount": {
    "return": "number",
    "arguments": {}
  },
  "unit": {
    "return": "string",
    "arguments": {}
  }
}

DelayUnit: string

object MINUTES
object HOURS
object DAYS

Email: object

_id: object
return: String arguments: object
repliedTo: object
return: String arguments: object
email: object
return: String arguments: object
references: object
return: String arguments: object
messageId: object
return: String arguments: object
senderName: object
return: String arguments: object
subject: object
return: String arguments: object
content: object
return: String arguments: object
campaign: object
return: String arguments: object
campaignId: object
return: ID arguments: object
text: object
return: String arguments: object
date: object
return: String arguments: object
read: object
return: Boolean arguments: object
repliedOn: object
return: String arguments: object

Example

{
  "_id": {
    "return": "string",
    "arguments": {}
  },
  "repliedTo": {
    "return": "string",
    "arguments": {}
  },
  "email": {
    "return": "string",
    "arguments": {}
  },
  "references": {
    "return": [
      "string"
    ],
    "arguments": {}
  },
  "messageId": {
    "return": "string",
    "arguments": {}
  },
  "senderName": {
    "return": "string",
    "arguments": {}
  },
  "subject": {
    "return": "string",
    "arguments": {}
  },
  "content": {
    "return": "string",
    "arguments": {}
  },
  "campaign": {
    "return": "string",
    "arguments": {}
  },
  "campaignId": {
    "return": "object",
    "arguments": {}
  },
  "text": {
    "return": "string",
    "arguments": {}
  },
  "date": {
    "return": "string",
    "arguments": {}
  },
  "read": {
    "return": "boolean",
    "arguments": {}
  },
  "repliedOn": {
    "return": "string",
    "arguments": {}
  }
}

EmailConfig: object

login: object
return: String arguments: object
password: object
return: String arguments: object
server: object
return: String arguments: object
port: object
return: Int arguments: object
ssl: object
return: Boolean arguments: object

Example

{
  "login": {
    "return": "string",
    "arguments": {}
  },
  "password": {
    "return": "string",
    "arguments": {}
  },
  "server": {
    "return": "string",
    "arguments": {}
  },
  "port": {
    "return": "number",
    "arguments": {}
  },
  "ssl": {
    "return": "boolean",
    "arguments": {}
  }
}

EmailProvider: object

_id: object
return: ID arguments: object
customDomain: object
return: CustomDomain arguments: object
senderName: object
return: String arguments: object
senderEmail: object
return: String arguments: object
senderPassword: object
return: String arguments: object
emailType: object
return: EmailType arguments: object
smtp: object
return: EmailConfig arguments: object
imap: object
return: EmailConfig arguments: object
signature: object
return: ID arguments: object
usedInCampaign: object
return: String arguments: object
disabled: object
return: Boolean arguments: object
disconnected: object
return: Boolean arguments: object
warmup: object
return: Warmup arguments: object

Example

{
  "_id": {
    "return": "object",
    "arguments": {}
  },
  "customDomain": {
    "return": {
      "domainName": {
        "return": "string",
        "arguments": {}
      },
      "status": {
        "return": "string",
        "arguments": {}
      },
      "dateAdded": {
        "return": "string",
        "arguments": {}
      }
    },
    "arguments": {}
  },
  "senderName": {
    "return": "string",
    "arguments": {}
  },
  "senderEmail": {
    "return": "string",
    "arguments": {}
  },
  "senderPassword": {
    "return": "string",
    "arguments": {}
  },
  "emailType": {
    "return": "string",
    "arguments": {}
  },
  "smtp": {
    "return": {
      "login": {
        "return": "string",
        "arguments": {}
      },
      "password": {
        "return": "string",
        "arguments": {}
      },
      "server": {
        "return": "string",
        "arguments": {}
      },
      "port": {
        "return": "number",
        "arguments": {}
      },
      "ssl": {
        "return": "boolean",
        "arguments": {}
      }
    },
    "arguments": {}
  },
  "imap": {
    "return": {
      "login": {
        "return": "string",
        "arguments": {}
      },
      "password": {
        "return": "string",
        "arguments": {}
      },
      "server": {
        "return": "string",
        "arguments": {}
      },
      "port": {
        "return": "number",
        "arguments": {}
      },
      "ssl": {
        "return": "boolean",
        "arguments": {}
      }
    },
    "arguments": {}
  },
  "signature": {
    "return": "object",
    "arguments": {}
  },
  "usedInCampaign": {
    "return": "string",
    "arguments": {}
  },
  "disabled": {
    "return": "boolean",
    "arguments": {}
  },
  "disconnected": {
    "return": "boolean"
  }
}

EmailType: string

object GOOGLE
object OFFICE
object EXCHANGE
object SMTP
object GOOGLEIMAP

Enrich: object

_id: object
return: ID arguments: object
name: object
return: String arguments: object
enrichIndex: object
return: Int arguments: object
enrichFound: object
return: Int arguments: object
totalContact: object
return: Int arguments: object
date: object
return: String arguments: object
status: object
return: String arguments: object
error: object
return: String arguments: object

Example

{
  "_id": {
    "return": "object",
    "arguments": {}
  },
  "name": {
    "return": "string",
    "arguments": {}
  },
  "enrichIndex": {
    "return": "number",
    "arguments": {}
  },
  "enrichFound": {
    "return": "number",
    "arguments": {}
  },
  "totalContact": {
    "return": "number",
    "arguments": {}
  },
  "date": {
    "return": "string",
    "arguments": {}
  },
  "status": {
    "return": "string",
    "arguments": {}
  },
  "error": {
    "return": "string",
    "arguments": {}
  }
}

EnrichMembership: object

creditsRemaining: object
return: Int arguments: object
creditsSubscription: object
return: Int arguments: object
expiration: object
return: String arguments: object

Example

{
  "creditsRemaining": {
    "return": "number",
    "arguments": {}
  },
  "creditsSubscription": {
    "return": "number",
    "arguments": {}
  },
  "expiration": {
    "return": "string",
    "arguments": {}
  }
}

EventToStop: string

object REPLIED
object CLICKED
object OPENED

FetchMailboxParams: object

page: Int
campaignId: ID
providerId: ID

Example

{
  "page": "number",
  "campaignId": "object",
  "providerId": "object"
}

Float: number

The Float scalar type represents signed double-precision fractional values as specified by IEEE 754.

Example

number

GlobalActivities: object

sent: object
return: Int arguments: object
first_open: object
return: Int arguments: object
first_open_percent: object
return: Float arguments: object
opened: object
return: Int arguments: object
clicked: object
return: Int arguments: object
clicked_percent: object
return: Float arguments: object
replied: object
return: Int arguments: object
replied_percent: object
return: Float arguments: object
bounced: object
return: Int arguments: object
bounced_percent: object
return: Float arguments: object
unsubscribed: object
return: Int arguments: object
unsubscribed_percent: object
return: Float arguments: object
progress_percent: object
return: Float arguments: object

Example

{
  "sent": {
    "return": "number",
    "arguments": {}
  },
  "first_open": {
    "return": "number",
    "arguments": {}
  },
  "first_open_percent": {
    "return": "number",
    "arguments": {}
  },
  "opened": {
    "return": "number",
    "arguments": {}
  },
  "clicked": {
    "return": "number",
    "arguments": {}
  },
  "clicked_percent": {
    "return": "number",
    "arguments": {}
  },
  "replied": {
    "return": "number",
    "arguments": {}
  },
  "replied_percent": {
    "return": "number",
    "arguments": {}
  },
  "bounced": {
    "return": "number",
    "arguments": {}
  },
  "bounced_percent": {
    "return": "number",
    "arguments": {}
  },
  "unsubscribed": {
    "return": "number",
    "arguments": {}
  },
  "unsubscribed_percent": {
    "return": "number",
    "arguments": {}
  },
  "progress_percent": {
    "return": "number",
    "arguments": {}
  }
}

ID: object

The ID scalar type represents a unique identifier, often used to refetch an object or as key for a cache. The ID type appears in a JSON response as a String; however, it is not intended to be human-readable. When expected as an input type, any string (such as "4") or integer (such as 4) input value will be accepted as an ID.

Example

object

Int: number

The Int scalar type represents non-fractional signed whole numeric values. Int can represent values between -(2^31) and 2^31 - 1.

Example

number

Integration: object

_id: object
return: ID arguments: object
campaigns: object
return: IntegrationCampaign arguments: object
type: object
return: String arguments: object
name: object
return: String arguments: object
lists: object
return: List arguments: object

Example

{
  "_id": {
    "return": "object",
    "arguments": {}
  },
  "campaigns": {
    "return": [
      {
        "_id": {
          "return": "object",
          "arguments": {}
        },
        "name": {
          "return": "string",
          "arguments": {}
        }
      }
    ],
    "arguments": {}
  },
  "type": {
    "return": "string",
    "arguments": {}
  },
  "name": {
    "return": "string",
    "arguments": {}
  },
  "lists": {
    "return": [
      {
        "listId": {
          "return": "number",
          "arguments": {}
        },
        "name": {
          "return": "string",
          "arguments": {}
        }
      }
    ],
    "arguments": {}
  }
}

IntegrationCampaign: object

_id: object
return: ID arguments: object
name: object
return: String arguments: object

Example

{
  "_id": {
    "return": "object",
    "arguments": {}
  },
  "name": {
    "return": "string",
    "arguments": {}
  }
}

Invoice: object

id: object
return: String arguments: object
url: object
return: String arguments: object
price: object
return: Float arguments: object
date: object
return: String arguments: object

Example

{
  "id": {
    "return": "string",
    "arguments": {}
  },
  "url": {
    "return": "string",
    "arguments": {}
  },
  "price": {
    "return": "number",
    "arguments": {}
  },
  "date": {
    "return": "string",
    "arguments": {}
  }
}

JSON: object

The JSON scalar type represents JSON values as specified by ECMA-404.

Example

object

LKActivities: object

total_count: object
return: Int arguments: object
activities: object
return: LKActivity arguments: object

Example

{
  "total_count": {
    "return": "number",
    "arguments": {}
  },
  "activities": {
    "return": [
      {
        "_id": {
          "return": "object",
          "arguments": {}
        },
        "contact": {
          "return": {
            "_id": {
              "return": "object",
              "arguments": {}
            },
            "id": {
              "return": "string",
              "arguments": {}
            },
            "firstName": {
              "return": "string",
              "arguments": {}
            },
            "lastName": {
              "return": "string",
              "arguments": {}
            },
            "url": {
              "return": "string",
              "arguments": {}
            },
            "handle": {
              "return": "string",
              "arguments": {}
            },
            "custom": {
              "return": "object",
              "arguments": {}
            },
            "status": {
              "return": "string",
              "arguments": {}
            },
            "lastContacted": {
              "return": "string",
              "arguments": {}
            },
            "lastReplied": {
              "return": "string",
              "arguments": {}
            },
            "campaigns": {
              "return": [
                "string"
              ],
              "arguments": {}
            }
          },
          "arguments": {}
        },
        "event": {
          "return": "string",
          "arguments": {}
        },
        "date": {
          "return": "string",
          "arguments": {}
        },
        "step": {
          "return": "number",
          "arguments": {}
        },
        "version": {
          "return": "number",
          "arguments": {}
        },
        "customData": {
          "return": "object",
          "arguments": {}
        }
      }
    ],
    "arguments": {}
  }
}

LKActivity: object

_id: object
return: ID arguments: object
contact: object
return: LKContact arguments: object
event: object
return: LKEvent arguments: object
date: object
return: String arguments: object
step: object
return: Int arguments: object
version: object
return: Int arguments: object
customData: object
return: JSON arguments: object

Example

{
  "_id": {
    "return": "object",
    "arguments": {}
  },
  "contact": {
    "return": {
      "_id": {
        "return": "object",
        "arguments": {}
      },
      "id": {
        "return": "string",
        "arguments": {}
      },
      "firstName": {
        "return": "string",
        "arguments": {}
      },
      "lastName": {
        "return": "string",
        "arguments": {}
      },
      "url": {
        "return": "string",
        "arguments": {}
      },
      "handle": {
        "return": "string",
        "arguments": {}
      },
      "custom": {
        "return": "object",
        "arguments": {}
      },
      "status": {
        "return": "string",
        "arguments": {}
      },
      "lastContacted": {
        "return": "string",
        "arguments": {}
      },
      "lastReplied": {
        "return": "string",
        "arguments": {}
      },
      "campaigns": {
        "return": [
          "string"
        ],
        "arguments": {}
      }
    },
    "arguments": {}
  },
  "event": {
    "return": "string",
    "arguments": {}
  },
  "date": {
    "return": "string",
    "arguments": {}
  },
  "step": {
    "return": "number",
    "arguments": {}
  },
  "version": {
    "return": "number",
    "arguments": {}
  },
  "customData": {
    "return": "object",
    "arguments": {}
  }
}

LKActivityResume: object

global: object
return: LKGlobalActivities arguments: object
steps: object
return: object[][] arguments: object

Example

{
  "global": {
    "return": {
      "visited": {
        "return": "number",
        "arguments": {}
      },
      "invited": {
        "return": "number",
        "arguments": {}
      },
      "accepted": {
        "return": "number",
        "arguments": {}
      },
      "message_sent": {
        "return": "number",
        "arguments": {}
      },
      "replied": {
        "return": "number",
        "arguments": {}
      },
      "progress_percent": {
        "return": "number",
        "arguments": {}
      },
      "invite_percent": {
        "return": "number",
        "arguments": {}
      }
    },
    "arguments": {}
  },
  "steps": {
    "return": [
      [
        {
          "visited": {
            "return": "number",
            "arguments": {}
          },
          "invited": {
            "return": "number",
            "arguments": {}
          },
          "accepted": {
            "return": "number",
            "arguments": {}
          },
          "message_sent": {
            "return": "number",
            "arguments": {}
          },
          "replied": {
            "return": "number",
            "arguments": {}
          }
        }
      ]
    ],
    "arguments": {}
  }
}

LKBasicCampaign: object

_id: object
return: ID arguments: object
name: object
return: String arguments: object
status: object
return: CampaignStatus arguments: object
createdAt: object
return: String arguments: object
account: object
return: LinkedinAuth arguments: object
plannedStart: object
return: String arguments: object

Example

{
  "_id": {
    "return": "object",
    "arguments": {}
  },
  "name": {
    "return": "string",
    "arguments": {}
  },
  "status": {
    "return": "string",
    "arguments": {}
  },
  "createdAt": {
    "return": "string",
    "arguments": {}
  },
  "account": {
    "return": {
      "_id": {
        "return": "object",
        "arguments": {}
      },
      "name": {
        "return": "string",
        "arguments": {}
      },
      "token": {
        "return": "string",
        "arguments": {}
      },
      "status": {
        "return": "string",
        "arguments": {}
      },
      "createdAt": {
        "return": "string",
        "arguments": {}
      },
      "metadata": {
        "return": {
          "id": {
            "return": "string",
            "arguments": {}
          },
          "handle": {
            "return": "string",
            "arguments": {}
          },
          "picture": {
            "return": "string",
            "arguments": {}
          },
          "fullName": {
            "return": "string",
            "arguments": {}
          }
        },
        "arguments": {}
      }
    },
    "arguments": {}
  },
  "plannedStart": {
    "return": "string",
    "arguments": {}
  }
}

LKCampaign: object

_id: object
return: ID arguments: object
name: object
return: String arguments: object
status: object
return: CampaignStatus arguments: object
createdAt: object
return: String arguments: object
schedule: object
return: LKSchedule arguments: object
account: object
return: ID arguments: object
startAt: object
return: String arguments: object
steps: object
return: LKStep arguments: object
recipients: object
return: LKRecipients arguments: object
estimatedEnd: object
return: String arguments: object
plannedStart: object
return: String arguments: object
lastRefreshed: object
return: String arguments: object

Example

{
  "_id": {
    "return": "object",
    "arguments": {}
  },
  "name": {
    "return": "string",
    "arguments": {}
  },
  "status": {
    "return": "string",
    "arguments": {}
  },
  "createdAt": {
    "return": "string",
    "arguments": {}
  },
  "schedule": {
    "return": {
      "dailyContact": {
        "return": "number",
        "arguments": {}
      },
      "timeZone": {
        "return": "string",
        "arguments": {}
      },
      "days": {
        "return": [
          "number"
        ],
        "arguments": {}
      },
      "start": {
        "return": "string",
        "arguments": {}
      },
      "end": {
        "return": "string",
        "arguments": {}
      },
      "excludeAlreadyMessaged": {
        "return": "boolean",
        "arguments": {}
      },
      "exclude1stConn": {
        "return": "boolean",
        "arguments": {}
      },
      "excludeNoPictures": {
        "return": "boolean",
        "arguments": {}
      }
    },
    "arguments": {}
  },
  "account": {
    "return": "object",
    "arguments": {}
  },
  "startAt": {
    "return": "string",
    "arguments": {}
  },
  "steps": {
    "return": [
      {
        "stepType": {
          "return": "string",
          "arguments": {}
        },
        "delay": {
          "return": {
            "amount": {
              "return": "number",
              "arguments": {}
            },
            "unit": {
              "return": "string",
              "arguments": {}
            }
          },
          "arguments": {}
        },
        "versions": {
          "return": [
            {
              "_id": {
                "return": "object",
                "arguments": {}
              },
              "message": {
                "return": "string",
                "arguments": {}
              },
              "disabled": {
                "return": "boolean",
                "arguments": {}
              }
            }
          ],
          "arguments": {}
        }
      }
    ],
    "arguments": {}
  }
}

LKCampaignLine: object

_id: object
return: ID arguments: object
name: object
return: String arguments: object
status: object
return: CampaignStatus arguments: object
createdAt: object
return: String arguments: object
account: object
return: LinkedinAuth arguments: object
plannedStart: object
return: String arguments: object

Example

{
  "_id": {
    "return": "object",
    "arguments": {}
  },
  "name": {
    "return": "string",
    "arguments": {}
  },
  "status": {
    "return": "string",
    "arguments": {}
  },
  "createdAt": {
    "return": "string",
    "arguments": {}
  },
  "account": {
    "return": {
      "_id": {
        "return": "object",
        "arguments": {}
      },
      "name": {
        "return": "string",
        "arguments": {}
      },
      "token": {
        "return": "string",
        "arguments": {}
      },
      "status": {
        "return": "string",
        "arguments": {}
      },
      "createdAt": {
        "return": "string",
        "arguments": {}
      },
      "metadata": {
        "return": {
          "id": {
            "return": "string",
            "arguments": {}
          },
          "handle": {
            "return": "string",
            "arguments": {}
          },
          "picture": {
            "return": "string",
            "arguments": {}
          },
          "fullName": {
            "return": "string",
            "arguments": {}
          }
        },
        "arguments": {}
      }
    },
    "arguments": {}
  },
  "plannedStart": {
    "return": "string",
    "arguments": {}
  }
}

LKCampaignStat: object

visited: object
return: Int arguments: object
invited: object
return: Int arguments: object
accepted: object
return: Int arguments: object
message_sent: object
return: Int arguments: object
replied: object
return: Int arguments: object
progress_percent: object
return: Float arguments: object
invite_percent: object
return: Float arguments: object

Example

{
  "visited": {
    "return": "number",
    "arguments": {}
  },
  "invited": {
    "return": "number",
    "arguments": {}
  },
  "accepted": {
    "return": "number",
    "arguments": {}
  },
  "message_sent": {
    "return": "number",
    "arguments": {}
  },
  "replied": {
    "return": "number",
    "arguments": {}
  },
  "progress_percent": {
    "return": "number",
    "arguments": {}
  },
  "invite_percent": {
    "return": "number",
    "arguments": {}
  }
}

LKContact: object

_id: object
return: ID arguments: object
id: object
return: String arguments: object
firstName: object
return: String arguments: object
lastName: object
return: String arguments: object
url: object
return: String arguments: object
handle: object
return: String arguments: object
custom: object
return: JSON arguments: object
status: object
return: String arguments: object
lastContacted: object
return: String arguments: object
lastReplied: object
return: String arguments: object
campaigns: object
return: String arguments: object

Example

{
  "_id": {
    "return": "object",
    "arguments": {}
  },
  "id": {
    "return": "string",
    "arguments": {}
  },
  "firstName": {
    "return": "string",
    "arguments": {}
  },
  "lastName": {
    "return": "string",
    "arguments": {}
  },
  "url": {
    "return": "string",
    "arguments": {}
  },
  "handle": {
    "return": "string",
    "arguments": {}
  },
  "custom": {
    "return": "object",
    "arguments": {}
  },
  "status": {
    "return": "string",
    "arguments": {}
  },
  "lastContacted": {
    "return": "string",
    "arguments": {}
  },
  "lastReplied": {
    "return": "string",
    "arguments": {}
  },
  "campaigns": {
    "return": [
      "string"
    ],
    "arguments": {}
  }
}

LKContactList: object

_id: object
return: ID arguments: object
name: object
return: String arguments: object
contactCount: object
return: Int arguments: object
fields: object
return: String arguments: object
usedInCampaign: object
return: Boolean arguments: object
contacts: object
return: LKContactsResult arguments: object page: Int perPage: Int event: LKEvent query: String

Example

{
  "_id": {
    "return": "object",
    "arguments": {}
  },
  "name": {
    "return": "string",
    "arguments": {}
  },
  "contactCount": {
    "return": "number",
    "arguments": {}
  },
  "fields": {
    "return": [
      "string"
    ],
    "arguments": {}
  },
  "usedInCampaign": {
    "return": "boolean",
    "arguments": {}
  },
  "contacts": {
    "return": {
      "list": {
        "return": [
          {
            "_id": {
              "return": "object",
              "arguments": {}
            },
            "id": {
              "return": "string",
              "arguments": {}
            },
            "firstName": {
              "return": "string",
              "arguments": {}
            },
            "lastName": {
              "return": "string",
              "arguments": {}
            },
            "url": {
              "return": "string",
              "arguments": {}
            },
            "handle": {
              "return": "string",
              "arguments": {}
            },
            "custom": {
              "return": "object",
              "arguments": {}
            },
            "status": {
              "return": "string",
              "arguments": {}
            },
            "lastContacted": {
              "return": "string",
              "arguments": {}
            },
            "lastReplied": {
              "return": "string",
              "arguments": {}
            },
            "campaigns": {
              "return": [
                "string"
              ],
              "arguments": {}
            }
          }
        ],
        "arguments": {}
      },
      "count": {
        "return": "number",
        "arguments": {}
      }
    },
    "arguments": {
      "page": "number",
      "perPage": "number",
      "event": [
        "string"
      ],
      "query": "string"
    }
  }
}

LKContactsResult: object

list: object
return: LKContact arguments: object
count: object
return: Int arguments: object

Example

{
  "list": {
    "return": [
      {
        "_id": {
          "return": "object",
          "arguments": {}
        },
        "id": {
          "return": "string",
          "arguments": {}
        },
        "firstName": {
          "return": "string",
          "arguments": {}
        },
        "lastName": {
          "return": "string",
          "arguments": {}
        },
        "url": {
          "return": "string",
          "arguments": {}
        },
        "handle": {
          "return": "string",
          "arguments": {}
        },
        "custom": {
          "return": "object",
          "arguments": {}
        },
        "status": {
          "return": "string",
          "arguments": {}
        },
        "lastContacted": {
          "return": "string",
          "arguments": {}
        },
        "lastReplied": {
          "return": "string",
          "arguments": {}
        },
        "campaigns": {
          "return": [
            "string"
          ],
          "arguments": {}
        }
      }
    ],
    "arguments": {}
  },
  "count": {
    "return": "number",
    "arguments": {}
  }
}

LKEvent: string

object ALL
object NO_ACTIVITY
object VISITED
object INVITED
object ACCEPTED
object MESSAGE_SENT
object REPLIED
object RE_REPLY
object LIKED
object FOLLOWED

LKGlobalActivities: object

visited: object
return: Int arguments: object
invited: object
return: Int arguments: object
accepted: object
return: Int arguments: object
message_sent: object
return: Int arguments: object
replied: object
return: Int arguments: object
progress_percent: object
return: Float arguments: object
invite_percent: object
return: Float arguments: object

Example

{
  "visited": {
    "return": "number",
    "arguments": {}
  },
  "invited": {
    "return": "number",
    "arguments": {}
  },
  "accepted": {
    "return": "number",
    "arguments": {}
  },
  "message_sent": {
    "return": "number",
    "arguments": {}
  },
  "replied": {
    "return": "number",
    "arguments": {}
  },
  "progress_percent": {
    "return": "number",
    "arguments": {}
  },
  "invite_percent": {
    "return": "number",
    "arguments": {}
  }
}

LKMailVersion: object

_id: object
return: ID arguments: object
message: object
return: String arguments: object
disabled: object
return: Boolean arguments: object

Example

{
  "_id": {
    "return": "object",
    "arguments": {}
  },
  "message": {
    "return": "string",
    "arguments": {}
  },
  "disabled": {
    "return": "boolean",
    "arguments": {}
  }
}

LKRecipients: object

lists: object
return: LKContactList arguments: object
contacts: object
return: LKContactsResult arguments: object campaignId: ID page: Int perPage: Int event: LKEvent query: String
processing: object
return: Boolean arguments: object
total_count: object
return: Int arguments: object

Example

{
  "lists": {
    "return": [
      {
        "_id": {
          "return": "object",
          "arguments": {}
        },
        "name": {
          "return": "string",
          "arguments": {}
        },
        "contactCount": {
          "return": "number",
          "arguments": {}
        },
        "fields": {
          "return": [
            "string"
          ],
          "arguments": {}
        },
        "usedInCampaign": {
          "return": "boolean",
          "arguments": {}
        },
        "contacts": {
          "return": {
            "list": {
              "return": [
                {
                  "_id": {
                    "return": "object",
                    "arguments": {}
                  },
                  "id": {
                    "return": "string",
                    "arguments": {}
                  },
                  "firstName": {
                    "return": "string",
                    "arguments": {}
                  },
                  "lastName": {
                    "return": "string",
                    "arguments": {}
                  },
                  "url": {
                    "return": "string",
                    "arguments": {}
                  },
                  "handle": {
                    "return": "string",
                    "arguments": {}
                  },
                  "custom": {
                    "return": "object",
                    "arguments": {}
                  },
                  "status": {
                    "return": "string",
                    "arguments": {}
                  },
                  "lastContacted": {
                    "return": "string",
                    "arguments": {}
                  },
                  "lastReplied": {
                    "return": "string",
                    "arguments": {}
                  },
                  "campaigns": {
                    "return": [
                      "string"
                    ],
                    "arguments": {}
                  }
                }
              ],
              "arguments": {}
            },
            "count": {
              "return": "number",
              "arguments": {}
            }
          },
          "arguments": {
            "page": "number",
            "perPage": "number",
            "event": [
              "string"
            ],
            "query": "string"
          }
        }
      }
    ],
    "arguments": {}
  },
  "contacts": {
    "return": {
      "list": {
        "return": [
          null
        ]
      }
    }
  }
}

LKSchedule: object

dailyContact: object
return: Int arguments: object
timeZone: object
return: String arguments: object
days: object
return: Int arguments: object
start: object
return: String arguments: object
end: object
return: String arguments: object
excludeAlreadyMessaged: object
return: Boolean arguments: object
exclude1stConn: object
return: Boolean arguments: object
excludeNoPictures: object
return: Boolean arguments: object

Example

{
  "dailyContact": {
    "return": "number",
    "arguments": {}
  },
  "timeZone": {
    "return": "string",
    "arguments": {}
  },
  "days": {
    "return": [
      "number"
    ],
    "arguments": {}
  },
  "start": {
    "return": "string",
    "arguments": {}
  },
  "end": {
    "return": "string",
    "arguments": {}
  },
  "excludeAlreadyMessaged": {
    "return": "boolean",
    "arguments": {}
  },
  "exclude1stConn": {
    "return": "boolean",
    "arguments": {}
  },
  "excludeNoPictures": {
    "return": "boolean",
    "arguments": {}
  }
}

LKStep: object

stepType: object
return: StepType arguments: object
delay: object
return: Delay arguments: object
versions: object
return: LKMailVersion arguments: object

Example

{
  "stepType": {
    "return": "string",
    "arguments": {}
  },
  "delay": {
    "return": {
      "amount": {
        "return": "number",
        "arguments": {}
      },
      "unit": {
        "return": "string",
        "arguments": {}
      }
    },
    "arguments": {}
  },
  "versions": {
    "return": [
      {
        "_id": {
          "return": "object",
          "arguments": {}
        },
        "message": {
          "return": "string",
          "arguments": {}
        },
        "disabled": {
          "return": "boolean",
          "arguments": {}
        }
      }
    ],
    "arguments": {}
  }
}

LKVersionActivities: object

visited: object
return: Int arguments: object
invited: object
return: Int arguments: object
accepted: object
return: Int arguments: object
message_sent: object
return: Int arguments: object
replied: object
return: Int arguments: object

Example

{
  "visited": {
    "return": "number",
    "arguments": {}
  },
  "invited": {
    "return": "number",
    "arguments": {}
  },
  "accepted": {
    "return": "number",
    "arguments": {}
  },
  "message_sent": {
    "return": "number",
    "arguments": {}
  },
  "replied": {
    "return": "number",
    "arguments": {}
  }
}

LinkedInSlot: object

expiration: object
return: String arguments: object
active: object
return: Boolean arguments: object
canceled: object
return: Boolean arguments: object

Example

{
  "expiration": {
    "return": "string",
    "arguments": {}
  },
  "active": {
    "return": "boolean",
    "arguments": {}
  },
  "canceled": {
    "return": "boolean",
    "arguments": {}
  }
}

LinkedinAuth: object

_id: object
return: ID arguments: object
name: object
return: String arguments: object
token: object
return: String arguments: object
status: object
return: String arguments: object
createdAt: object
return: String arguments: object
metadata: object
return: LinkedinAuthMetadata arguments: object

Example

{
  "_id": {
    "return": "object",
    "arguments": {}
  },
  "name": {
    "return": "string",
    "arguments": {}
  },
  "token": {
    "return": "string",
    "arguments": {}
  },
  "status": {
    "return": "string",
    "arguments": {}
  },
  "createdAt": {
    "return": "string",
    "arguments": {}
  },
  "metadata": {
    "return": {
      "id": {
        "return": "string",
        "arguments": {}
      },
      "handle": {
        "return": "string",
        "arguments": {}
      },
      "picture": {
        "return": "string",
        "arguments": {}
      },
      "fullName": {
        "return": "string",
        "arguments": {}
      }
    },
    "arguments": {}
  }
}

LinkedinAuthMetadata: object

id: object
return: String arguments: object
handle: object
return: String arguments: object
picture: object
return: String arguments: object
fullName: object
return: String arguments: object

Example

{
  "id": {
    "return": "string",
    "arguments": {}
  },
  "handle": {
    "return": "string",
    "arguments": {}
  },
  "picture": {
    "return": "string",
    "arguments": {}
  },
  "fullName": {
    "return": "string",
    "arguments": {}
  }
}

List: object

listId: object
return: Int arguments: object
name: object
return: String arguments: object

Example

{
  "listId": {
    "return": "number",
    "arguments": {}
  },
  "name": {
    "return": "string",
    "arguments": {}
  }
}

MailEvent: string

object ALL
object NO_ACTIVITY
object SENT
object FIRST_OPEN
object OPENED
object CLICKED
object REPLIED
object BOUNCED
object UNSUBSCRIBED
object FIRE
object ICE
object INTERESTED
object BLACKLISTED

MailVersion: object

_id: object
return: ID arguments: object
subject: object
return: String arguments: object
message: object
return: String arguments: object
attachments: object
return: Attachment arguments: object
rawHtml: object
return: Boolean arguments: object
disabled: object
return: Boolean arguments: object
options: object
return: VersionOption arguments: object

Example

{
  "_id": {
    "return": "object",
    "arguments": {}
  },
  "subject": {
    "return": "string",
    "arguments": {}
  },
  "message": {
    "return": "string",
    "arguments": {}
  },
  "attachments": {
    "return": [
      {
        "name": {
          "return": "string",
          "arguments": {}
        },
        "url": {
          "return": "string",
          "arguments": {}
        }
      }
    ],
    "arguments": {}
  },
  "rawHtml": {
    "return": "boolean",
    "arguments": {}
  },
  "disabled": {
    "return": "boolean",
    "arguments": {}
  },
  "options": {
    "return": {
      "showHistory": {
        "return": "boolean",
        "arguments": {}
      },
      "schedule": {
        "return": [
          {
            "day": {
              "return": "number",
              "arguments": {}
            },
            "start": {
              "return": "string",
              "arguments": {}
            },
            "end": {
              "return": "string",
              "arguments": {}
            }
          }
        ],
        "arguments": {}
      },
      "trackLinks": {
        "return": "boolean",
        "arguments": {}
      },
      "trackOpens": {
        "return": "boolean",
        "arguments": {}
      },
      "provider": {
        "return": "object",
        "arguments": {}
      }
    },
    "arguments": {}
  }
}

Membership: object

vat: object
return: String arguments: object
newBillingSystem: object
return: Boolean arguments: object
couponsApplied: object
return: Int arguments: object
billingPeriod: object
return: String arguments: object
id: object
return: Int arguments: object
expiration: object
return: String arguments: object
canceled: object
return: Boolean arguments: object
additionalEmails: object
return: AdditionalEmail arguments: object
linkedinSlots: object
return: LinkedInSlot arguments: object
scrapper: object
return: ScrapperMembership arguments: object
enrich: object
return: EnrichMembership arguments: object

Example

{
  "vat": {
    "return": "string",
    "arguments": {}
  },
  "newBillingSystem": {
    "return": "boolean",
    "arguments": {}
  },
  "couponsApplied": {
    "return": "number",
    "arguments": {}
  },
  "billingPeriod": {
    "return": "string",
    "arguments": {}
  },
  "id": {
    "return": "number",
    "arguments": {}
  },
  "expiration": {
    "return": "string",
    "arguments": {}
  },
  "canceled": {
    "return": "boolean",
    "arguments": {}
  },
  "additionalEmails": {
    "return": [
      {
        "expiration": {
          "return": "string",
          "arguments": {}
        },
        "active": {
          "return": "boolean",
          "arguments": {}
        },
        "canceled": {
          "return": "boolean",
          "arguments": {}
        },
        "fromEmeliaSubscription": {
          "return": "boolean",
          "arguments": {}
        }
      }
    ],
    "arguments": {}
  },
  "linkedinSlots": {
    "return": [
      {
        "expiration": {
          "return": "string",
          "arguments": {}
        },
        "active": {
          "return": "boolean",
          "arguments": {}
        },
        "canceled": {
          "return": "boolean",
          "arguments": {}
        }
      }
    ],
    "arguments": {}
  },
  "scrapper": {
    "return": {
      "expiration": {
        "return": "string",
        "arguments": {}
      },
      "canceled": {
        "return": "boolean",
        "arguments": {}
      }
    },
    "arguments": {}
  },
  "enrich": {
    "return": {
      "creditsRemaining": {
        "return": "number",
        "arguments": {}
      },
      "creditsSubscription": {
        "return": "number",
        "arguments": {}
      },
      "expiration": {
        "return": "string",
        "arguments": {}
      }
    },
    "arguments": {}
  }
}

Recipients: object

lists: object
return: ContactList arguments: object
contacts: object
return: ContactsResult arguments: object campaignId: ID page: Int perPage: Int event: MailEvent query: String
processing: object
return: Boolean arguments: object
total_count: object
return: Int arguments: object

Example

{
  "lists": {
    "return": [
      {
        "_id": {
          "return": "object",
          "arguments": {}
        },
        "name": {
          "return": "string",
          "arguments": {}
        },
        "contactCount": {
          "return": "number",
          "arguments": {}
        },
        "fields": {
          "return": [
            "string"
          ],
          "arguments": {}
        },
        "usedInCampaign": {
          "return": "boolean",
          "arguments": {}
        },
        "contacts": {
          "return": {
            "list": {
              "return": [
                {
                  "_id": {
                    "return": "object",
                    "arguments": {}
                  },
                  "firstName": {
                    "return": "string",
                    "arguments": {}
                  },
                  "lastName": {
                    "return": "string",
                    "arguments": {}
                  },
                  "phoneNumber": {
                    "return": "string",
                    "arguments": {}
                  },
                  "email": {
                    "return": "string",
                    "arguments": {}
                  },
                  "custom": {
                    "return": "object",
                    "arguments": {}
                  },
                  "interested": {
                    "return": "string",
                    "arguments": {}
                  },
                  "replyRate": {
                    "return": "string",
                    "arguments": {}
                  },
                  "mailsSent": {
                    "return": "number",
                    "arguments": {}
                  },
                  "status": {
                    "return": "string",
                    "arguments": {}
                  },
                  "lastContacted": {
                    "return": "string",
                    "arguments": {}
                  },
                  "lastReplied": {
                    "return": "string",
                    "arguments": {}
                  },
                  "lastOpen": {
                    "return": "string",
                    "arguments": {}
                  },
                  "campaigns": {
                    "return": [
                      "string"
                    ],
                    "arguments": {}
                  }
                }
              ],
              "arguments": {}
            },
            "count": {
              "return": "number",
              "arguments": {}
            }
          },
          "arguments": {
            "page": "number",
            "perPage": "number"
          }
        }
      }
    ]
  }
}

Schedule: object

bcc: object
return: String arguments: object
dailyContact: object
return: Int arguments: object
dailyLimit: object
return: Int arguments: object
minInterval: object
return: Int arguments: object
maxInterval: object
return: Int arguments: object
blacklistUnsub: object
return: Boolean arguments: object
trackLinks: object
return: Boolean arguments: object
trackOpens: object
return: Boolean arguments: object
timeZone: object
return: String arguments: object
days: object
return: Int arguments: object
start: object
return: String arguments: object
end: object
return: String arguments: object
eventToStopMails: object
return: EventToStop arguments: object

Example

{
  "bcc": {
    "return": "string",
    "arguments": {}
  },
  "dailyContact": {
    "return": "number",
    "arguments": {}
  },
  "dailyLimit": {
    "return": "number",
    "arguments": {}
  },
  "minInterval": {
    "return": "number",
    "arguments": {}
  },
  "maxInterval": {
    "return": "number",
    "arguments": {}
  },
  "blacklistUnsub": {
    "return": "boolean",
    "arguments": {}
  },
  "trackLinks": {
    "return": "boolean",
    "arguments": {}
  },
  "trackOpens": {
    "return": "boolean",
    "arguments": {}
  },
  "timeZone": {
    "return": "string",
    "arguments": {}
  },
  "days": {
    "return": [
      "number"
    ],
    "arguments": {}
  },
  "start": {
    "return": "string",
    "arguments": {}
  },
  "end": {
    "return": "string",
    "arguments": {}
  },
  "eventToStopMails": {
    "return": [
      "string"
    ],
    "arguments": {}
  }
}

Scrap: object

_id: object
return: ID arguments: object
auth: object
return: ID arguments: object
authes: object
return: ID arguments: object
name: object
return: String arguments: object
url: object
return: String arguments: object
scrapIndex: object
return: Int arguments: object
enrichIndex: object
return: Int arguments: object
enrichFound: object
return: Int arguments: object
nextRunningSegment: object
return: String arguments: object
enrichEnabled: object
return: Boolean arguments: object
segmented: object
return: Boolean arguments: object
totalContact: object
return: Int arguments: object
date: object
return: String arguments: object
estimatedEnd: object
return: String arguments: object
status: object
return: String arguments: object
error: object
return: String arguments: object
webhooks: object
return: ScrapWebhook arguments: object
processing: object
return: Boolean arguments: object
plannedStart: object
return: String arguments: object

Example

{
  "_id": {
    "return": "object",
    "arguments": {}
  },
  "auth": {
    "return": "object",
    "arguments": {}
  },
  "authes": {
    "return": [
      "object"
    ],
    "arguments": {}
  },
  "name": {
    "return": "string",
    "arguments": {}
  },
  "url": {
    "return": "string",
    "arguments": {}
  },
  "scrapIndex": {
    "return": "number",
    "arguments": {}
  },
  "enrichIndex": {
    "return": "number",
    "arguments": {}
  },
  "enrichFound": {
    "return": "number",
    "arguments": {}
  },
  "nextRunningSegment": {
    "return": "string",
    "arguments": {}
  },
  "enrichEnabled": {
    "return": "boolean",
    "arguments": {}
  },
  "segmented": {
    "return": "boolean",
    "arguments": {}
  },
  "totalContact": {
    "return": "number",
    "arguments": {}
  },
  "date": {
    "return": "string",
    "arguments": {}
  },
  "estimatedEnd": {
    "return": "string",
    "arguments": {}
  },
  "status": {
    "return": "string",
    "arguments": {}
  },
  "error": {
    "return": "string",
    "arguments": {}
  },
  "webhooks": {
    "return": [
      {
        "webhookUrl": {
          "return": "string",
          "arguments": {}
        },
        "events": {
          "return": [
            "string"
          ],
          "arguments": {}
        }
      }
    ],
    "arguments": {}
  },
  "processing": {
    "return": "boolean",
    "arguments": {}
  },
  "plannedStart": {
    "return": "string",
    "arguments": {}
  }
}

ScrapWebhook: object

webhookUrl: object
return: String arguments: object
events: object
return: String arguments: object

Example

{
  "webhookUrl": {
    "return": "string",
    "arguments": {}
  },
  "events": {
    "return": [
      "string"
    ],
    "arguments": {}
  }
}

ScrapperMembership: object

expiration: object
return: String arguments: object
canceled: object
return: Boolean arguments: object

Example

{
  "expiration": {
    "return": "string",
    "arguments": {}
  },
  "canceled": {
    "return": "boolean",
    "arguments": {}
  }
}

SequenceGeneration: object

_id: object
return: ID arguments: object
contactsCount: object
return: Int arguments: object
contactsProcessed: object
return: Int arguments: object
status: object
return: String arguments: object
error: object
return: String arguments: object
output: object
return: String arguments: object
generatedDate: object
return: String arguments: object

Example

{
  "_id": {
    "return": "object",
    "arguments": {}
  },
  "contactsCount": {
    "return": "number",
    "arguments": {}
  },
  "contactsProcessed": {
    "return": "number",
    "arguments": {}
  },
  "status": {
    "return": "string",
    "arguments": {}
  },
  "error": {
    "return": "string",
    "arguments": {}
  },
  "output": {
    "return": "string",
    "arguments": {}
  },
  "generatedDate": {
    "return": "string",
    "arguments": {}
  }
}

Signature: object

_id: object
return: ID arguments: object
name: object
return: String arguments: object
content: object
return: String arguments: object
rawHtml: object
return: Boolean arguments: object

Example

{
  "_id": {
    "return": "object",
    "arguments": {}
  },
  "name": {
    "return": "string",
    "arguments": {}
  },
  "content": {
    "return": "string",
    "arguments": {}
  },
  "rawHtml": {
    "return": "boolean",
    "arguments": {}
  }
}

Step: object

delay: object
return: Delay arguments: object
versions: object
return: MailVersion arguments: object

Example

{
  "delay": {
    "return": {
      "amount": {
        "return": "number",
        "arguments": {}
      },
      "unit": {
        "return": "string",
        "arguments": {}
      }
    },
    "arguments": {}
  },
  "versions": {
    "return": [
      {
        "_id": {
          "return": "object",
          "arguments": {}
        },
        "subject": {
          "return": "string",
          "arguments": {}
        },
        "message": {
          "return": "string",
          "arguments": {}
        },
        "attachments": {
          "return": [
            {
              "name": {
                "return": "string",
                "arguments": {}
              },
              "url": {
                "return": "string",
                "arguments": {}
              }
            }
          ],
          "arguments": {}
        },
        "rawHtml": {
          "return": "boolean",
          "arguments": {}
        },
        "disabled": {
          "return": "boolean",
          "arguments": {}
        },
        "options": {
          "return": {
            "showHistory": {
              "return": "boolean",
              "arguments": {}
            },
            "schedule": {
              "return": [
                {
                  "day": {
                    "return": "number",
                    "arguments": {}
                  },
                  "start": {
                    "return": "string",
                    "arguments": {}
                  },
                  "end": {
                    "return": "string",
                    "arguments": {}
                  }
                }
              ],
              "arguments": {}
            },
            "trackLinks": {
              "return": "boolean",
              "arguments": {}
            },
            "trackOpens": {
              "return": "boolean",
              "arguments": {}
            },
            "provider": {
              "return": "object",
              "arguments": {}
            }
          },
          "arguments": {}
        }
      }
    ],
    "arguments": {}
  }
}

StepType: string

object VISIT
object CONNECTION
object MESSAGE
object LIKE
object FOLLOW
object INMAIL

String: string

The String scalar type represents textual data, represented as UTF-8 character sequences. The String type is most often used by GraphQL to represent free-form human-readable text.

Template: object

_id: object
return: ID arguments: object
name: object
return: String arguments: object
content: object
return: String arguments: object
rawHtml: object
return: Boolean arguments: object

Example

{
  "_id": {
    "return": "object",
    "arguments": {}
  },
  "name": {
    "return": "string",
    "arguments": {}
  },
  "content": {
    "return": "string",
    "arguments": {}
  },
  "rawHtml": {
    "return": "boolean",
    "arguments": {}
  }
}

Upload: object

Example

object

User: object

showMailbox: object
return: Boolean arguments: object
uid: object
return: ID arguments: object
name: object
return: String arguments: object
email: object
return: String arguments: object
picture: object
return: String arguments: object
subscription: object
return: Membership arguments: object
billing_info: object
return: BillingInfo arguments: object
credit_cards: object
return: Card arguments: object
invoices: object
return: Invoice arguments: object
api_keys: object
return: APIKey arguments: object
webhooks: object
return: Webhook arguments: object
integrations: object
return: Integration arguments: object type: String limit: Int
due_invoice: object
return: String arguments: object
joinedDate: object
return: String arguments: object

Example

{
  "showMailbox": {
    "return": "boolean",
    "arguments": {}
  },
  "uid": {
    "return": "object",
    "arguments": {}
  },
  "name": {
    "return": "string",
    "arguments": {}
  },
  "email": {
    "return": "string",
    "arguments": {}
  },
  "picture": {
    "return": "string",
    "arguments": {}
  },
  "subscription": {
    "return": {
      "vat": {
        "return": "string",
        "arguments": {}
      },
      "newBillingSystem": {
        "return": "boolean",
        "arguments": {}
      },
      "couponsApplied": {
        "return": "number",
        "arguments": {}
      },
      "billingPeriod": {
        "return": "string",
        "arguments": {}
      },
      "id": {
        "return": "number",
        "arguments": {}
      },
      "expiration": {
        "return": "string",
        "arguments": {}
      },
      "canceled": {
        "return": "boolean",
        "arguments": {}
      },
      "additionalEmails": {
        "return": [
          {
            "expiration": {
              "return": "string",
              "arguments": {}
            },
            "active": {
              "return": "boolean",
              "arguments": {}
            },
            "canceled": {
              "return": "boolean",
              "arguments": {}
            },
            "fromEmeliaSubscription": {
              "return": "boolean",
              "arguments": {}
            }
          }
        ],
        "arguments": {}
      },
      "linkedinSlots": {
        "return": [
          {
            "expiration": {
              "return": "string",
              "arguments": {}
            },
            "active": {
              "return": "boolean",
              "arguments": {}
            },
            "canceled": {
              "return": "boolean",
              "arguments": {}
            }
          }
        ],
        "arguments": {}
      },
      "scrapper": {
        "return": {
          "expiration": {
            "return": "string",
            "arguments": {}
          },
          "canceled": {
            "return": "boolean"
          }
        }
      }
    }
  }
}

VersionActivities: object

sent: object
return: Int arguments: object
to_send: object
return: Int arguments: object
delivered: object
return: Int arguments: object
first_open: object
return: Int arguments: object
first_open_percent: object
return: Float arguments: object
opened: object
return: Int arguments: object
clicked: object
return: Int arguments: object
clicked_percent: object
return: Float arguments: object
replied: object
return: Int arguments: object
replied_percent: object
return: Float arguments: object
bounced: object
return: Int arguments: object
bounced_percent: object
return: Float arguments: object
unsubscribed: object
return: Int arguments: object
unsubscribed_percent: object
return: Float arguments: object

Example

{
  "sent": {
    "return": "number",
    "arguments": {}
  },
  "to_send": {
    "return": "number",
    "arguments": {}
  },
  "delivered": {
    "return": "number",
    "arguments": {}
  },
  "first_open": {
    "return": "number",
    "arguments": {}
  },
  "first_open_percent": {
    "return": "number",
    "arguments": {}
  },
  "opened": {
    "return": "number",
    "arguments": {}
  },
  "clicked": {
    "return": "number",
    "arguments": {}
  },
  "clicked_percent": {
    "return": "number",
    "arguments": {}
  },
  "replied": {
    "return": "number",
    "arguments": {}
  },
  "replied_percent": {
    "return": "number",
    "arguments": {}
  },
  "bounced": {
    "return": "number",
    "arguments": {}
  },
  "bounced_percent": {
    "return": "number",
    "arguments": {}
  },
  "unsubscribed": {
    "return": "number",
    "arguments": {}
  },
  "unsubscribed_percent": {
    "return": "number",
    "arguments": {}
  }
}

VersionOption: object

showHistory: object
return: Boolean arguments: object
schedule: object
return: VersionSchedule arguments: object
trackLinks: object
return: Boolean arguments: object
trackOpens: object
return: Boolean arguments: object
provider: object
return: ID arguments: object

Example

{
  "showHistory": {
    "return": "boolean",
    "arguments": {}
  },
  "schedule": {
    "return": [
      {
        "day": {
          "return": "number",
          "arguments": {}
        },
        "start": {
          "return": "string",
          "arguments": {}
        },
        "end": {
          "return": "string",
          "arguments": {}
        }
      }
    ],
    "arguments": {}
  },
  "trackLinks": {
    "return": "boolean",
    "arguments": {}
  },
  "trackOpens": {
    "return": "boolean",
    "arguments": {}
  },
  "provider": {
    "return": "object",
    "arguments": {}
  }
}

VersionSchedule: object

day: object
return: Int arguments: object
start: object
return: String arguments: object
end: object
return: String arguments: object

Example

{
  "day": {
    "return": "number",
    "arguments": {}
  },
  "start": {
    "return": "string",
    "arguments": {}
  },
  "end": {
    "return": "string",
    "arguments": {}
  }
}

Warmup: object

_id: object
return: ID arguments: object
running: object
return: Boolean arguments: object
startDate: object
return: String arguments: object
emailsSent: object
return: Int arguments: object
emailsReceived: object
return: Int arguments: object
spamCount: object
return: Int arguments: object
conversationsCount: object
return: Int arguments: object
score: object
return: Int arguments: object
disabledReason: object
return: String arguments: object
stats: object
return: JSON arguments: object

Example

{
  "_id": {
    "return": "object",
    "arguments": {}
  },
  "running": {
    "return": "boolean",
    "arguments": {}
  },
  "startDate": {
    "return": "string",
    "arguments": {}
  },
  "emailsSent": {
    "return": "number",
    "arguments": {}
  },
  "emailsReceived": {
    "return": "number",
    "arguments": {}
  },
  "spamCount": {
    "return": "number",
    "arguments": {}
  },
  "conversationsCount": {
    "return": "number",
    "arguments": {}
  },
  "score": {
    "return": "number",
    "arguments": {}
  },
  "disabledReason": {
    "return": "string",
    "arguments": {}
  },
  "stats": {
    "return": "object",
    "arguments": {}
  }
}

Webhook: object

id: object
return: ID arguments: object
campaignId: object
return: ID arguments: object
campaignName: object
return: String arguments: object
url: object
return: String arguments: object
events: object
return: String arguments: object
status: object
return: String arguments: object

Example

{
  "id": {
    "return": "object",
    "arguments": {}
  },
  "campaignId": {
    "return": "object",
    "arguments": {}
  },
  "campaignName": {
    "return": "string",
    "arguments": {}
  },
  "url": {
    "return": "string",
    "arguments": {}
  },
  "events": {
    "return": [
      "string"
    ],
    "arguments": {}
  },
  "status": {
    "return": "string",
    "arguments": {}
  }
}

Documentation by DociQL