Client onboarding

atlas_onboarding_archive

Archive a client onboarding so it no longer appears in lists. It stays readable with includeArchived on atlas_onboarding_list. Returns a confirmation.

Scope

onboarding:write

Calls

DELETE /v1/client-onboarding/{id}

Example prompt

Archive the finished Globex onboarding.

Arguments

atlas_onboarding_attachments_delete

Delete a file attached to a client onboarding. The file is removed from the onboarding and its stored copy is purged. Returns nothing on success.

Scope

attachments:write

Calls

DELETE /client-onboarding/{onboardingId}/attachments/{attachmentId}

Example prompt

Delete the outdated statement of work from the Acme onboarding.

Arguments

atlas_onboarding_attachments_download

Get a short-lived signed URL to download one file attached to a client onboarding. Returns the URL and when it expires.

Scope

attachments:read

Calls

GET /client-onboarding/{onboardingId}/attachments/{attachmentId}/download

Example prompt

Get me a download link for the Acme statement of work.

Arguments

atlas_onboarding_attachments_list

List the files attached to a client onboarding, such as the statement of work or a signed form, with their names, sizes and types. Also returns what the storage accepts.

Scope

attachments:read

Calls

GET /client-onboarding/{onboardingId}/attachments

Example prompt

What files are attached to the Acme onboarding?

Arguments

atlas_onboarding_attachments_upload_finalize

Complete a client onboarding file upload after the bytes have been sent to the signed URL. The stored object is checked against the declared size and type before the attachment becomes visible. Returns the attachment.

Scope

attachments:write

Calls

POST /client-onboarding/{onboardingId}/attachments/{attachmentId}/finalize

Example prompt

Finish attaching the statement of work to the Acme onboarding.

Arguments

atlas_onboarding_attachments_upload_start

Begin attaching a file to a client onboarding. Returns an attachment id, a signed upload URL, the method and headers to use, and when the URL expires. Upload the bytes to that URL, then call atlas_onboarding_attachments_upload_finalize.

Scope

attachments:write

Calls

POST /client-onboarding/{onboardingId}/attachments/ticket

Example prompt

Attach the signed statement of work to the Acme onboarding.

Arguments

atlas_onboarding_backfill_run

Create onboardings for deals won since a date that never got one, for example before the module was switched on. Run with dryRun set to true first to see the count, because a real run can create many records. Repeating a run creates nothing twice. Administrators only. Returns how many deals were scanned, created and skipped.

Scope

onboarding:write

Calls

POST /v1/client-onboarding/backfill

Example prompt

How many onboardings would be created for deals won since January?

Arguments

atlas_onboarding_channel_create

Open the chat channel bound to a client onboarding, or return the one that already exists. Returns the channel id and whether it was created now. Safe to call more than once.

Scope

onboarding:write

Calls

POST /v1/client-onboarding/{id}/channel

Example prompt

Open a channel for the Acme onboarding.

Arguments

atlas_onboarding_comments_create

Post a comment on a client onboarding, or a reply when parentCommentId is given. Use this for discussion among the team. Returns the comment.

Scope

comments:write

Calls

POST /client-onboarding/{clientOnboardingId}/comments

Example prompt

Comment on the Acme onboarding that kickoff is booked for Tuesday.

Arguments

atlas_onboarding_comments_list

List the comment thread on a client onboarding, oldest first, with keyset pagination. Returns items and nextCursor; follow nextCursor until it is null.

Scope

comments:read

Calls

GET /client-onboarding/{clientOnboardingId}/comments

Example prompt

What has the team said on the Acme onboarding?

Arguments

atlas_onboarding_get

Get one client onboarding in full: the record, every phase, every checklist task with its owner, due date and blocked reason, the deals and signed agreements that started it, and the attached links. Use this before answering any detailed question about a single customer.

Scope

onboarding:read

Calls

GET /v1/client-onboarding/{id}

Example prompt

Show me the Northwind onboarding in full.

Arguments

atlas_onboarding_links_add

Attach an external link to a client onboarding, such as a Slack thread, an email thread, or a shared document. The link is classified and de-duplicated automatically, so attaching the same resource twice is harmless.

Scope

onboarding:write

Calls

POST /v1/client-onboarding/{id}/links

Example prompt

Attach the Northwind kickoff Slack thread to their onboarding.

Arguments

atlas_onboarding_links_remove

Remove an external link attached to a client onboarding, such as a Slack thread or document that turned out to be unrelated. Returns a confirmation.

Scope

onboarding:write

Calls

DELETE /v1/client-onboarding/{id}/links/{taskId}

Example prompt

Remove the unrelated document link from the Acme onboarding.

Arguments

atlas_onboarding_list

List client onboardings with optional status, account, owner and free-text filters. Each row carries the client name, phase progress, owner and target go-live date. Use this to answer "which customers are we onboarding" or "what is at risk". Pass `nextCursor` back as `cursor` for the next page.

Scope

onboarding:read

Calls

GET /v1/client-onboarding

Example prompt

Which customers are we onboarding right now?

Arguments

atlas_onboarding_project_link

Link a client onboarding to a project: an existing one when projectId is given, otherwise a new project owned by the given or default team. Returns the onboarding, whether a project was linked, and the reason when it was not.

Scope

onboarding:write

Calls

POST /v1/client-onboarding/{id}/project

Example prompt

Link the Acme onboarding to the Acme rollout project.

Arguments

atlas_onboarding_project_unlink

Unlink the project from a client onboarding. The project itself is kept. Returns the onboarding.

Scope

onboarding:write

Calls

DELETE /v1/client-onboarding/{id}/project

Example prompt

Unlink the wrong project from the Acme onboarding.

Arguments

atlas_onboarding_report_export

Export the account pack for a client onboarding: who the client is, what they bought, where the onboarding stands, what is stuck and what has happened. The md format returns it as Markdown text. The pdf, xlsx and docx formats return the method and path to download the file with the same credentials, because binary content cannot travel through this tool.

Scope

onboarding:read

Calls

GET /v1/client-onboarding/{id}/report

Example prompt

Give me the account pack for Acme before my call.

Arguments

atlas_onboarding_settings_get

Read the client onboarding settings of this workspace: the default template and team, which events start an onboarding automatically, whether projects are created, whether the CRM lifecycle moves with it, and how external conversations are mirrored.

Scope

onboarding:read

Calls

GET /v1/client-onboarding/settings

Example prompt

Does a won deal start an onboarding automatically?

Arguments

This tool takes no arguments.

atlas_onboarding_settings_update

Change the client onboarding settings of this workspace, such as whether a won deal or a signed agreement starts an onboarding automatically, or which template is the default. Only the fields given change. Administrators only. Returns the settings.

Scope

onboarding:write

Calls

PATCH /v1/client-onboarding/settings

Example prompt

Start an onboarding automatically whenever a deal is won.

Arguments

atlas_onboarding_start

Start onboarding a client account, applying the tenant default template unless another is named. Safe to retry when an idempotencyKey is supplied. If the client already has an onboarding in progress, the existing one is returned rather than a duplicate being created.

Scope

onboarding:write

Calls

POST /v1/client-onboarding

Example prompt

Start onboarding the Northwind account on the standard template.

Arguments

atlas_onboarding_tasks_bulk_update

Change up to 200 checklist tasks of one onboarding at once: their status, assignee, phase or due date. Returns the ids updated and, for any that failed, the reason.

Scope

onboarding:write

Calls

POST /v1/client-onboarding/{id}/tasks/bulk

Example prompt

Mark all the kickoff tasks for Acme done.

Arguments

atlas_onboarding_tasks_convert

File an onboarding checklist task as a real task in a project, so it is tracked with the rest of the work. Calling it again returns the task already filed rather than a duplicate. Returns the checklist task, the project task id and whether it was created now.

Scope

onboarding:write

Calls

POST /v1/client-onboarding/{id}/tasks/{taskId}/convert-to-task

Example prompt

Turn the SSO setup checklist item into a task in the Acme project.

Arguments

atlas_onboarding_tasks_create

Add a checklist task to a client onboarding. Use this when work comes up that the template did not anticipate.

Scope

onboarding:write

Calls

POST /v1/client-onboarding/{id}/tasks

Example prompt

Add a task to the Northwind onboarding for the data migration sign-off.

Arguments

atlas_onboarding_tasks_update

Update one checklist task: mark it done, reassign it, change its due date, or record why it is blocked. Progress on the parent onboarding is recalculated automatically.

Scope

onboarding:write

Calls

PATCH /v1/client-onboarding/{id}/tasks/{taskId}

Example prompt

Mark the Northwind kickoff call done and reassign the training task to Priya.

Arguments

atlas_onboarding_templates_create

Create an onboarding template: its phases and the checklist tasks in each, with owning roles and due offsets. A task names its phase by position in the stages array. Returns the template.

Scope

onboarding:write

Calls

POST /v1/client-onboarding/templates

Example prompt

Create an Enterprise onboarding template with a kickoff phase.

Arguments

atlas_onboarding_templates_delete

Delete an onboarding template. Built-in templates cannot be deleted, and onboardings already started from it are unchanged. Returns a confirmation.

Scope

onboarding:write

Calls

DELETE /v1/client-onboarding/templates/{id}

Example prompt

Delete the old pilot onboarding template.

Arguments

atlas_onboarding_templates_duplicate

Copy an onboarding template, including its phases and tasks, as a starting point for a variant. Built-in templates can be copied and then edited. Returns the copy.

Scope

onboarding:write

Calls

POST /v1/client-onboarding/templates/{id}/duplicate

Example prompt

Copy the Enterprise template so I can make a lighter version.

Arguments

atlas_onboarding_templates_get

Get one onboarding template in full: its phases, checklist tasks, owning roles and due offsets, and whether it is the workspace default. Use this before editing or duplicating a template.

Scope

onboarding:read

Calls

GET /v1/client-onboarding/templates/{id}

Example prompt

Show me the phases and tasks in the Enterprise template.

Arguments

atlas_onboarding_templates_list

List the onboarding templates available in this workspace, including which one is the default. Use this before starting an onboarding when the caller wants a specific plan.

Scope

onboarding:read

Calls

GET /v1/client-onboarding/templates

Example prompt

Which onboarding templates can I choose from?

Arguments

This tool takes no arguments.

atlas_onboarding_templates_update

Edit an onboarding template. stages and tasks each replace the whole list when given. Onboardings already started from it are unchanged. Pass expectedVersion to refuse the edit if somebody else changed it first. Returns the template.

Scope

onboarding:write

Calls

PATCH /v1/client-onboarding/templates/{id}

Example prompt

Add a security review task to the Enterprise template.

Arguments

atlas_onboarding_timeline_get

Read the activity timeline for a client onboarding, newest first, with optional kind and source filters and keyset pagination. Covers checklist changes, comments, documents, attached links and mirrored external conversations. Follow nextCursor until it is null: a short page does not mean the end.

Scope

onboarding:read

Calls

GET /v1/client-onboarding/{id}/timeline

Example prompt

What has happened on the Northwind onboarding this week?

Arguments

atlas_onboarding_update

Edit a client onboarding: its name, owner, target go-live date, notes or status. Completing or cancelling is not possible here: completing means advancing every phase, and both belong to a person in Atlas. Only the fields given change. Pass expectedVersion to refuse the edit if somebody else changed it first. Returns the onboarding.

Scope

onboarding:write

Calls

PATCH /v1/client-onboarding/{id}

Example prompt

Move the Acme go-live date to 1 November.

Arguments