campaigns

Get Campaign

get/api/v1/campaigns/{campaign_id}

Request

  • Base URL: https://api.nudgelink.co (the document declares no server; this is the origin it was published from)
  • URL: https://api.nudgelink.co/api/v1/campaigns/{campaign_id}
  • Auth: HTTP bearer

Path parameters

campaign_idstring uuid required

Response

Successful Response

idstring uuid required
namestring required
statusstring required
instruction_notestring nullable required
icp_overrideobject nullable required
account_idsstring[] nullable required
created_atstring date-time required
outreach_objective'adaptive' | 'conversation' | 'problem_discovery' | 'offer' required

The job the FIRST substantive message should accomplish (Outreach Objective Layer spec, 2026-07-20). A layer ABOVE the Voice Engine — it controls the message's goal and CTA, never the voice.

adaptive = NudgeLink resolves the concrete objective per lead from fit (relevance_score), intent (intent_score) and signals; the other three are the resolvable concrete objectives. Deliberately NOT a 1/2/3 scale — these are different jobs, not different aggressiveness levels. Member names equal their values (house convention) so SAEnum name/value storage agrees.

resolved_outreach_objective'adaptive' | 'conversation' | 'problem_discovery' | 'offer' required

The job the FIRST substantive message should accomplish (Outreach Objective Layer spec, 2026-07-20). A layer ABOVE the Voice Engine — it controls the message's goal and CTA, never the voice.

adaptive = NudgeLink resolves the concrete objective per lead from fit (relevance_score), intent (intent_score) and signals; the other three are the resolvable concrete objectives. Deliberately NOT a 1/2/3 scale — these are different jobs, not different aggressiveness levels. Member names equal their values (house convention) so SAEnum name/value storage agrees.

outreach_objective_sourcestring required
style_profileobject nullable required
languagesstring[] nullable required
email_modestring
mailbox_idstring uuid nullable

Changes

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