Sign in

v3

latestOpenAPI 3.0.22026-08-04424560.5 KB
Group

createGroup

Create a new group

post/v1/groups

Request body

namestring required

The name of the group. Could be a department or a team.

user_idsUserId[]

The list of user ids in the group.

abbreviationstring nullable

A short abbreviation for the group, up to 2 characters.

Example request

{
  "name": "Finance",
  "user_ids": [
    "123",
    "456"
  ],
  "image_uri": {
    "gradient_colors": [
      "#0588f0",
      "#3358d4"
    ]
  },
  "abbreviation": "FN"
}

Response

Group created successfully

idstring required

Group unique identifier

org_idstring required
namestring required

The name of the group. Could be a department or a team.

created_atstring required
updated_atstring required
created_bystring

The user id of the user that created the group.

abbreviationstring nullable

A short abbreviation for the group, up to 2 characters.

Example response

{
  "name": "Finance",
  "created_at": "2024-02-08T04:44:32.246Z",
  "updated_at": "2024-02-08T04:44:32.246Z",
  "created_by": "123",
  "crt_assignee": {
    "display_name": "Example User",
    "department": "Sales",
    "phone_verified": true,
    "signature": "<p>Thanks</p>",
    "is_signature_enabled": true,
    "preferred_language": "de",
    "custom_navigation": "5gbe4nkp6jsfq",
    "feature_preferences": {
      "feature_name": true
    },
    "image_uri": {
      "original": "https://account-profile-images.epilot.cloud/1/avatar.png",
      "thumbnail_32": "https://account-profile-images.epilot.cloud/1/avatar_32x32.png"
    },
    "favorites": {
      "entity_views": {
        "opportunity": "891a5409850abf8b92bd2cb7bdd2844d32ce6bec",
        "order": "628aee91-7c2f-4047-ab0d-433582a19c49"
      },
      "dashboard": "751ff121-9ac2-4511-a2e6-851f11287380"
    },
    "email_notification_setting": {
      "added_participant_opportunity": true,
      "assigned_opportunity": true,
      "assigned_task": true,
      "comment_opportunity": true,
      "deleted_task": true,
      "escalated_task": true,
      "message_receive_opportunity": true,
      "message_send_opportunity": true,
      "created_task": true,
      "created_opportunity_manual": true,
      "created_opportunity_auto": true,
      "deleted_opportunity": true
    },
    "in_app_notification_setting": {
      "integration_critical_error": true,
      "integration_error_threshold": true,
      "assigned_opportunity": true,
      "assigned_task": true
    },
    "properties": [
      {
        "name": "profileImageName",
        "value": "avatar.png"
      }
    ],
    "tags": [
      "non-billable"
    ],
    "crt_index": 3
  },
  "users": [
    {
      "display_name": "Example User",
      "department": "Sales",
      "phone_verified": true,
      "signature": "<p>Thanks</p>",
      "is_signature_enabled": true,
      "preferred_language": "de",
      "custom_navigation": "5gbe4nkp6jsfq",
      "feature_preferences": {
        "feature_name": true
      },
      "image_uri": {
        "original": "https://account-profile-images.epilot.cloud/1/avatar.png",
        "thumbnail_32": "https://account-profile-images.epilot.cloud/1/avatar_32x32.png"
      },
      "favorites": {
        "entity_views": {
          "opportunity": "891a5409850abf8b92bd2cb7bdd2844d32ce6bec",
          "order": "628aee91-7c2f-4047-ab0d-433582a19c49"
        },
        "dashboard": "751ff121-9ac2-4511-a2e6-851f11287380"
      },
      "email_notification_setting": {
        "added_participant_opportunity": true,
        "assigned_opportunity": true,
        "assigned_task": true,
        "comment_opportunity": true,
        "deleted_task": true,
        "escalated_task": true,
        "message_receive_opportunity": true,
        "message_send_opportunity": true,
        "created_task": true,
        "created_opportunity_manual": true,
        "created_opportunity_auto": true,
        "deleted_opportunity": true
      },
      "in_app_notification_setting": {
        "integration_critical_error": true,
        "integration_error_threshold": true,
        "assigned_opportunity": true,
        "assigned_task": true
      },
      "properties": [
        {
          "name": "profileImageName",
          "value": "avatar.png"
        }
      ],
      "tags": [
        "non-billable"
      ]
    }
  ],
  "image_uri": {
    "gradient_colors": [
      "#0588f0",
      "#3358d4"
    ]
  },
  "abbreviation": "FN"
}