Record one factual event for a target (bounce, human reply, referral, request, unsubscribe...). Facts only; interpretation stays a separate Action command.

post/outreach/{id}/targets/{campaignTargetId}/events

Request

  • Base URL: https://forbiz.io/api/public/agent
  • URL: https://forbiz.io/api/public/agent/outreach/{id}/targets/{campaignTargetId}/events
  • Auth: HTTP bearer

Path parameters

idstring required
campaignTargetIdstring required

Headers

Idempotency-Keystring

Recommended on every mutating request. A replay with the same key is NOT applied twice: the server answers { ok, idempotent_replay: true, first_seen_at, status } describing the first attempt.

Request body

campaignTargetIdstring

Required in batch calls; taken from the path in single calls.

eventType'sent' | 'hard_bounce' | 'soft_bounce' | 'automated_acknowledgment' | 'human_reply' | 'referral' | 'product_information_request' | 'vault_specs_request' | 'battery_charging_confirmed' | 'meeting_interest' | 'pilot_interest' | 'quote_request' | 'not_responsible' | 'not_relevant' | 'unsubscribe' | 'out_of_office' | 'other' required
occurredAtstring date-time
eventDetailstring
executionIdstring

Must belong to the same outreach.

externalSourcestring
externalMessageIdstring

Used for natural idempotency per target + type.

externalThreadIdstring
confidencenumber
verificationStatusstring
supersedesEventIdstring

Corrections append a new event that supersedes a prior one. History is never deleted.

evidenceIdstring

Response

Event recorded

okboolean
insertedobject[]
skippedobject[]
conflictsobject[]
failedobject[]
compatibility_signalsobject

Derived campaign_targets.actual_signal per touched target.

Changes

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