doc/user/crm/_index.md
{{< details >}}
{{< /details >}}
{{< history >}}
customer_relations. Disabled by default.{{< /history >}}
[!note] This feature is not under active development, but community contributions are welcome. To determine if the feature meets your needs, see the open work items in epic 5323.
With customer relations management (CRM) you can create a record of contacts (individuals) and organizations (companies) and relate them to work items.
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, see issue 2256.
| Permission | Guest | Planner | Group Reporter | Group Developer, Maintainer, and Owner |
|---|---|---|---|---|
| View contacts/organizations | ✓ | ✓ | ✓ | |
| View work item contacts | ✓ | ✓ | ✓ | |
| Add/remove work item contacts | ✓ | ✓ | ✓ | |
| Create/edit contacts/organizations | ✓ |
{{< history >}}
{{< /history >}}
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:
{{< history >}}
{{< /history >}}
By default, contacts are sourced from a work item'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:
Prerequisites:
To view a group's contacts:
Prerequisites:
To create a contact:
You can also create contacts using the GraphQL API.
Prerequisites:
To edit an existing contact:
You can also edit contacts using the GraphQL API.
Each contact can be in one of two states:
To change the state of a contact:
Prerequisites:
To view a group's organizations:
Prerequisites:
To create an organization:
You can also create organizations using the GraphQL API.
Prerequisites:
To edit an existing organization:
You can also edit organizations using the GraphQL API.
If you use Service Desk and create tickets from emails, tickets are linked to contacts matching the email addresses in the sender and CC of the email.
Prerequisites:
To view a contact's work items, select a contact from the work item sidebar, or:
Prerequisites:
To view an organization's work items:
Prerequisites:
You can view contacts associated with a work item in the right sidebar.
To view a contact's details, hover over the contact's name.
You can also view work item contacts using the GraphQL API.
Prerequisites:
To add active contacts to a work item use the /add_contacts quick action with [contact:[email protected]].
You can also add, remove, or replace work item contacts using the GraphQL API.
Prerequisites:
To remove contacts from a work item use the /remove_contacts quick action with [contact:[email protected]].
You can also add, remove, or replace work item contacts using the GraphQL API.
{{< history >}}
contacts_autocomplete. Disabled by default.contacts_autocomplete removed.{{< /history >}}
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 work item appears:
/remove_contacts [contact:
When you move a work item or project and the parent group contact source matches, work items retain their contacts.
When you move a work item or project and the parent group contact source changes, work items lose their contacts.
When you move a group with a contact source configured or its contact source remains unchanged, work items retain their contacts.
When you move a group and its contact source changes:
If you do not have permission to create contacts and organizations in the new top-level group, the group transfer fails.