- Permissions
- Enable customer relations management (CRM)
- Configure the contact source
- Contacts
- Organizations
- Issues
- Autocomplete contacts
- Moving objects with CRM entries
Customer relations management (CRM)
-
Introducedin GitLab 14.6with a flagnamed
customer_relations
.Disabled by default. - In GitLab 14.8 and later, you cancreate contacts and organizations only in top-level groups.
- Enabled on GitLab.com and self-managedin GitLab 15.0.
- Feature flag removedin GitLab 15.1.
With customer relations management (CRM) you can create a record of contacts (individuals) and organizations (companies) and relate them to issues.
By default, contacts and organizations can only be created for top-level groups. To create contacts and organizations in other groups,assign the group as a contact source.
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, seeissue 2256.
Permissions
Permission | Guest | Group Reporter | Group Developer, Maintainer, and Owner |
---|---|---|---|
View contacts/organizations | ✓ | ✓ | |
View issue contacts | ✓ | ✓ | |
Add/remove issue contacts | ✓ | ✓ | |
Create/edit contacts/organizations | ✓ |
Enable customer relations management (CRM)
- Enabled by defaultin GitLab 16.9.
Customer relations management features are enabled at the group level. If your group also contains subgroups, and you want to use CRM features in the subgroup, CRM features must also be enabled for the subgroup.
To enable customer relations management in a group or subgroup:
- On the left sidebar, selectSearch or go toand find your group or subgroup.
- SelectSettings > General.
- Expand thePermissions and group featuressection.
- SelectCustomer relations is enabled.
- SelectSave changes.
Configure the contact source
- Availablein GitLab 17.6.
By default, contacts are sourced from an issue’s top-level group.
The contact source for a group will apply to all subgroups, unless they have a contact source configured.
To configure the contact source for a group or subgroup:
- On the left sidebar, selectSearch or go toand find your group or subgroup.
- SelectSettings > General.
- Expand thePermissions and group featuressection.
- SelectContact source > Search for a group.
- Select the group from which you wish to source contacts.
- SelectSave changes.
Contacts
View contacts linked to a group
Prerequisites:
- You must have at least the Reporter role for the group.
To view a group’s contacts:
- On the left sidebar, selectSearch or go toand find your group.
- SelectPlan > Customer relations.
Create a contact
Prerequisites:
- You must have at least the Developer role for the group.
To create a contact:
- On the left sidebar, selectSearch or go toand find your group.
- SelectPlan > Customer relations.
- SelectNew contact.
- Complete all required fields.
- SelectCreate new contact.
You can alsocreate contacts using the GraphQL API.
Edit a contact
Prerequisites:
- You must have at least the Developer role for the group.
To edit an existing contact:
- On the left sidebar, selectSearch or go toand find your group.
- SelectPlan > Customer relations.
- Next to the contact you wish to edit, selectEdit().
- Edit the required fields.
- SelectSave changes.
You can alsoedit 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:
- On the left sidebar, selectSearch or go toand find your group.
- SelectPlan > Customer relations.
- Next to the contact you wish to edit, selectEdit().
- Select or clear theActivecheckbox.
- SelectSave changes.
Organizations
View organizations
Prerequisites:
- You must have at least the Reporter role for the group.
To view a group’s organizations:
- On the left sidebar, selectSearch or go toand find your group.
- SelectPlan > Customer relations.
- In the upper right, selectOrganizations.
Create an organization
Prerequisites:
- You must have at least the Developer role for the group.
To create an organization:
- On the left sidebar, selectSearch or go toand find your group.
- SelectPlan > Customer relations.
- In the upper right, selectOrganizations.
- SelectNew organization.
- Complete all required fields.
- SelectCreate new organization.
You can alsocreate organizations using the GraphQL API.
Edit an organization
Prerequisites:
- You must have at least the Developer role for the group.
To edit an existing organization:
- On the left sidebar, selectSearch or go toand find your group.
- SelectPlan > Customer relations.
- In the upper right, selectOrganizations.
- Next to the organization you wish to edit, selectEdit().
- Edit the required fields.
- SelectSave changes.
You can alsoedit organizations using the GraphQL API.
Issues
If you useService Deskand 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 group.
To view a contact’s issues, select a contact from the issue sidebar, or:
- On the left sidebar, selectSearch or go toand find your group.
- SelectPlan > Customer relations.
- Next to the contact whose issues you wish to view, selectView issues().
View issues linked to an organization
Prerequisites:
- You must have at least the Reporter role for the group.
To view an organization’s issues:
- On the left sidebar, selectSearch or go toand find your group.
- SelectPlan > Customer relations.
- In the upper right, selectOrganizations.
- Next to the organization whose issues you wish to view, selectView issues().
View contacts linked to an issue
Prerequisites:
- You must have at least the Reporter role for the group.
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 contacts to an issue
Prerequisites:
- You must have at least the Reporter role for the group.
To addactivecontacts to an issue use the/add_contacts [contact:[email protected]]
quick action.
You can also add, remove, or replace issue contacts using the GraphQL API.
Remove contacts from an issue
Prerequisites:
- You must have at least the Reporter role for the group.
To remove contacts from an issue use the/remove_contacts [contact:[email protected]]
quick action.
You can also add, remove, or replace issue contacts using the GraphQL API.
Autocomplete contacts
-
Introducedin GitLab 14.8with a flagnamed
contacts_autocomplete
.Disabled by default. - Enabled on GitLab.com and self-managedin GitLab 15.0.
-
Generally availablein 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 theactivecontacts 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
When you move an issue or project and theparent group contact source matches, issues retain their contacts.
When you move an issue or project and theparent group contact source changes, issues lose their contacts.
When you move a group with acontact source configured or it’scontact source remains unchanged, issues retain their contacts.
When you move a group and itscontact source changes:
- All unique contacts and organizations are migrated to the new top-level 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 top-level group, the group transfer fails.