Skip to content

by Startups.Studio

Contact.enroll

POST /{namespace}/contacts/{contact}/enroll

Enroll adds a Contact to a Sequence, which sends its steps until the Contact replies or exits.

Noun: Contact
Mode: do
Event: Contact.enrolled

You, to your agent

Enroll the contact Malik Owens with a sequence.

curl -X POST https://api.sb/tutorloop.com/contacts/contact_1/enroll \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"sequence":"sequence_1"}'

import { $ } from 'startup-builder'

const { contact, enrollment } = await $.Contact.enroll({ contact: 'contact_1', sequence: 'sequence_1' })

npx startup-builder do Contact.enroll --json '{"contact":"contact_1","sequence":"sequence_1"}'

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

Inputs

Input	Type	Required	Description
`contact`	Contact	required	The Contact to enroll.
`sequence`	Sequence	required	The Sequence to run.

Outputs

Output	Type	Required	Description
`contact`	Contact	required	The enrolled Contact.
`enrollment`	Enrollment	required	The Enrollment that records this Contact’s run through the Sequence.

Effects

Emits Contact.enrolled.
Performed by the Prospector.
Refuses a suppressed Contact or one with no consent for the Sequence’s purpose.

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.enroll
The record is not in a state that allows this Verb, so the call is refused.	`refused`	Read the record, run the Verb that moves it to an allowed state, then retry.	Contact.enroll
A suppressed Contact or one with no consent for the Sequence’s purpose	`refused`	Clear what the check names, then call it again.	Contact.enroll

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

Previous Page

Contact.get

Next Page