Campaigns

Get the message preview for a step

What a step would send to the lead of one of the campaign's enrollments, from the step's account. Nothing is sent or saved. AI steps write the message fresh on every call, from the lead's current profile, posts and conversation, so two calls can differ and each one reads the channel as the sending account.

GET

/api/v1/campaigns/{campaignId}/steps/{nodeId}/message-preview

Path parameters

campaignId

required

string · uuid

Campaign id

nodeId

required

string

Step id, the node id in the campaign graph

Query parameters

enrollmentId

required

string · uuid

An enrollment in this campaign; its lead is the one written to. List them with GET /campaigns/{campaignId}/leads.

Response

200The message, or status unavailable with the reason there is none.

preview

object

requestId

string · uuid

Id of this request, for support and troubleshooting

Errors

  • 400: Bad request
  • 401: Unauthorized: missing or invalid API key
  • 403: Forbidden
  • 404: Not found
  • 422: Invalid request payload

Search docs

Search documentation, API reference, and MCP tools

We use cookies to enhance your experience on Needle and keep your data secure. Privacy Policy