Skip to content

by Startups.Studio

Visitor.identify

POST /{namespace}/visitors/{visitor}/identify

Identify joins a Visitor to the Contact it turns out to be, so earlier Visits count toward that person.

Noun: Visitor
Mode: do
Event: Visitor.identified

You, to your agent

Identify the latest visitor with a contact.

curl -X POST https://api.sb/petpantry.shop/visitors/visitor_1/identify \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"contact":"contact_1"}'

import { $ } from 'startup-builder'

const { contact, visitor } = await $.Visitor.identify({ visitor: 'visitor_1', contact: 'contact_1' })

npx startup-builder do Visitor.identify --json '{"visitor":"visitor_1","contact":"contact_1"}'

{
  "name": "do",
  "arguments": {
    "code": "return await $.Visitor.identify({ visitor: 'visitor_1', contact: 'contact_1' })"
  }
}

Inputs

Input	Type	Required	Description
`visitor`	Visitor	required	The Visitor.
`contact`	Contact	required	The Contact or Customer the Visitor is.

Outputs

Output	Type	Required	Description
`contact`	Contact	required	The Contact, with the Visitor’s Visits attached.
`visitor`	Visitor	required	The Visitor, now joined to its Contact.

Effects

Emits Visitor.identified.
Performed by the Analyst.
Two-way: it runs at once, in the try, send and do modes.
Runs at sign-up, sign-in and checkout without a call.

Refuses when

Check	Error	Fix	Then call
The key is valid, but its scopes do not allow this operation.	`forbidden`	Use a key whose scopes cover the operation, or ask an owner of the namespace to grant them.	Visitor.identify

When it waits

Gate	Default
Decision class	Low: two-way, nothing at stake
Delay window	None: it runs once review passes.
Limit	The call Limit of the Permission it runs under.
Over the Limit	It waits `pending` for an Approval from the Founder. Approved, it runs; refused, it ends `refused` with `limit-exceeded`; unanswered by its deadline, it ends `canceled`.

Visitor.get

Previous Page

Visitor.list

Next Page