Waalaxy Public API

Prospect

Endpointhttps://developers.waalaxy.com

Operations related to prospects

Import

POST

https://developers.waalaxy.com

/prospects/addProspectFromIntegration

Adds one or more prospects to a specified prospect list and campaign. Use this endpoint to import prospects from external integrations.

Import › Headers

Authorization

string · required

The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.

Import › Request Body

object[] · required

prospectListId

string · required

required

canCreateDuplicates

boolean

moveDuplicatesToOtherList

boolean

shouldOverwriteCustomProfileData

boolean

campaignId

string

addExistingProspectInCampaign

boolean

Import › Responses

Prospects processed successfully

array · required

POST/prospects/addProspectFromIntegration

curl --request POST \
  --url https://developers.waalaxy.com/prospects/addProspectFromIntegration \
  --header 'Authorization: <string>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "prospects": [
    {
      "url": "url",
      "customProfile": {
        "firstName": "string",
        "lastName": "string",
        "occupation": "string",
        "company": {
          "name": "string",
          "linkedinUrl": "string",
          "website": "string"
        },
        "email": "string",
        "phoneNumbers": [
          {
            "type": "string",
            "number": "number"
          }
        ],
        "region": "string",
        "birthday": {
          "day": 0,
          "month": 0
        }
      }
    }
  ],
  "prospectListId": "prospectListId",
  "canCreateDuplicates": true,
  "moveDuplicatesToOtherList": true,
  "shouldOverwriteCustomProfileData": true,
  "origin": {
    "name": "regular_import"
  },
  "campaignId": "campaignId",
  "addExistingProspectInCampaign": true
}
'

shell

Example Request Body

{
  "prospects": [
    {
      "url": "url",
      "customProfile": {
        "firstName": "string",
        "lastName": "string",
        "occupation": "string",
        "company": {
          "name": "string",
          "linkedinUrl": "string",
          "website": "string"
        },
        "email": "string",
        "phoneNumbers": [
          {
            "type": "string",
            "number": "number"
          }
        ],
        "region": "string",
        "birthday": {
          "day": 0,
          "month": 0
        }
      }
    }
  ],
  "prospectListId": "prospectListId",
  "canCreateDuplicates": true,
  "moveDuplicatesToOtherList": true,
  "shouldOverwriteCustomProfileData": true,
  "origin": {
    "name": "regular_import"
  },
  "campaignId": "campaignId",
  "addExistingProspectInCampaign": true
}

json

Example Responses

{
  "result": [
    {
      "importCode": "duplicated_prospect",
      "addToCampaignCode": "cant_add_prospect_campaign_not_exist",
      "prospect": {
        "_id": "_id",
        "profile": {
          "firstName": "firstName",
          "lastName": "string",
          "publicIdentifier": "publicIdentifier",
          "memberId": "memberId",
          "salesMemberId": "salesMemberId"
        }
      },
      "message": "message"
    }
  ]
}

json

application/json

ProspectList Campaign

Import

POST

https://developers.waalaxy.com

/prospects/addProspectFromIntegration

Adds one or more prospects to a specified prospect list and campaign. Use this endpoint to import prospects from external integrations.

Import › Headers

Authorization

string · required

The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.

Import › Request Body

object[] · required

prospectListId

string · required

required

canCreateDuplicates

boolean

moveDuplicatesToOtherList

boolean

shouldOverwriteCustomProfileData

boolean

campaignId

string

addExistingProspectInCampaign

boolean

Import › Responses

Prospects processed successfully

array · required

curl --request POST \ --url https://developers.waalaxy.com/prospects/addProspectFromIntegration \ --header 'Authorization: <string>' \ --header 'Content-Type: application/json' \ --data ' { "prospects": [ { "url": "url", "customProfile": { "firstName": "string", "lastName": "string", "occupation": "string", "company": { "name": "string", "linkedinUrl": "string", "website": "string" }, "email": "string", "phoneNumbers": [ { "type": "string", "number": "number" } ], "region": "string", "birthday": { "day": 0, "month": 0 } } } ], "prospectListId": "prospectListId", "canCreateDuplicates": true, "moveDuplicatesToOtherList": true, "shouldOverwriteCustomProfileData": true, "origin": { "name": "regular_import" }, "campaignId": "campaignId", "addExistingProspectInCampaign": true } '

{ "prospects": [ { "url": "url", "customProfile": { "firstName": "string", "lastName": "string", "occupation": "string", "company": { "name": "string", "linkedinUrl": "string", "website": "string" }, "email": "string", "phoneNumbers": [ { "type": "string", "number": "number" } ], "region": "string", "birthday": { "day": 0, "month": 0 } } } ], "prospectListId": "prospectListId", "canCreateDuplicates": true, "moveDuplicatesToOtherList": true, "shouldOverwriteCustomProfileData": true, "origin": { "name": "regular_import" }, "campaignId": "campaignId", "addExistingProspectInCampaign": true }

{ "result": [ { "importCode": "duplicated_prospect", "addToCampaignCode": "cant_add_prospect_campaign_not_exist", "prospect": { "_id": "_id", "profile": { "firstName": "firstName", "lastName": "string", "publicIdentifier": "publicIdentifier", "memberId": "memberId", "salesMemberId": "salesMemberId" } }, "message": "message" } ] }