summaryrefslogtreecommitdiff
path: root/doc/user/crm/index.md
diff options
context:
space:
mode:
Diffstat (limited to 'doc/user/crm/index.md')
-rw-r--r--doc/user/crm/index.md141
1 files changed, 141 insertions, 0 deletions
diff --git a/doc/user/crm/index.md b/doc/user/crm/index.md
new file mode 100644
index 00000000000..d68ce0a4f7a
--- /dev/null
+++ b/doc/user/crm/index.md
@@ -0,0 +1,141 @@
+---
+stage: Plan
+group: Product Planning
+info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/engineering/ux/technical-writing/#assignments
+---
+
+# Customer relations management (CRM) **(FREE)**
+
+> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/2256) in GitLab 14.6 [with a flag](../../administration/feature_flags.md) named `customer_relations`. Disabled by default.
+
+FLAG:
+On self-managed GitLab, by default this feature is not available. To make it available,
+ask an administrator to [enable the feature flag](../../administration/feature_flags.md) named `customer_relations`.
+On GitLab.com, this feature is not available.
+You should not use this feature for production environments.
+
+With customer relations management (CRM) you can create a record of contacts
+(individuals) and organizations (companies) and relate them to issues.
+
+You can use contacts and organizations to tie work to customers for billing and reporting purposes.
+To read more about what is planned for the future, see [issue 2256](https://gitlab.com/gitlab-org/gitlab/-/issues/2256).
+
+## Contacts
+
+### View contacts linked to a group
+
+To view a group's contacts:
+
+1. On the top bar, select **Menu > Groups** and find your group.
+1. On the left sidebar, select **Customer relations > Contacts**.
+
+![Contacts list](crm_contacts_v14_6.png)
+
+### Create a contact
+
+To create a contact:
+
+1. On the top bar, select **Menu > Groups** and find your group.
+1. On the left sidebar, select **Customer relations > Contacts**.
+1. Select **New contact**.
+1. Complete all required fields.
+1. Select **Create new contact**.
+
+You can also [create](../../api/graphql/reference/index.md#mutationcustomerrelationscontactcreate)
+contacts using the GraphQL API.
+
+### Edit a contact
+
+To edit an existing contact:
+
+1. On the top bar, select **Menu > Groups** and find your group.
+1. On the left sidebar, select **Customer relations > Contacts**.
+1. Next to the contact you wish to edit, select **Edit** (**{pencil}**).
+1. Edit the required fields.
+1. Select **Save changes**.
+
+You can also [edit](../../api/graphql/reference/index.md#mutationcustomerrelationscontactupdate)
+contacts using the GraphQL API.
+
+## Organizations
+
+### View organizations
+
+To view a group's organizations:
+
+1. On the top bar, select **Menu > Groups** and find your group.
+1. On the left sidebar, select **Customer relations > Organizations**.
+
+![Organizations list](crm_organizations_v14_6.png)
+
+### Create an organization
+
+To create an organization:
+
+1. On the top bar, select **Menu > Groups** and find your group.
+1. On the left sidebar, select **Customer relations > Organizations**.
+1. Select **New organization**.
+1. Complete all required fields.
+1. Select **Create new organization**.
+
+You can also [create](../../api/graphql/reference/index.md#mutationcustomerrelationsorganizationcreate)
+organizations using the GraphQL API.
+
+### Edit an organization
+
+You can only [edit](../../api/graphql/reference/index.md#mutationcustomerrelationsorganizationupdate)
+organizations using the GraphQL API.
+
+## Issues
+
+### View issues linked to a contact
+
+To view a contact's issues:
+
+1. On the top bar, select **Menu > Groups** and find your group.
+1. On the left sidebar, select **Customer relations > Contacts**.
+1. Next to the contact whose issues you wish to view, select **View issues** (**{issues}**).
+
+### View issues linked to an organization
+
+To view an organization's issues:
+
+1. On the top bar, select **Menu > Groups** and find your group.
+1. On the left sidebar, select **Customer relations > Organizations**.
+1. Next to the organization whose issues you wish to view, select **View issues** (**{issues}**).
+
+### View contacts linked to an issue
+
+You can view contacts associated with an issue in the right sidebar.
+
+To view a contact's details, hover over the contact's name.
+
+![Issue contacts](issue_crm_contacts_v14_6.png)
+
+You can also view issue contacts using the
+[GraphQL](../../api/graphql/reference/index.md#mutationcustomerrelationsorganizationcreate)
+API.
+
+### Add or remove issue contacts
+
+Prerequisites:
+
+- You must have at least the [Developer role](../permissions.md#project-members-permissions) for a group.
+
+### Add contacts to an issue
+
+To add contacts to an issue use the `/add_contacts`
+[quick action](../project/quick_actions.md).
+
+You can also add, remove, or replace issue contacts using the
+[GraphQL](../../api/graphql/reference/index.md#mutationissuesetcrmcontacts)
+API.
+
+### Remove contacts from an issue
+
+To remove contacts from an issue use the `/remove_contacts`
+[quick action](../project/quick_actions.md).
+
+You can also add, remove, or replace issue contacts using the
+[GraphQL](../../api/graphql/reference/index.md#mutationissuesetcrmcontacts)
+API.