Emails & Activities API Reference

Overview

The Emails & Activities app (E&A) is a useful tool that enables monday.com CRM customers to manage client communication in one centralized location. Each contact is logged and tracked as an activity in the app’s timeline for easy access to important details and updates.

You can choose from default activities, like Meeting or Call Summary, or you can create custom activities to better organize your contacts.

Queries

You can use the custom_activity query to retrieve custom activity data via the API.

  • Limit: up to 50 custom activities
  • Returns an array containing metadata about custom activities in the E&A timeline
  • Can only be queried directly at the root; can’t be nested within another query
$  query {
>    custom_activity {
>      color
>      icon_id
>      id
>      name
>      type
>    }
>  }
$import { ApiClient } from "@mondaydotcomorg/api";
>const mondayApiClient = new ApiClient({ token: myToken });
>
>const query = "query { custom_activity { color icon_id id name type }}";
>const response = await mondayApiClient.request(query);

Fields

You can use the following fields to specify what information your custom_activity query will return.

FieldDescription
color CustomActivityColorThe custom activity’s color. View a full list of names and their corresponding colors here.
icon_id CustomActivityIconThe custom activity’s icon. View a full list of names and their corresponding icons here.
id IDThe custom activity’s unique identifier.
name StringThe custom activity’s name.
type StringThe custom activity’s type.

Mutations

The API allows you to create and delete custom activities using the following mutations.

Create custom activity

The create_custom_activity mutation creates a custom activity in the E&A app via the API. You can specify which fields to return in the mutation response.

$  mutation {
>    create_custom_activity(
>      color: SLATE_BLUE
>      icon_id: TRIPOD
>      name: "Test custom activity"
>  	) {
>      id
>    }
>  }
$import { ApiClient } from "@mondaydotcomorg/api";
>const mondayApiClient = new ApiClient({ token: myToken });
>
>const query = "mutation ($color:CustomActivityColor!, $iconId:CustomActivityIcon!, $name: String!) { create_custom_activity (color: $color, icon_id: $iconId, name: $name) {	id }}";
>const variables = {
>  color: "SLATE_BLUE",
>  iconId: "TRIPOD",
>  name: "My custom activity",
>};
>const response = await mondayApiClient.request(query, variables);

Arguments

You can use the following arguments to define the new custom activity.

ArgumentDescriptionEnum Values
color CustomActivityColor!The custom activity’s color. View a full list of names and their corresponding colors here.BRINK_PINK CELTIC_BLUE CORNFLOWER_BLUE DINGY_DUNGEON GO_GREEN GRAY LIGHT_DEEP_PINK LIGHT_HOT_PINK MAYA_BLUE MEDIUM_TURQUOISE PARADISE_PINK PHILIPPINE_GREEN PHILIPPINE_YELLOW SLATE_BLUE VIVID_CERULEAN YANKEES_BLUE YELLOW_GREEN YELLOW_ORANGE
icon_id CustomActivityIcon!The custom activity’s icon. View a full list of names and their corresponding icons here.ASCENDING CAMERA CONFERENCE FLAG GIFT HEADPHONES HOMEKEYS LOCATION NOTEBOOK PAPERPLANE PLANE PLIERS TRIPOD TWOFLAGS UTENSILS
name String!The custom activity’s name.

Delete custom activity

The delete_custom_activity mutation deletes a custom activity in the E&A app via the API. You can specify which fields to return in the mutation response.

$  mutation {
>    delete_custom_activity(id: "cbb37d0e-04ee-3662-z832-c4150e80eddz") {
>      name
>    }
>  }
$import { ApiClient } from "@mondaydotcomorg/api";
>const mondayApiClient = new ApiClient({ token: myToken });
>
>const query = "mutation ($activityId: String!) { delete_custom_activity (id: $activityId) {	name }}";
>const variables = {
>  activityId: "c95ccef8-f41d-40a9-b5b7-b039505e85da",
>};
>const response = await mondayApiClient.request(query, variables);

Arguments

You can use the following argument to define which custom activity to delete.

ArgumentDescription
id String!The custom activity’s unique identifier.