Skip to content

Visitor.merge

Joins two Visitor ids that belong to one person and keeps both as aliases.

Action class
None
Approval
Runs on its own
Emits
Visitor.merged
Price
Free
POST https://api.sb/{your-domain}/visitors/{visitor}/merge

Its Inputs, Outputs, Effects and guards quote the hub’s Visitor.merge; this page adds what each Venue honors, its limits and a worked call. It is one of the Verbs of Forms and waitlists.

Inputs

NameTypeDefaultMeaning
visitorVisitorRequiredThe Visitor to merge.
intoVisitorRequiredThe Visitor that remains.

Outputs

FieldTypeWhat null means
visitorVisitorNever null: the remaining Visitor.

Effects

Action class

None: no approval rule names it, so it runs within its seat’s Permissions and Limits

Modes
  • try: Runs every check and returns the record as it would be; nothing is stored.
  • send: Returns a pending Action at once; Visitor.merged fires when it is done.
  • do: Waits for the Action to finish and returns the record.
Idempotency

Only with a key: the same Idempotency-Key and input return the first Action, and the same key with other input returns 409.

Saved or shared

Events never move or change; reads follow the alias.

Emits

Visitor.merged with { visitor }

Performed by

Analyst

Price

Free on your own account: the platform charges nothing for the call.

On each Venue

It acts on your own records and reaches no Venue, so every account answers the same way.

What try does

Runs every check the call meets and returns the record as it would be; nothing is stored, sent or posted.

Refuses when

The hub sets no guard of its own on this call: it refuses only on the shared checks every write meets (a missing record, a Permission the seat lacks).

When it waits

Returns in one response; nothing waits.

Example

In send mode the call returns its pending Action at once, and Visitor.merged delivers the result.

You, to your agent
Two visitor ids are the same laptop before and after a cookie reset:
merge them.
Response, in send mode
{
  "mode": "send",
  "action": {
    "$id": "https://api.sb/leaseline.app/actions/action_Sd3kQ9vT2w",
    "operation": "Visitor.merge",
    "status": "pending",
    "reason": "running"
  }
}

To retry, send the same Idempotency-Key: the retry returns the first answer for $0. A new key reads again.

Used by

None.