Client onboarding

Every Client onboarding tool, with the scope it needs, its arguments and the API operation it calls.

32 tools

Archive onboarding

Destructive

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

Field	Type	Required	Description
`id`	`string`	Yes	The client onboarding id.

Delete onboarding attachments

Destructive

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

Field	Type	Required	Description
`id`	`string`	Yes	The client onboarding id.
`attachmentId`	`string`	Yes	The attachment id.

Download onboarding attachments

Read only

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

Field	Type	Required	Description
`id`	`string`	Yes	The client onboarding id.
`attachmentId`	`string`	Yes	The attachment id.

List onboarding attachments

Read only

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

Field	Type	Required	Description
`id`	`string`	Yes	The client onboarding id.

Finalize onboarding attachments upload

Changes data

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

Field	Type	Required	Description
`id`	`string`	Yes	The client onboarding id.
`attachmentId`	`string`	Yes	The attachment id.
`actualSizeBytes`	`integer`	Yes	The size actually uploaded, in bytes.
`actualContentType`	`string`	Yes	The MIME type actually uploaded.

Start onboarding attachments upload

Changes data

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

Field	Type	Required	Description
`id`	`string`	Yes	The client onboarding id.
`name`	`string`	Yes	The file name.
`contentType`	`string`	Yes	The MIME type, for example application/pdf.
`sizeBytes`	`integer`	Yes	The file size in bytes.

Run onboarding backfill

Changes data

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

Field	Type	Required	Description
`since`	`string (date-time)`	Yes	ISO-8601 instant. Deals won on or after it are considered.
`dryRun`	`boolean`	No	Count what would be created without creating anything.
`limit`	`integer`	No	How many deals to process in this run, 1 to 500. Defaults to 100.

Create onboarding channel

Changes data

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

Field	Type	Required	Description
`id`	`string`	Yes	The client onboarding id.

Create onboarding comments

Changes data

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

Field	Type	Required	Description
`id`	`string`	Yes	The client onboarding id.
`body`	`string`	Yes	The comment text.
`parentCommentId`	`string`	No	The comment this replies to.

List onboarding comments

Read only

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

Field	Type	Required	Description
`id`	`string`	Yes	The client onboarding id.
`cursor`	`string`	No	The cursor from a previous page.
`limit`	`integer`	No	Page size, 1 to 200. Defaults to 100.

Get onboarding

Read only

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

Field	Type	Required	Description
`id`	`string`	Yes	The client onboarding id.

Add onboarding links

Changes data

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

Field	Type	Required	Description
`id`	`string`	Yes	The client onboarding id.
`url`	`string (uri)`	Yes	Link to attach, for example a Slack thread or a document.
`title`	`string`	No	Label for the link.
`description`	`string`	No	Why this link matters.

Remove onboarding links

Destructive

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

Field	Type	Required	Description
`id`	`string`	Yes	The client onboarding id.
`linkId`	`string`	Yes	The attached link id.

List onboarding

Read only

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

Scope: onboarding:read
Calls: GET /v1/client-onboarding
Example prompt: Which customers are we onboarding right now?

Arguments

Field	Type	Required	Description
`status`	`"NOT_STARTED" \| "IN_PROGRESS" \| "BLOCKED" \| "COMPLETED" \| "CANCELLED"`	No	Filter to one onboarding status.
`accountId`	`string`	No	Filter to one CRM account id.
`ownerUserId`	`string`	No	Filter to one owner user id.
`q`	`string`	No	Free-text search over the client and onboarding name.
`includeArchived`	`boolean`	No	Include archived onboardings.
`limit`	`integer`	No	Page size (1..200).

Link onboarding project

Changes data

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

Field	Type	Required	Description
`id`	`string`	Yes	The client onboarding id.
`projectId`	`string`	No	An existing project to link. Omit to create a new project.
`teamId`	`string`	No	The team that owns a newly created project. Defaults to the workspace setting.

Unlink onboarding project

Destructive

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

Field	Type	Required	Description
`id`	`string`	Yes	The client onboarding id.

Export onboarding report

Read only

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

Field	Type	Required	Description
`id`	`string`	Yes	The client onboarding id.
`format`	`"md" \| "pdf" \| "xlsx" \| "docx"`	No	md returns the account pack as Markdown text. pdf, xlsx and docx return the download request, because a binary file cannot travel through this tool.

Get onboarding settings

Read only

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.

Update onboarding settings

Changes data

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

Field	Type	Required	Description
`defaultTemplateId`	`string \| null`	No	The template used when none is named. Null clears it.
`defaultTeamId`	`string \| null`	No	The team that owns projects created for onboardings.
`autoStartOnDealWon`	`boolean`	No	Start an onboarding when a deal is won.
`autoStartOnAgreementSigned`	`boolean`	No	Start an onboarding when an agreement is signed.
`autoStartOnImport`	`boolean`	No	Start an onboarding for imported client accounts.
`autoCreateProject`	`boolean`	No	Create a project for each new onboarding.
`autoProjectTemplateId`	`string`	No	The project template for those projects.
`advanceAccountLifecycle`	`boolean`	No	Move the CRM account lifecycle forward as the onboarding progresses.
`notifyOwnerOnAutoStart`	`boolean`	No	Notify the owner when an onboarding starts automatically.
`mirrorExternalBodies`	`boolean`	No	Copy the text of linked external conversations into the timeline, rather than only a reference.

Start onboarding

Changes data

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

Field	Type	Required	Description
`accountId`	`string`	Yes	CRM account to onboard.
`templateId`	`string`	No	Template to use. Defaults to the tenant default.
`ownerUserId`	`string`	No	User who owns the onboarding.
`name`	`string`	No	Name for the onboarding.
`targetLiveAt`	`string (date-time)`	No	ISO-8601 target go-live date.
`dealId`	`string`	No	Deal that produced this onboarding.
`idempotencyKey`	`string`	No	Stable key so a retried call does not start a second onboarding.

Update onboarding tasks in bulk

Changes data

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

Field	Type	Required	Description
`id`	`string`	Yes	The client onboarding id.
`taskIds`	`array of string`	Yes	The checklist tasks to change, 1 to 200.
`status`	`"TODO" \| "IN_PROGRESS" \| "BLOCKED" \| "DONE" \| "SKIPPED"`	No	The new status for every task.
`assigneeUserId`	`string \| null`	No	The new assignee. Null unassigns them.
`stageId`	`string \| null`	No	The phase to move them to.
`dueAt`	`string (date-time) \| null`	No	ISO-8601 due date. Null clears it.

Convert onboarding tasks

Changes data

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

Field	Type	Required	Description
`id`	`string`	Yes	The client onboarding id.
`taskId`	`string`	Yes	The checklist task id.
`projectId`	`string`	No	The project to file the task in. Omit to use the linked project.

Create onboarding tasks

Changes data

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

Field	Type	Required	Description
`id`	`string`	Yes	The client onboarding id.
`title`	`string`	Yes	Task title.
`description`	`string`	No	Task detail.
`stageId`	`string`	No	Phase to add the task to.
`assigneeRole`	`"ACCOUNT_MANAGER" \| "IMPLEMENTATION_LEAD" \| "SUCCESS_MANAGER" \| "FINANCE" \| "IT" \| "CLIENT"`	No	Which role owns this task.
`assigneeUserId`	`string`	No	User to assign the task to.
`dueAt`	`string (date-time)`	No	ISO-8601 due date.
`required`	`boolean`	No	Counts toward completion. Defaults to true.
`blocking`	`boolean`	No	Blocks the phase until done. Defaults to false.

Update onboarding tasks

Changes data

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

Field	Type	Required	Description
`id`	`string`	Yes	The client onboarding id.
`taskId`	`string`	Yes	The checklist task id.
`status`	`"TODO" \| "IN_PROGRESS" \| "BLOCKED" \| "DONE" \| "SKIPPED"`	No	New task status.
`assigneeUserId`	`string`	No	User to assign the task to.
`dueAt`	`string (date-time)`	No	ISO-8601 due date.
`blockedReason`	`string`	No	Why the task is blocked.

Create onboarding templates

Changes data

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

Field	Type	Required	Description
`name`	`string`	Yes	The template name.
`description`	`string`	No	When to use this template.
`isDefault`	`boolean`	No	Make this the workspace default template.
`stages`	`array of object`	No	The phases, in order. At most 40.
`tasks`	`array of object`	No	The checklist tasks. At most 300.

Delete onboarding templates

Destructive

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

Field	Type	Required	Description
`id`	`string`	Yes	The onboarding template id.

Duplicate onboarding templates

Changes data

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

Field	Type	Required	Description
`id`	`string`	Yes	The onboarding template id.

Get onboarding templates

Read only

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

Field	Type	Required	Description
`id`	`string`	Yes	The onboarding template id.

List onboarding templates

Read only

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.

Update onboarding templates

Changes data

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

Field	Type	Required	Description
`id`	`string`	Yes	The onboarding template id.
`name`	`string`	No	A new name.
`description`	`string \| null`	No	A new description. Null clears it.
`isDefault`	`boolean`	No	Make this the workspace default template.
`stages`	`array of object`	No	The whole new list of phases. Replaces the list.
`tasks`	`array of object`	No	The whole new list of tasks. Replaces the list.
`expectedVersion`	`integer`	No	The version last read. The update is refused if somebody changed the template since.

Get onboarding timeline

Read only

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

Field	Type	Required	Description
`id`	`string`	Yes	The client onboarding id.
`kind`	`"CHAT_MESSAGE" \| "COMMENT" \| "DOC" \| "LINK" \| "ATTACHMENT" \| "EMAIL" \| "SLACK" \| "TASK" \| "STAGE" \| "MEMBERSHIP" \| "SYSTEM"`	No	Filter to one kind of activity.
`source`	`string`	No	Filter to one source, for example "slack".
`cursor`	`string`	No	Opaque keyset cursor from a previous page.
`limit`	`integer`	No	Page size (1..100).

Update onboarding

Changes data

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

Field	Type	Required	Description
`id`	`string`	Yes	The client onboarding id.
`name`	`string`	No	A new name.
`ownerUserId`	`string \| null`	No	The owner. Null unassigns it.
`targetLiveAt`	`string (date-time) \| null`	No	ISO-8601 target go-live date. Null clears it.
`notes`	`string \| null`	No	Free-text notes. Null clears them.
`status`	`"NOT_STARTED" \| "IN_PROGRESS" \| "BLOCKED"`	No	The new status. COMPLETED and CANCELLED are not accepted: completing and cancelling belong to a person in Atlas.
`expectedVersion`	`integer`	No	The version last read. The update is refused if somebody changed the onboarding since.

Tools reference

Client onboarding

Every Client onboarding tool, with the scope it needs, its arguments and the API operation it calls.

32 tools

Archive onboarding

Destructive

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

Field	Type	Required	Description
`id`	`string`	Yes	The client onboarding id.

Delete onboarding attachments

Destructive

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

Field	Type	Required	Description
`id`	`string`	Yes	The client onboarding id.
`attachmentId`	`string`	Yes	The attachment id.

Download onboarding attachments

Read only

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

Field	Type	Required	Description
`id`	`string`	Yes	The client onboarding id.
`attachmentId`	`string`	Yes	The attachment id.

List onboarding attachments

Read only

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

Field	Type	Required	Description
`id`	`string`	Yes	The client onboarding id.

Finalize onboarding attachments upload

Changes data

atlas_onboarding_attachments_upload_finalize

Scope: attachments:write
Calls: POST /client-onboarding/{onboardingId}/attachments/{attachmentId}/finalize
Example prompt: Finish attaching the statement of work to the Acme onboarding.

Arguments

Field	Type	Required	Description
`id`	`string`	Yes	The client onboarding id.
`attachmentId`	`string`	Yes	The attachment id.
`actualSizeBytes`	`integer`	Yes	The size actually uploaded, in bytes.
`actualContentType`	`string`	Yes	The MIME type actually uploaded.

Start onboarding attachments upload

Changes data

atlas_onboarding_attachments_upload_start

Scope: attachments:write
Calls: POST /client-onboarding/{onboardingId}/attachments/ticket
Example prompt: Attach the signed statement of work to the Acme onboarding.

Arguments

Field	Type	Required	Description
`id`	`string`	Yes	The client onboarding id.
`name`	`string`	Yes	The file name.
`contentType`	`string`	Yes	The MIME type, for example application/pdf.
`sizeBytes`	`integer`	Yes	The file size in bytes.

Run onboarding backfill

Changes data

atlas_onboarding_backfill_run

Scope: onboarding:write
Calls: POST /v1/client-onboarding/backfill
Example prompt: How many onboardings would be created for deals won since January?

Arguments

Field	Type	Required	Description
`since`	`string (date-time)`	Yes	ISO-8601 instant. Deals won on or after it are considered.
`dryRun`	`boolean`	No	Count what would be created without creating anything.
`limit`	`integer`	No	How many deals to process in this run, 1 to 500. Defaults to 100.

Create onboarding channel

Changes data

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

Field	Type	Required	Description
`id`	`string`	Yes	The client onboarding id.

Create onboarding comments

Changes data

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

Field	Type	Required	Description
`id`	`string`	Yes	The client onboarding id.
`body`	`string`	Yes	The comment text.
`parentCommentId`	`string`	No	The comment this replies to.

List onboarding comments

Read only

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

Field	Type	Required	Description
`id`	`string`	Yes	The client onboarding id.
`cursor`	`string`	No	The cursor from a previous page.
`limit`	`integer`	No	Page size, 1 to 200. Defaults to 100.

Get onboarding

Read only

atlas_onboarding_get

Scope: onboarding:read
Calls: GET /v1/client-onboarding/{id}
Example prompt: Show me the Northwind onboarding in full.

Arguments

Field	Type	Required	Description
`id`	`string`	Yes	The client onboarding id.

Add onboarding links

Changes data

atlas_onboarding_links_add

Scope: onboarding:write
Calls: POST /v1/client-onboarding/{id}/links
Example prompt: Attach the Northwind kickoff Slack thread to their onboarding.

Arguments

Field	Type	Required	Description
`id`	`string`	Yes	The client onboarding id.
`url`	`string (uri)`	Yes	Link to attach, for example a Slack thread or a document.
`title`	`string`	No	Label for the link.
`description`	`string`	No	Why this link matters.

Remove onboarding links

Destructive

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

Field	Type	Required	Description
`id`	`string`	Yes	The client onboarding id.
`linkId`	`string`	Yes	The attached link id.

List onboarding

Read only

atlas_onboarding_list

Scope: onboarding:read
Calls: GET /v1/client-onboarding
Example prompt: Which customers are we onboarding right now?

Arguments

Field	Type	Required	Description
`status`	`"NOT_STARTED" \| "IN_PROGRESS" \| "BLOCKED" \| "COMPLETED" \| "CANCELLED"`	No	Filter to one onboarding status.
`accountId`	`string`	No	Filter to one CRM account id.
`ownerUserId`	`string`	No	Filter to one owner user id.
`q`	`string`	No	Free-text search over the client and onboarding name.
`includeArchived`	`boolean`	No	Include archived onboardings.
`limit`	`integer`	No	Page size (1..200).

Link onboarding project

Changes data

atlas_onboarding_project_link

Scope: onboarding:write
Calls: POST /v1/client-onboarding/{id}/project
Example prompt: Link the Acme onboarding to the Acme rollout project.

Arguments

Field	Type	Required	Description
`id`	`string`	Yes	The client onboarding id.
`projectId`	`string`	No	An existing project to link. Omit to create a new project.
`teamId`	`string`	No	The team that owns a newly created project. Defaults to the workspace setting.

Unlink onboarding project

Destructive

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

Field	Type	Required	Description
`id`	`string`	Yes	The client onboarding id.

Export onboarding report

Read only

atlas_onboarding_report_export

Scope: onboarding:read
Calls: GET /v1/client-onboarding/{id}/report
Example prompt: Give me the account pack for Acme before my call.

Arguments

Field	Type	Required	Description
`id`	`string`	Yes	The client onboarding id.
`format`	`"md" \| "pdf" \| "xlsx" \| "docx"`	No	md returns the account pack as Markdown text. pdf, xlsx and docx return the download request, because a binary file cannot travel through this tool.

Get onboarding settings

Read only

atlas_onboarding_settings_get

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.

Update onboarding settings

Changes data

atlas_onboarding_settings_update

Scope: onboarding:write
Calls: PATCH /v1/client-onboarding/settings
Example prompt: Start an onboarding automatically whenever a deal is won.

Arguments

Field	Type	Required	Description
`defaultTemplateId`	`string \| null`	No	The template used when none is named. Null clears it.
`defaultTeamId`	`string \| null`	No	The team that owns projects created for onboardings.
`autoStartOnDealWon`	`boolean`	No	Start an onboarding when a deal is won.
`autoStartOnAgreementSigned`	`boolean`	No	Start an onboarding when an agreement is signed.
`autoStartOnImport`	`boolean`	No	Start an onboarding for imported client accounts.
`autoCreateProject`	`boolean`	No	Create a project for each new onboarding.
`autoProjectTemplateId`	`string`	No	The project template for those projects.
`advanceAccountLifecycle`	`boolean`	No	Move the CRM account lifecycle forward as the onboarding progresses.
`notifyOwnerOnAutoStart`	`boolean`	No	Notify the owner when an onboarding starts automatically.
`mirrorExternalBodies`	`boolean`	No	Copy the text of linked external conversations into the timeline, rather than only a reference.

Start onboarding

Changes data

atlas_onboarding_start

Scope: onboarding:write
Calls: POST /v1/client-onboarding
Example prompt: Start onboarding the Northwind account on the standard template.

Arguments

Field	Type	Required	Description
`accountId`	`string`	Yes	CRM account to onboard.
`templateId`	`string`	No	Template to use. Defaults to the tenant default.
`ownerUserId`	`string`	No	User who owns the onboarding.
`name`	`string`	No	Name for the onboarding.
`targetLiveAt`	`string (date-time)`	No	ISO-8601 target go-live date.
`dealId`	`string`	No	Deal that produced this onboarding.
`idempotencyKey`	`string`	No	Stable key so a retried call does not start a second onboarding.

Update onboarding tasks in bulk

Changes data

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

Field	Type	Required	Description
`id`	`string`	Yes	The client onboarding id.
`taskIds`	`array of string`	Yes	The checklist tasks to change, 1 to 200.
`status`	`"TODO" \| "IN_PROGRESS" \| "BLOCKED" \| "DONE" \| "SKIPPED"`	No	The new status for every task.
`assigneeUserId`	`string \| null`	No	The new assignee. Null unassigns them.
`stageId`	`string \| null`	No	The phase to move them to.
`dueAt`	`string (date-time) \| null`	No	ISO-8601 due date. Null clears it.

Convert onboarding tasks

Changes data

atlas_onboarding_tasks_convert

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

Field	Type	Required	Description
`id`	`string`	Yes	The client onboarding id.
`taskId`	`string`	Yes	The checklist task id.
`projectId`	`string`	No	The project to file the task in. Omit to use the linked project.

Create onboarding tasks

Changes data

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

Field	Type	Required	Description
`id`	`string`	Yes	The client onboarding id.
`title`	`string`	Yes	Task title.
`description`	`string`	No	Task detail.
`stageId`	`string`	No	Phase to add the task to.
`assigneeRole`	`"ACCOUNT_MANAGER" \| "IMPLEMENTATION_LEAD" \| "SUCCESS_MANAGER" \| "FINANCE" \| "IT" \| "CLIENT"`	No	Which role owns this task.
`assigneeUserId`	`string`	No	User to assign the task to.
`dueAt`	`string (date-time)`	No	ISO-8601 due date.
`required`	`boolean`	No	Counts toward completion. Defaults to true.
`blocking`	`boolean`	No	Blocks the phase until done. Defaults to false.

Update onboarding tasks

Changes data

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

Field	Type	Required	Description
`id`	`string`	Yes	The client onboarding id.
`taskId`	`string`	Yes	The checklist task id.
`status`	`"TODO" \| "IN_PROGRESS" \| "BLOCKED" \| "DONE" \| "SKIPPED"`	No	New task status.
`assigneeUserId`	`string`	No	User to assign the task to.
`dueAt`	`string (date-time)`	No	ISO-8601 due date.
`blockedReason`	`string`	No	Why the task is blocked.

Create onboarding templates

Changes data

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

Field	Type	Required	Description
`name`	`string`	Yes	The template name.
`description`	`string`	No	When to use this template.
`isDefault`	`boolean`	No	Make this the workspace default template.
`stages`	`array of object`	No	The phases, in order. At most 40.
`tasks`	`array of object`	No	The checklist tasks. At most 300.

Delete onboarding templates

Destructive

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

Field	Type	Required	Description
`id`	`string`	Yes	The onboarding template id.

Duplicate onboarding templates

Changes data

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

Field	Type	Required	Description
`id`	`string`	Yes	The onboarding template id.

Get onboarding templates

Read only

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

Field	Type	Required	Description
`id`	`string`	Yes	The onboarding template id.

List onboarding templates

Read only

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.

Update onboarding templates

Changes data

atlas_onboarding_templates_update

Scope: onboarding:write
Calls: PATCH /v1/client-onboarding/templates/{id}
Example prompt: Add a security review task to the Enterprise template.

Arguments

Field	Type	Required	Description
`id`	`string`	Yes	The onboarding template id.
`name`	`string`	No	A new name.
`description`	`string \| null`	No	A new description. Null clears it.
`isDefault`	`boolean`	No	Make this the workspace default template.
`stages`	`array of object`	No	The whole new list of phases. Replaces the list.
`tasks`	`array of object`	No	The whole new list of tasks. Replaces the list.
`expectedVersion`	`integer`	No	The version last read. The update is refused if somebody changed the template since.

Get onboarding timeline

Read only

atlas_onboarding_timeline_get

Scope: onboarding:read
Calls: GET /v1/client-onboarding/{id}/timeline
Example prompt: What has happened on the Northwind onboarding this week?

Arguments

Field	Type	Required	Description
`id`	`string`	Yes	The client onboarding id.
`kind`	`"CHAT_MESSAGE" \| "COMMENT" \| "DOC" \| "LINK" \| "ATTACHMENT" \| "EMAIL" \| "SLACK" \| "TASK" \| "STAGE" \| "MEMBERSHIP" \| "SYSTEM"`	No	Filter to one kind of activity.
`source`	`string`	No	Filter to one source, for example "slack".
`cursor`	`string`	No	Opaque keyset cursor from a previous page.
`limit`	`integer`	No	Page size (1..100).

Update onboarding

Changes data

atlas_onboarding_update

Scope: onboarding:write
Calls: PATCH /v1/client-onboarding/{id}
Example prompt: Move the Acme go-live date to 1 November.

Arguments

Field	Type	Required	Description
`id`	`string`	Yes	The client onboarding id.
`name`	`string`	No	A new name.
`ownerUserId`	`string \| null`	No	The owner. Null unassigns it.
`targetLiveAt`	`string (date-time) \| null`	No	ISO-8601 target go-live date. Null clears it.
`notes`	`string \| null`	No	Free-text notes. Null clears them.
`status`	`"NOT_STARTED" \| "IN_PROGRESS" \| "BLOCKED"`	No	The new status. COMPLETED and CANCELLED are not accepted: completing and cancelling belong to a person in Atlas.
`expectedVersion`	`integer`	No	The version last read. The update is refused if somebody changed the onboarding since.