Upload Contact And Add To Campaign Api

curl --request POST \
  --url https://services.meetchase.ai/api/v1/campaigns/{campaign_id}/contacts/upload \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "email": "jsmith@example.com",
  "custom_data": {},
  "first_name": "<string>",
  "last_name": "<string>",
  "city": "<string>",
  "country": "<string>",
  "tags": []
}
'

{
  "id": 123
}

Campaigns

Add Contact to Campaign

This endpoint first uplaods a contact, then adds them to a campaign.

Path Parameters

campaign_id (int): The ID of the campaign to which the contacts are being added.

Query Parameters

bot_id (int): (Optional) The ID of the bot responsible for managing the contact’s email exchanges within the campaign. If not provided, the system will manually assign the contact to a bot.
notify (bool): A flag the users associated with the campaign should be notified about the new contact. Default is True.

Request Body

contact (ContactUpload): An object containing the contact details to be added to the campaign.

Headers

X-API-Key: The API key for authenticating the request.

Response

BaseItem: The ID of the newly inserted contact.

Errors

400 Bad Request: If the contact is already associated with the organisation or there are no bots in the organisation.
401 Unauthorized: If the API key is invalid.
404 Not Found: If the campaign does not exist or is not associated with the organisation.

POST

api

campaigns

{campaign_id}

contacts

upload

Upload Contact And Add To Campaign Api

curl --request POST \
  --url https://services.meetchase.ai/api/v1/campaigns/{campaign_id}/contacts/upload \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "email": "jsmith@example.com",
  "custom_data": {},
  "first_name": "<string>",
  "last_name": "<string>",
  "city": "<string>",
  "country": "<string>",
  "tags": []
}
'

{
  "id": 123
}

Authorizations

X-API-Key

string

header

required

Key used to authenticate user API requests.

Path Parameters

campaign_id

integer

required

Query Parameters

bot_id

integer | null

notify

boolean

default:true

Body

application/json

string<email>

required

custom_data

Custom Data · object

first_name

string | null

Required string length: 1 - 63

last_name

string | null

Required string length: 1 - 63

city

string | null

Required string length: 1 - 63

country

string | null

Required string length: 1 - 63

Response

Successful Response

integer

required

Add Contact to Campaign & Start Fetch Campaigns