Campaigns

Run a campaign simulation without side effects

Runs the campaign against sample leads and shows what it would have done. Nothing sends, and no enrollment state moves.

API key scopes: campaigns:write. You also need an Idempotency-Key header.

post/api/campaigns/{id}/simulations

Request

  • Base URL: https://api.setluca.com
  • URL: https://api.setluca.com/api/campaigns/{id}/simulations
  • Auth: one of:
    • API key in cookie luca.session_token
    • API key in header x-api-key
    • HTTP bearer

Path parameters

idstring uuid required

Identifier of the campaign this operation targets.

Headers

Luca-API-Version'1'

The major version of the API this client was built against. Omit it and the request is served by the current major version. Any other value is refused with 400 unsupported_api_version.

Request body

sourceKind'fake_input' | 'seed_case' | 'replayed_enrollment'
eventType'instagram_comment' | 'instagram_dm' | 'whatsapp_reply' | 'booking_event' | 'crm_event' | 'webhook_event' | 'csv_import' | 'manual_enrollment'
startNodeIdstring
leadobject
eventPayloadobject
contextobject
replayedEnrollmentIdstring uuid
maxStepsinteger

Response

ok

idstring uuid required
campaignIdstring uuid required
sourceKind'fake_input' | 'seed_case' | 'replayed_enrollment' required
eventType'instagram_comment' | 'instagram_dm' | 'whatsapp_reply' | 'booking_event' | 'crm_event' | 'webhook_event' | 'csv_import' | 'manual_enrollment' required
status'completed' | 'waiting' | 'blocked' | 'max_steps' required
finalNodeIdstring nullable required
createdByUserIdstring nullable required
createdAtstring required
updatedAtstring required
draftGraphHashstring required
campaignVersionIdstring uuid nullable required
replayedEnrollmentIdstring uuid nullable required
generatedDraftsstring[] required
mockedSideEffectsobject[] required
outcomeobject required

Changes

No recorded changes to this operation across all 1 revision of this API.