HandToHuman CLI reference All commands
DocsCLImarket campaign-create

Public command

market campaign-create

Open a campaign: one brief, one budget, several suppliers.

Exact invocation
handtohuman market campaign-create <BUYER_ID> --kind <KIND> --brief <FILE> --budget-cents <N> --currency <CODE> --spots <N> [--bonus-per-1k-cents <N>] [--bonus-cap-cents <N>]
01

Inputs and options

<BUYER_ID>

Customer account opening the campaign.

--kind <KIND>

What the campaign buys; every order inside it must be an offer of the same kind.

--brief <FILE>

File holding the brief every supplier works against.

--budget-cents <N>

The envelope. Orders reserve against it and cannot exceed it.

--currency <CODE>

Required three-letter code the budget is in; no currency is assumed.

--spots <N>

How many suppliers the campaign will book.

--bonus-per-1k-cents <N>

Optional performance rate per thousand measured units; defaults to 0.

--bonus-cap-cents <N>

Ceiling on one order’s bonus. Required whenever a rate is set.

02

Output and state effect

Result

Creates an open campaign and returns it with committed_cents, remaining_cents, and order_count computed from the orders drawn against it. No money moves here: funding happens per order.

Serialization

Prints the campaign as pretty-printed JSON.

Refusals

  • An account that is not a customer refuses with account <id> cannot open campaigns.
  • A non-positive budget or spot count is refused by name.
  • A bonus rate with no cap refuses with a performance bonus needs a cap: an uncapped bonus cannot be escrowed.