Skip to main content
POST
/
api
/
campaigns
/
campaigns
/
{campaignId}
/
add-recipient
Add a recipient to a campaign with contact details
curl --request POST \
  --url https://apiv1.delightloop.ai/api/campaigns/campaigns/{campaignId}/add-recipient \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <x-api-key>' \
  --data '
{
  "contactDetails": {
    "email": "[email protected]",
    "firstName": "John",
    "lastName": "Doe",
    "companyName": "TechCorp Inc",
    "jobTitle": "Software Engineer",
    "phoneNumber": "+1-555-0101",
    "linkedinUrl": "https://linkedin.com/in/johndoe",
    "profileImage": "https://cdn.delightloop.ai/profiles/user-profile-123.jpg",
    "address": {
      "line1": "123 Main St",
      "line2": "Apt 4B",
      "city": "San Francisco",
      "state": "CA",
      "country": "US",
      "zip": "94102"
    }
  },
  "sourceType": "manual"
}
'
{
  "success": true,
  "message": "Successfully added recipient to campaign",
  "campaignId": "camp-abc123",
  "contactId": "contact_123",
  "recipientId": "recipient_456",
  "emailSent": true,
  "creditsDeducted": 25,
  "remainingBalance": 475,
  "landingPageUrl": "https://campaigns.delightloop.ai/lg/lg-camp-abc123-xyz789",
  "claimPageUrl": "https://campaigns.delightloop.ai/cl/claim_recipient_456"
}

Headers

​
x-api-key
string
required

auth key

Path Parameters

​
campaignId
string
required

Campaign ID to add the recipient to

Example:

"camp-abcd1234"

Body

application/json
​
contactDetails
object
required

Contact details for the new recipient

​
sourceType
enum<string>

Source type for the contact creation

Available options:
manual,
csv,
crm,
api,
sso,
zapier,
webhook
Example:

"manual"

Response

Recipient successfully added to campaign

​
success
boolean
required

Whether the operation was successful

Example:

true

​
message
string
required

Success message

Example:

"Successfully added recipient to campaign"

​
campaignId
string
required

Campaign ID

Example:

"camp-abc123"

​
contactId
string
required

Created contact ID

Example:

"contact_123"

​
recipientId
string
required

Created recipient ID

Example:

"recipient_456"

​
emailSent
boolean
required

Whether an email was sent immediately

Example:

true

​
creditsDeducted
number
required

Wallet credits deducted for this recipient

Example:

25

​
remainingBalance
number
required

Remaining wallet balance after deduction

Example:

475

​
landingPageUrl
string
required

Landing page URL for the recipient

Example:

"https://campaigns.delightloop.ai/lg/lg-camp-abc123-xyz789"

​
claimPageUrl
string
required

Claim page URL for the recipient

Example:

"https://campaigns.delightloop.ai/cl/claim_recipient_456"