Nooks

List companies in the Nooks workspace, filterable by name, domain, CRM ID or last-updated time. Use this to find the…

Retrieve one company by ID, including domain, headcount, description and linked CRM ID. Set…

List dials made through Nooks, with duration, direction, recording URL and the outcome the rep logged. Filter…

Retrieve one call by ID, including duration, from/to numbers, recording URL and references to the prospect, rep and…

List the call outcomes this workspace has configured, e.g. Connected, Voicemail, Meeting Booked. Call this to get…

Retrieve one call disposition by ID, including its label and the normalized outcome it rolls up to. Use…

List outreach emails with delivery and engagement data (delivered_at, opened_at, replied_at, open_count). Filter…

Retrieve one email by ID, including subject, HTML and text bodies, recipients and every engagement timestamp. Set…

Create a one-off email to a prospect, as a draft or sent immediately with send=true. Get prospect_id from…

Retrieve one email template by ID, including its subject and HTML body with any merge tokens. Nooks exposes no…

Pull 1-100 CRM records into Nooks as prospects and return the Nooks prospect_id for each. records takes CRM external…

List the sending mailboxes users have connected to Nooks, with which one is each user’s default. Call this to get…

Retrieve one mailbox by ID, including its address, whether it is the user’s default and a reference to its owner…

Write a note onto a prospect’s record in the connected CRM and return it with the CRM’s external ID. Use…

Write a note onto a company’s record in the connected CRM and return it with the CRM’s external ID. Use…

List the people Nooks sequences outreach to, filterable by name, title, primary email, CRM ID, account or enrolled…

Retrieve one prospect by ID, including title, primary email, LinkedIn URL and a reference to their account. Set…

List sequence enrollments; which prospects are in which sequence and where they are. Filter by sequence_id…

Retrieve one enrollment by ID, including its state and references to the sequence, prospect, owner and the step it…

Enroll a prospect in a sequence and return the new enrollment ID. Get prospect_id from list_prospects, sequence_id…

Remove a prospect’s enrollment from a sequence entirely, deleting its history and any pending tasks. Use…

Mark an enrollment finished: outreach stops and pending steps are cancelled, but the enrollment and its history…

List the steps of a sequence in order. Pass sequence_id (from list_sequences) to scope it; a sequence’s own record…

Retrieve one sequence step by ID, including its action, wait interval, order and any attached email template. Set…

Add a step to a sequence and return it with its new ID. Use list_sequences for sequence_id. interval is required…

Change a sequence step’s action, wait interval, name, note or email content. Pass at least one field. Nooks rejects…

Permanently delete a sequence step. Prospects already enrolled skip the removed step. Use list_sequence_steps to…

List outreach sequences, filterable by name, scheduling type and last-updated time. Use this to find the sequence_id…

Retrieve one sequence by ID, including its owner, scheduling type, enabled flag and privacy. Set include to…

Create an empty outreach sequence and return it with its new ID. Call get_current_user or list_users first for…

Rename a sequence, or enable/archive it. Nooks accepts only name and enabled here; pass at least one. Use…

Reorder a sequence’s steps. step_ids must be the COMPLETE ordered list of that sequence’s step IDs in the new order…

List rep tasks; the work queue. Filter server-side by owner_id, prospect_id, sequence_id, actions, statuses…

Retrieve one task by ID, including its action, due date, priority, status and references to the owner, prospect and…

Create a one-off task for a rep and return it with its new ID. Get owner_id from get_current_user or list_users, and…

Reschedule, reassign or reprioritize a task, or change its note. Nooks accepts only due_at, owner_id, priority and…

Permanently delete a task. Use complete_task or skip_task to close a task out and keep the activity record; deleting…

Mark a task done and advance its sequence enrollment to the next step. This is the normal way to close a task; use…

Skip a task without doing it and advance its sequence enrollment past that step. Use complete_task when the work was…

Identify the Nooks workspace and user behind the current credential, and return that user’s Firebase UID. Call this…

List users in the Nooks workspace, filterable by name, email or CRM ID. Use this to find the owner_id (a Firebase…

Retrieve one Nooks workspace user by their Firebase UID, including name, email and linked CRM ID. Use list_users to…