Remember that external work has been PREPARED for this action (for example a Gmail draft was created). Does not change the action's lifecycle, status or expected_signal_at. Re-posting the same externalSource + externalDraftId returns the existing record with duplicate_preparation_rejected: true instead of creating a second one.

post/actions/{id}/preparations

Request

  • Base URL: https://forbiz.io/api/public/agent
  • URL: https://forbiz.io/api/public/agent/actions/{id}/preparations
  • Auth: HTTP bearer

Path parameters

idstring 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

externalSourcestring required

For example 'gmail'.

externalDraftIdstring

Stable external id; guarantees the same draft is never remembered twice.

externalThreadIdstring
channel'email' | 'phone' | 'linkedin' | 'meeting' | 'other'
campaignTargetIdstring
outreachIdstring
recipientSnapshotstring
subjectSnapshotstring
bodySnapshotstring

Hashed for comparison; the hash is stored, not required from the caller.

preparedAtstring date-time
evidenceIdstring
notestring

Response

Duplicate external draft; nothing created

okboolean
duplicate_preparation_rejectedboolean
action_unchangedobject

Changes

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