Skip to main content
POST
/
v1
/
campaigns
/
{id}
/
steps
Add Step to Campaign
curl --request POST \
  --url https://app-api.walead.ai/api/v1/campaigns/{id}/steps \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "type": "invitation",
  "order": 123
}
'
{
  "success": true,
  "message": "<string>",
  "steps": [
    {
      "id": "<string>",
      "type": "invitation",
      "order": 123,
      "delay": 123,
      "stopOnReply": true,
      "genericBody": "<string>",
      "variants": [
        {
          "id": "<string>",
          "body": "<string>",
          "order": 123,
          "isDisabled": true,
          "icpDefinitionRaw": "<string>",
          "stepId": "<string>",
          "aiTools": [
            {
              "name": "<string>",
              "key": "<string>"
            }
          ]
        }
      ]
    }
  ]
}

Documentation Index

Fetch the complete documentation index at: https://docs.walead.ai/llms.txt

Use this file to discover all available pages before exploring further.

​
Overview

Adds a new step to a campaign’s sequence at a specified position. This automatically reorders existing steps and updates leads already in the campaign to account for the new step.

​
Step Types

Sends a LinkedIn connection request to the lead. This is typically the first step in a campaign.
Sends a message to the lead. Can be sent to connections or used for InMail. Supports message variants for A/B testing.
Visits the lead’s LinkedIn profile to increase visibility.
Sends a qualifying message to determine if the lead is a good fit. Supports AI-powered analysis of responses.

​
Request Body

{
  "type": "message",
  "order": 2
}
The order field determines where in the sequence the step will be inserted (0-based index).

​
Automatic Handling

When you add a step:
  • Existing steps at or after the specified order are shifted down
  • Leads already in the campaign have their progress adjusted
  • Completed campaigns are reset to “paused” status if new steps are added
  • Message and screener steps automatically get a default variant created

​
Response

Returns the updated complete array of steps with their IDs, allowing you to immediately reference the new step for adding variants or further configuration.

Authorizations

​
x-api-key
string
header
required

API key for authentication. Generate from your WaLead dashboard.

Path Parameters

​
id
string
required

Campaign ID

Body

application/json

Step details

​
type
enum<string>
required

Type of step to add

Available options:
invitation,
message,
visit_profile,
screener
​
order
integer
required

Position in the sequence (0-based)

Response

Step added successfully

​
success
boolean
​
message
string
​
steps
object[]