Skip to content

by Startups.Studio

Contact.enrich

POST /{namespace}/contacts/{contact}/enrich

Enrich fills a Contact’s missing fields from outside sources and marks each value with where it came from.

Noun: Contact
Mode: do
Event: Contact.enriched

You, to your agent

Enrich the contact Daniel Okafor.

curl -X POST https://api.sb/shiftnote.app/contacts/contact_1/enrich \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY"

import { $ } from 'startup-builder'

const contact = await $.Contact.enrich({ contact: 'contact_1' })

npx startup-builder do Contact.enrich --json '{"contact":"contact_1"}'

{
  "name": "do",
  "arguments": {
    "code": "return await $.Contact.enrich({ contact: 'contact_1' })"
  }
}

Inputs

Input	Type	Required	Description
`contact`	Contact	required	The Contact to enrich.

Outputs

Output	Type	Required	Description
`contact`	Contact	required	The enriched Contact.

Effects

Emits Contact.enriched.
Performed by the Prospector.
Meters each lookup against the Startup’s usage Limit.

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.	Contact.enrich

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`.

Contact.delete

Previous Page

Contact.enroll

Next Page