Skip to main content
POST
/
v1
/
campaigns
curl --request POST \
  --url https://openapi.enginy.ai/v1/campaigns \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "name": "Email or fallback task",
  "identityId": 323,
  "steps": [
    {
      "type": "condition",
      "condition": {
        "type": "has_professional_email"
      },
      "onTrue": [
        {
          "type": "email",
          "subject": "Great to connect",
          "content": "Sharing a quick overview."
        }
      ],
      "onFalse": [
        {
          "type": "task",
          "taskType": "TODO",
          "title": "Find email first",
          "ownerId": "owner-1"
        }
      ]
    }
  ]
}
'
{
  "status": "success",
  "message": "<string>",
  "data": {
    "id": 123,
    "name": "<string>",
    "status": "DRAFT",
    "identityId": 123,
    "warnings": [
      "<string>"
    ]
  }
}

Authorizations

x-api-key
string
header
required

Body

application/json
name
string
required

Campaign name.

Minimum string length: 1
steps
(email · object | linkedin_message · object | linkedin_inmail · object | linkedin_visit_profile · object | linkedin_like_last_post · object | condition · object | linkedin_connection · object | task · object | end · object)[]
required

Ordered campaign steps. Use branch arrays like onTrue, onFalse, onAccepted, and onNotAccepted for branching.

Minimum array length: 1
description
string | null

Optional campaign description.

identityId
integer | null
shouldAutomaticallySend
boolean
shouldSendTrackingPixel
boolean
excludeContactedLeads
boolean
allowedEmails
string<email>[]

Response

Campaign created successfully

status
enum<string>
required
Available options:
success
message
string
required
data
object
required