> For the complete documentation index, see [llms.txt](https://help.supplyd.co/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://help.supplyd.co/supplyd-erp/settings/users/user-groups/adding-sub-users-to-a-user-group.md).

# Adding Sub-Users to a User Group

Sub-users let your team share a login while allowing you to track who performed each action, without creating separate accounts.

Adding **sub-users** to a **User Group** allows team members to use a shared login while keeping their activity individually identifiable. Each sub-user enters a unique PIN, enabling Supply’d to record who performed specific actions. This document guides you through adding sub-users to an existing User Group.

{% hint style="success" %}
A **sub-user** is an individual within a **User Group** who uses the group’s shared login and enters their own unique PIN. This allows Supply’d to identify them and track their activity without requiring a separate account or email address.<br>

You must create the **User Group** before you can add **sub-users** to it.

👉 See [Adding a User Group](https://help.supplyd.co/supplyd-erp/settings/users/adding-users/adding-a-user-group.md) for instructions.
{% endhint %}

This document will guide you through adding **sub-users** to a **User Group** in Supply’d.

* [#adding-a-sub-user-to-a-user-group](#adding-a-sub-user-to-a-user-group "mention")
* [#editing-a-sub-user](#editing-a-sub-user "mention")
* [#removing-a-sub-user](#removing-a-sub-user "mention")

***

## Adding a Sub-User to a User Group

{% stepper %}
{% step %}

#### Open the Users Page

Click your name or company logo in the top-right corner, then select **Users**.

<figure><img src="https://2965503026-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FDaPYJDB89ny0x7wcMedb%2Fuploads%2FBzt3pKyt02j4W2R1FG5e%2FSpacer.png?alt=media&amp;token=0850ebbc-56ab-456b-8027-186eba3ae8dd" alt=""><figcaption></figcaption></figure>

{% hint style="success" %}
The **Users** page can also be accessed by selecting **Settings**, scrolling down, and selecting **Users** from the **Settings** menu.
{% endhint %}

<figure><img src="https://2965503026-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FDaPYJDB89ny0x7wcMedb%2Fuploads%2FSKzRxUHlKQdJtBm0PjCV%2FSpacer.png?alt=media&amp;token=2ced0351-c7db-4497-be92-2ffce2b623ef" alt=""><figcaption></figcaption></figure>

<div data-with-frame="true"><img src="https://2965503026-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FDaPYJDB89ny0x7wcMedb%2Fuploads%2FHoe1WV4oMjMpNjvdu796%2FSettings%20-%20Users.png?alt=media&amp;token=7f9d40f2-ccfd-4567-87f9-038dbf05bc3a" alt="" width="188"></div>

<figure><img src="https://2965503026-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FDaPYJDB89ny0x7wcMedb%2Fuploads%2FSKzRxUHlKQdJtBm0PjCV%2FSpacer.png?alt=media&amp;token=2ced0351-c7db-4497-be92-2ffce2b623ef" alt=""><figcaption></figcaption></figure>

The **Users** page will open listing all the **Users** that have access to your account.

<figure><img src="https://2965503026-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FDaPYJDB89ny0x7wcMedb%2Fuploads%2FSKzRxUHlKQdJtBm0PjCV%2FSpacer.png?alt=media&amp;token=2ced0351-c7db-4497-be92-2ffce2b623ef" alt=""><figcaption></figcaption></figure>

<div data-with-frame="true"><figure><img src="https://2965503026-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FDaPYJDB89ny0x7wcMedb%2Fuploads%2FPyHHJMJS8xyiLJqSwrvS%2F2%20-%20Users%20Page.png?alt=media&amp;token=43d014b1-2b82-4e15-9fc3-ea6caebbda9b" alt=""><figcaption></figcaption></figure></div>

<figure><img src="https://2965503026-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FDaPYJDB89ny0x7wcMedb%2Fuploads%2FSKzRxUHlKQdJtBm0PjCV%2FSpacer.png?alt=media&amp;token=2ced0351-c7db-4497-be92-2ffce2b623ef" alt=""><figcaption></figcaption></figure>

{% hint style="success" %}
The **User Type** is shown as a colour-coded tag next to each user’s name, making it easy to quickly identify their role.
{% endhint %}

<figure><img src="https://2965503026-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FDaPYJDB89ny0x7wcMedb%2Fuploads%2FSKzRxUHlKQdJtBm0PjCV%2FSpacer.png?alt=media&amp;token=2ced0351-c7db-4497-be92-2ffce2b623ef" alt=""><figcaption></figcaption></figure>

***

{% endstep %}

{% step %}

#### Select the User Group

Select the **User Group** you would like to add members to.

<figure><img src="https://2965503026-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FDaPYJDB89ny0x7wcMedb%2Fuploads%2FBGT8BTAi3IhSw006o0ow%2FSpacer.png?alt=media&amp;token=fe367e3b-5a3e-4b50-83bb-4475aeb3f101" alt=""><figcaption></figcaption></figure>

<div data-with-frame="true"><figure><img src="https://2965503026-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FDaPYJDB89ny0x7wcMedb%2Fuploads%2FxwDE7dSbvalcItK2Rbia%2FSelect%20User%20Group.png?alt=media&amp;token=1f4d6e64-cb54-4b79-8c97-ddf9bf173621" alt=""><figcaption></figcaption></figure></div>

<figure><img src="https://2965503026-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FDaPYJDB89ny0x7wcMedb%2Fuploads%2F1uq36WDhBW0N3pCxFIWX%2FSpacer.png?alt=media&amp;token=6c333ac3-2703-4310-aed1-b33e2ac767fb" alt=""><figcaption></figcaption></figure>

The user group's details will show.

<figure><img src="https://2965503026-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FDaPYJDB89ny0x7wcMedb%2Fuploads%2Fg82FRFgv9yj7X5w9mrrr%2FSpacer.png?alt=media&amp;token=f10c6473-7f7c-4024-9ba5-d4f059de91a2" alt=""><figcaption></figcaption></figure>

<div data-with-frame="true"><figure><img src="https://2965503026-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FDaPYJDB89ny0x7wcMedb%2Fuploads%2F62xtJc1GMedZkTFHxfkY%2FUser%20Group%20Details.png?alt=media&amp;token=a73e2bf7-7946-43a0-bda4-630c1d1b8d79" alt=""><figcaption></figcaption></figure></div>

<figure><img src="https://2965503026-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FDaPYJDB89ny0x7wcMedb%2Fuploads%2FRtq5qCUbjTIQYWwFgB8N%2FSpacer.png?alt=media&amp;token=58c0ea6f-9957-4488-bb49-06de21bdb292" alt=""><figcaption></figcaption></figure>

***

{% endstep %}

{% step %}

#### Add Sub-Users

To add a sub-user to the **User Group**, go to the **Users** tab, and click on <img src="https://2965503026-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FDaPYJDB89ny0x7wcMedb%2Fuploads%2F0xV5EuGYwADoL5fH2PL4%2FAdd%20Sub%20User.png?alt=media&amp;token=b40be999-0423-421f-8bf4-3982704be81b" alt="" data-size="line"> or **Add +**.

<figure><img src="https://2965503026-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FDaPYJDB89ny0x7wcMedb%2Fuploads%2F5DlirscxzwjpPQM82uvt%2FSpacer.png?alt=media&amp;token=9d9ae2a8-7c0d-4b44-923d-f3aa52f21fcd" alt=""><figcaption></figcaption></figure>

<div data-with-frame="true"><figure><img src="https://2965503026-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FDaPYJDB89ny0x7wcMedb%2Fuploads%2Fo7BCRNIXhHlpdo90fMsb%2FAdd%20Sub%20User%20Buttons.png?alt=media&amp;token=bed368c6-8fe6-41c1-b467-604ab60f27ca" alt=""><figcaption></figcaption></figure></div>

<figure><img src="https://2965503026-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FDaPYJDB89ny0x7wcMedb%2Fuploads%2FsMcmRVs3ZBuXsJ9QXhDd%2FSpacer.png?alt=media&amp;token=45790b12-0540-4694-a9e6-c6f27439b3f3" alt=""><figcaption></figcaption></figure>

{% hint style="info" %}
The <img src="https://2965503026-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FDaPYJDB89ny0x7wcMedb%2Fuploads%2F0xV5EuGYwADoL5fH2PL4%2FAdd%20Sub%20User.png?alt=media&amp;token=b40be999-0423-421f-8bf4-3982704be81b" alt="" data-size="line"> button appears only when no sub-users have been added. To add additional sub-users, use **Add +**.
{% endhint %}

<figure><img src="https://2965503026-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FDaPYJDB89ny0x7wcMedb%2Fuploads%2FbJDih3Dwv41QavjV1QDa%2FSpacer.png?alt=media&amp;token=6c34f805-9610-4de9-8f8a-a029f13dd1a1" alt=""><figcaption></figcaption></figure>

The **Add Sub User** form will open.

<figure><img src="https://2965503026-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FDaPYJDB89ny0x7wcMedb%2Fuploads%2FzsIGAFjABXohbfujW8dU%2FSpacer.png?alt=media&amp;token=9a9d0d71-6081-4b80-b00b-e4079a6a2c6c" alt=""><figcaption></figcaption></figure>

<div data-with-frame="true"><figure><img src="https://2965503026-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FDaPYJDB89ny0x7wcMedb%2Fuploads%2FlQapr4JarDM0cy2s3rbp%2FAdd%20Sub%20User%20Form.png?alt=media&amp;token=569411e9-0d2f-4bfe-b465-7d1855a6458c" alt="" width="563"><figcaption></figcaption></figure></div>

<figure><img src="https://2965503026-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FDaPYJDB89ny0x7wcMedb%2Fuploads%2FJ8bW8OLY29Y6T9ZOcGOR%2FSpacer.png?alt=media&amp;token=ab4a64f6-5eec-43b7-b699-479a8d26f595" alt=""><figcaption></figcaption></figure>

**First Name\* \[required field]**

Enter the user's first name.

<figure><img src="https://2965503026-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FDaPYJDB89ny0x7wcMedb%2Fuploads%2FRtq5qCUbjTIQYWwFgB8N%2FSpacer.png?alt=media&amp;token=58c0ea6f-9957-4488-bb49-06de21bdb292" alt=""><figcaption></figcaption></figure>

**Last Name**

Optionally, enter the user's last name/surname.

<figure><img src="https://2965503026-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FDaPYJDB89ny0x7wcMedb%2Fuploads%2FRtq5qCUbjTIQYWwFgB8N%2FSpacer.png?alt=media&amp;token=58c0ea6f-9957-4488-bb49-06de21bdb292" alt=""><figcaption></figcaption></figure>

**PIN\* \[required field]**

Enter a unique 4-digit PIN for this user. Use numbers only. This PIN will allow the user to access the account.

<figure><img src="https://2965503026-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FDaPYJDB89ny0x7wcMedb%2Fuploads%2FRtq5qCUbjTIQYWwFgB8N%2FSpacer.png?alt=media&amp;token=58c0ea6f-9957-4488-bb49-06de21bdb292" alt=""><figcaption></figcaption></figure>

**Hourly Rate**

Enter the hourly rate for this staff member to use when tracking labour costs. The rate should include taxes and other applicable costs, such as superannuation.&#x20;

Leave blank to use the default rate set in your [Production Settings](https://help.supplyd.co/supplyd-erp/settings/production-settings.md).

<figure><img src="https://2965503026-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FDaPYJDB89ny0x7wcMedb%2Fuploads%2FRtq5qCUbjTIQYWwFgB8N%2FSpacer.png?alt=media&amp;token=58c0ea6f-9957-4488-bb49-06de21bdb292" alt=""><figcaption></figcaption></figure>

<figure><img src="https://2965503026-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FDaPYJDB89ny0x7wcMedb%2Fuploads%2FRtq5qCUbjTIQYWwFgB8N%2FSpacer.png?alt=media&amp;token=58c0ea6f-9957-4488-bb49-06de21bdb292" alt=""><figcaption></figcaption></figure>

Click <img src="https://2965503026-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FDaPYJDB89ny0x7wcMedb%2Fuploads%2FJyH1Jg5NQ2KO4xnrHrr4%2FSAVE.png?alt=media&amp;token=b5d85f06-7737-442f-a5b1-531ab35a5aab" alt="" data-size="line"> to add the user to the group.

<figure><img src="https://2965503026-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FDaPYJDB89ny0x7wcMedb%2Fuploads%2FRtq5qCUbjTIQYWwFgB8N%2FSpacer.png?alt=media&amp;token=58c0ea6f-9957-4488-bb49-06de21bdb292" alt=""><figcaption></figcaption></figure>

***

{% endstep %}

{% step %}

#### Repeat

Repeat **Step 2** for any additional users you would like to add to the **User Group**.

<figure><img src="https://2965503026-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FDaPYJDB89ny0x7wcMedb%2Fuploads%2FbJDih3Dwv41QavjV1QDa%2FSpacer.png?alt=media&amp;token=6c34f805-9610-4de9-8f8a-a029f13dd1a1" alt=""><figcaption></figcaption></figure>

{% endstep %}
{% endstepper %}

{% hint style="success" %}
Once set up, whenever someone logs in using the shared login, they’ll be prompted to enter their assigned PIN.

**Example of a User Group in Supply’d:**<br>

* **User Group Name:** Warehouse Staff
* **Purpose:** Used for a shared warehouse login on a tablet.

**Users in the Group:**<br>

* **Alice** – PIN: 1234
* **Ben** – PIN: 5678
* **Charlie** – PIN: 9012

When warehouse staff log in, they enter their PIN. This allows actions (like receiving stock or marking deliveries) to be tracked to the individual, even though they’re using the same login.<br>
{% endhint %}

***

## Editing a Sub-User

{% stepper %}
{% step %}
Click on your name in the top right and select **Users**.

{% endstep %}

{% step %}
Select the **User Group** the sub-user belongs to to open its details.

{% hint style="success" %}
User Groups are easily identified by the <img src="https://2965503026-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FDaPYJDB89ny0x7wcMedb%2Fuploads%2F3k8PLQmOTkYqVcZbrLaV%2FUSER%20GROUP..jpg?alt=media&amp;token=4ff75c8b-b861-478a-af19-eb82094d9efe" alt="" data-size="line"> status.
{% endhint %}

<figure><img src="https://2965503026-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FDaPYJDB89ny0x7wcMedb%2Fuploads%2FbJDih3Dwv41QavjV1QDa%2FSpacer.png?alt=media&amp;token=6c34f805-9610-4de9-8f8a-a029f13dd1a1" alt=""><figcaption></figcaption></figure>
{% endstep %}

{% step %}
Go to the **Users** tab and select the sub user you would like to edit the details for. The **Edit Sub User** form will open.

<figure><img src="https://2965503026-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FDaPYJDB89ny0x7wcMedb%2Fuploads%2FbJDih3Dwv41QavjV1QDa%2FSpacer.png?alt=media&amp;token=6c34f805-9610-4de9-8f8a-a029f13dd1a1" alt=""><figcaption></figcaption></figure>

<div data-with-frame="true"><figure><img src="https://2965503026-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FDaPYJDB89ny0x7wcMedb%2Fuploads%2FJAXtCtUqSpn4xBxyLUcr%2FEdit%20Sub%20User.png?alt=media&amp;token=430453cc-5901-43a2-a8ab-62cb34fa9a81" alt="" width="563"><figcaption></figcaption></figure></div>

<figure><img src="https://2965503026-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FDaPYJDB89ny0x7wcMedb%2Fuploads%2FbJDih3Dwv41QavjV1QDa%2FSpacer.png?alt=media&amp;token=6c34f805-9610-4de9-8f8a-a029f13dd1a1" alt=""><figcaption></figcaption></figure>
{% endstep %}

{% step %}
Edit any required details by following the guidelines above for **Adding a Sub User**, as outlined above in [#adding-a-sub-user-to-a-user-group](#adding-a-sub-user-to-a-user-group "mention").

{% endstep %}

{% step %}
Click <img src="https://2965503026-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FDaPYJDB89ny0x7wcMedb%2Fuploads%2FJyH1Jg5NQ2KO4xnrHrr4%2FSAVE.png?alt=media&amp;token=b5d85f06-7737-442f-a5b1-531ab35a5aab" alt="" data-size="line"> to update the sub user's details.&#x20;

<figure><img src="https://2965503026-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FDaPYJDB89ny0x7wcMedb%2Fuploads%2FRtq5qCUbjTIQYWwFgB8N%2FSpacer.png?alt=media&amp;token=58c0ea6f-9957-4488-bb49-06de21bdb292" alt=""><figcaption></figcaption></figure>

{% endstep %}
{% endstepper %}

***

## Removing a Sub-User

{% stepper %}
{% step %}
Click your name in the top right and select **Users**.&#x20;

{% endstep %}

{% step %}
Select the **User Group** the sub-user belongs to to open its details

{% endstep %}

{% step %}
Go to the **Users** tab and select the sub user you would like to remove. The **Edit Sub User** form will open.

{% endstep %}

{% step %}
Click on the 3 dots in the top-right corner and select **Remove Sub User**.

<figure><img src="https://2965503026-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FDaPYJDB89ny0x7wcMedb%2Fuploads%2FRtq5qCUbjTIQYWwFgB8N%2FSpacer.png?alt=media&amp;token=58c0ea6f-9957-4488-bb49-06de21bdb292" alt=""><figcaption></figcaption></figure>

<div data-with-frame="true"><figure><img src="https://2965503026-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FDaPYJDB89ny0x7wcMedb%2Fuploads%2FuLaB7BwGb5d2P1UI9Ckw%2FRemove%20Sub%20User.png?alt=media&amp;token=bfcdc140-e71b-4976-a493-6a2f15e67383" alt="" width="563"><figcaption></figcaption></figure></div>

<figure><img src="https://2965503026-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FDaPYJDB89ny0x7wcMedb%2Fuploads%2FRtq5qCUbjTIQYWwFgB8N%2FSpacer.png?alt=media&amp;token=58c0ea6f-9957-4488-bb49-06de21bdb292" alt=""><figcaption></figcaption></figure>

You will be asked to confirm.

<figure><img src="https://2965503026-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FDaPYJDB89ny0x7wcMedb%2Fuploads%2FRtq5qCUbjTIQYWwFgB8N%2FSpacer.png?alt=media&amp;token=58c0ea6f-9957-4488-bb49-06de21bdb292" alt=""><figcaption></figcaption></figure>

<div data-with-frame="true"><figure><img src="https://2965503026-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FDaPYJDB89ny0x7wcMedb%2Fuploads%2FRbyH1gdBoLAM9ufKtkUb%2FConfirm%20Remove%20Sub%20User.png?alt=media&amp;token=e9ea4e2b-9088-4a2c-96e3-26c6367397ee" alt="" width="375"><figcaption></figcaption></figure></div>

<figure><img src="https://2965503026-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FDaPYJDB89ny0x7wcMedb%2Fuploads%2FRtq5qCUbjTIQYWwFgB8N%2FSpacer.png?alt=media&amp;token=58c0ea6f-9957-4488-bb49-06de21bdb292" alt=""><figcaption></figcaption></figure>

Click <img src="https://2965503026-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FDaPYJDB89ny0x7wcMedb%2Fuploads%2FnxEPPopP8Lg6iQR4I0cH%2FRemove.png?alt=media&amp;token=929f38a3-9c52-45f2-bbf2-293e7b122383" alt="" data-size="line">.

<figure><img src="https://2965503026-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FDaPYJDB89ny0x7wcMedb%2Fuploads%2FBzt3pKyt02j4W2R1FG5e%2FSpacer.png?alt=media&amp;token=0850ebbc-56ab-456b-8027-186eba3ae8dd" alt=""><figcaption></figcaption></figure>

{% endstep %}
{% endstepper %}


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://help.supplyd.co/supplyd-erp/settings/users/user-groups/adding-sub-users-to-a-user-group.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
