Skip to main content
Copy a rep onto another sub-account of its agency, or move it there. A copy is a new rep, and the original stays as it is. A move keeps the same rep, with its id, history and builder chat. Both need agents:write, the rep’s tfu_live: id and its current locationId.

Step 1: Read the plan

Call Preview TFU Live agent clone or Preview TFU Live agent move with toLocationId. It writes nothing. Its mode is copy or move, and it lists:
  • inputs: the questions. Each has the new sub-account’s options, a suggested match of the same name, and a default.
  • carried: what comes across.
  • removed: what is removed with no question, such as a step the new CRM cannot run.
  • wontMove: what stays behind, such as calls, or a merge field inside a message.
  • leftToSetUp: what is left blank. Go-live asks for each one.
Each item has a code to branch on and a message in words. Keep the plan’s fingerprint.

Step 2: Answer the questions

Put your answers in answers, under each input’s id. Send an option’s id, or one of the input’s choices: An input you leave out takes its default. With no answers at all, every input does. An input whose default is null has required: true. Answer it, or the request is refused. Transfer and alert inputs start new. The old sub-account’s people are never suggested or kept. Pick from options. Otherwise the default is later, or remove where go-live cannot ask. An API key or OAuth client cannot answer create_field. Pick one of the new sub-account’s fields from options instead. Only a signed-in person can have a field made.

Step 3: Copy or move

Send your answers, and the fingerprint as ifPlan.
  • Clone TFU Live agent takes toLocationId, a stable requestId, and an optional name and activeTags. The same requestId with other answers makes another copy. The copy starts paused, with no numbers.
  • Move TFU Live agent takes toLocationId and the ifVersion you read. Each number comes when it can. One that cannot stays on the old sub-account, and the result lists it. The old campaign is retired, and a paused one is made.
A plan with live: true is a move of a live rep. Its new campaign takes test calls until it goes live there. The move switches it on only when nothing is left to set up and the moved version is ready. A move that changed the rep’s steps starts preparing that version, and the campaign stays paused. The result’s live and goLiveBlockers say which. Then use Go live and pause. A website widget’s code names its campaign, and a move retires the old one. When the rep’s campaign names websites for its widget, the result has widget.campaignId. Paste the widget code of that campaign on the site, in place of the old code.

When it is refused