campaigns

Set up, pause, or resume campaign outreach. Paused follow-ups expire 14 days after scheduled send_at; pause returns held

post/api/v1/campaigns/{campaign_id}/outreach

Request

  • Base URL: https://crispy.sh
  • URL: https://crispy.sh/api/v1/campaigns/{campaign_id}/outreach
  • Auth: HTTP bearer

Path parameters

campaign_idstring required

Path parameter: campaign_id

Request body

list_idstring

List ID containing contacts to invite (for action='setup')

daily_invitesnumber

Campaign's requested invitations per day, 1-50. Enabled acquisition campaigns on the same sender account use a shared pool whose daily ceiling is the highest daily_invites among them (for action='setup')

invite_messagestring

Invite note template with {first_name} etc., max 300 chars (for action='setup')

enabledboolean

For action='pause'/'resume': true to resume, false to pause. For action='setup': default false (configure-only). Pass true with launch_receipt to enable and skip the explicit resume step. Pre-2026-06-02 setup auto-enabled; that behavior is now opt-in via this flag (N16/N18 fix).

launch_receiptstring

Required to turn a paused campaign on (action='resume', or action='setup' with enabled:true). The launch_receipt from preview_campaign_launch; single-use, refused if the config changed after the preview.

stepsobject[]

Ordered action steps for this campaign. Steps before the invite are warmup actions (type: 'view_profile'|'like_post'|'endorse_skill', delay_seconds optional). Steps after the invite are follow-up messages (type: 'message'|'voice_note'|'image'|'video'|'webhook', delay_hours required). IMPORTANT: text DM follow-ups use type='message' (not 'text'). The invite fires automatically between warmup and follow-up steps. Omit to preserve existing steps. Pass [] to clear all steps.

Response

Success

Changes

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