debian-mirror-gitlab/doc/user/crm/index.md

stage	group	info
Plan	Certify	To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/product/ux/technical-writing/#assignments

Customer relations management (CRM) (FREE)

• Introduced in GitLab 14.6 with a flag named customer_relations. Disabled by default.
• In GitLab 14.8 and later, you can create contacts and organizations only in root groups.
• Enabled on GitLab.com and self-managed in GitLab 15.0.
• Feature flag removed in GitLab 15.1.

With customer relations management (CRM) you can create a record of contacts (individuals) and organizations (companies) and relate them to issues.

Contacts and organizations can only be created for root groups.

You can use contacts and organizations to tie work to customers for billing and reporting purposes. For more information about what is planned for the future, see issue 2256.

Permissions

Permission	Guest	Reporter	Developer, Maintainer, and Owner
View contacts/organizations		✓	✓
View issue contacts		✓	✓
Add/remove issue contacts		✓	✓
Create/edit contacts/organizations			✓

Enable customer relations management (CRM)

Customer relations management features must be enabled at the group level. If your group also contains subgroups, and you want to use CRM features in the subgroup, you must enable CRM features for the subgroup.

To enable customer relations management in a group or subgroup:

1. On the top bar, select Main menu > Groups and find your group or subgroup.
2. On the left sidebar, select Settings > General.
3. Expand the Permissions and group features section.
4. Select Customer relations is enabled.
5. Select Save changes.

Contacts

View contacts linked to a group

Prerequisites:

• You must have at least the Reporter role for the project.

To view a group's contacts:

1. On the top bar, select Main menu > Groups and find your group.
2. On the left sidebar, select Customer relations > Contacts.

Create a contact

Prerequisites:

• You must have at least the Developer role for the project.

To create a contact:

1. On the top bar, select Main menu > Groups and find your group.
2. On the left sidebar, select Customer relations > Contacts.
3. Select New contact.
4. Complete all required fields.
5. Select Create new contact.

You can also create contacts using the GraphQL API.

Edit a contact

Prerequisites:

• You must have at least the Developer role for the project.

To edit an existing contact:

1. On the top bar, select Main menu > Groups and find your group.
2. On the left sidebar, select Customer relations > Contacts.
3. Next to the contact you wish to edit, select Edit ({pencil}).
4. Edit the required fields.
5. Select Save changes.

You can also edit contacts using the GraphQL API.

Change the state of a contact

Each contact can be in one of two states:

• Active: contacts in this state can be added to an issue.
• Inactive: contacts in this state cannot be added to an issue.

To change the state of a contact:

1. On the top bar, select Main menu > Groups and find your group.
2. On the left sidebar, select Customer relations > Contacts.
3. Next to the contact you wish to edit, select Edit ({pencil}).
4. Select or clear the Active checkbox.
5. Select Save changes.

Organizations

View organizations

Prerequisites:

• You must have at least the Reporter role for the project.

To view a group's organizations:

1. On the top bar, select Main menu > Groups and find your group.
2. On the left sidebar, select Customer relations > Organizations.

Create an organization

Prerequisites:

• You must have at least the Developer role for the project.

To create an organization:

1. On the top bar, select Main menu > Groups and find your group.
2. On the left sidebar, select Customer relations > Organizations.
3. Select New organization.
4. Complete all required fields.
5. Select Create new organization.

You can also create organizations using the GraphQL API.

Edit an organization

Prerequisites:

• You must have at least the Developer role for the project.

To edit an existing organization:

1. On the top bar, select Main menu > Groups and find your group.
2. On the left sidebar, select Customer relations > Organizations.
3. Next to the organization you wish to edit, select Edit ({pencil}).
4. Edit the required fields.
5. Select Save changes.

You can also edit organizations using the GraphQL API.

Issues

If you use Service Desk and create issues from emails, issues are linked to contacts matching the email addresses in the sender and CC of the email.

View issues linked to a contact

Prerequisites:

• You must have at least the Reporter role for the project.

To view a contact's issues, select a contact from the issue sidebar, or:

1. On the top bar, select Main menu > Groups and find your group.
2. On the left sidebar, select Customer relations > Contacts.
3. Next to the contact whose issues you wish to view, select View issues ({issues}).

View issues linked to an organization

Prerequisites:

• You must have at least the Reporter role for the project.

To view an organization's issues:

1. On the top bar, select Main menu > Groups and find your group.
2. On the left sidebar, select Customer relations > Organizations.
3. Next to the organization whose issues you wish to view, select View issues ({issues}).

View contacts linked to an issue

Prerequisites:

• You must have at least the Reporter role for the project.

You can view contacts associated with an issue in the right sidebar.

To view a contact's details, hover over the contact's name.

You can also view issue contacts using the GraphQL API.

Add or remove issue contacts

Prerequisites:

• You must have at least the Reporter role for the project.

Add contacts to an issue

To add active contacts to an issue use the /add_contacts [contact:address@example.com] quick action.

You can also add, remove, or replace issue contacts using the GraphQL API.

Remove contacts from an issue

To remove contacts from an issue use the /remove_contacts [contact:address@example.com] quick action.

You can also add, remove, or replace issue contacts using the GraphQL API.

Autocomplete contacts

• Introduced in GitLab 14.8 with a flag named contacts_autocomplete. Disabled by default.
• Enabled on GitLab.com and self-managed in GitLab 15.0.
• Generally available in GitLab 15.2. Feature flag contacts_autocomplete removed.

When you use the /add_contacts quick action, follow it with [contact: and an autocomplete list with the active contacts appears:

/add_contacts [contact:

When you use the /remove_contacts quick action, follow it with [contact: and an autocomplete list with the contacts added to the issue appears:

/remove_contacts [contact:

Moving objects with CRM entries

The root group is the topmost group in the group hierarchy.

When you move an issue, project, or group in the same group hierarchy, issues retain their contacts.

When you move an issue or project and the root group changes, issues lose their contacts.

When you move a group and its root group changes:

• All unique contacts and organizations are migrated to the new root group.
• Contacts that already exist (by email address) are deemed duplicates and deleted.
• Organizations that already exist (by name) are deemed duplicates and deleted.
• All issues retain their contacts or are updated to point at contacts with the same email address.

If you do not have permission to create contacts and organizations in the new root group, the group transfer fails.