RECENT UPDATES:
05-Jun-2026 | v7.10.7 | All new article

Change Log

  • 05-Jun-2026 | v7.10.7 | All new article

Contributors:

{
  "id": 2418,
  "name": "Adam Wilson",
  "url": "/adam-wilson"
}
Adam Wilson - Logo Pogo

Advanced CRM Groups API

Create, Retrieve, Update and Delete Advanced CRM Groups via the public API endpoint, with "where" filtering and field type lookups. Available apply-to types can also be retrieved via this API.

GET CRM Advanced Crm Groups List

Retrieves a list of Advanced Crm Groups as a JSON response based on your provided query parameters.

/api/v2/admin/advanced-crm-groups

Parameters

Parameter
Values
Required
Where
{<where query>}
Order_By
<propertyAlias>
Semantic_Query
<string>
Min_Score
<double>
Offset
<integer>
Limit
<integer>

Data / Response:

N/A

{
  "Items": [
    {
      "Id": "string",
      "Name": "string",
      "Alias": "string",
      "ApplyToTypes": [
        "Contacts"
      ],
      "Properties": [
        {
          "Id": 0,
          "Name": "string",
          "Type": "DateTime",
          "IsMandatory": true,
          "Options": [
            "string"
          ]
        }
      ]
    }
  ],
  "TotalItemsCount": 0
}

POST CRM Advanced Crm Group Create

Creates a new Advanced Crm Group based on the provided data.

/api/v2/admin/advanced-crm-groups

Data / Response:

{
  "Name": "string",
  "Alias": "string",
  "ApplyToTypes": [
    "Contacts"
  ]
}

{
  "Id": "string",
  "Name": "string",
  "Alias": "string",
  "ApplyToTypes": [
    "Contacts"
  ],
  "Properties": [
    {
      "Id": 0,
      "Name": "string",
      "Type": "DateTime",
      "IsMandatory": true,
      "Options": [
        "string"
      ]
    }
  ]
}

GET CRM Advanced Crm Group Item

Retrieves a single Advanced Crm Group based on the ID passed in the endpoint URL.

/api/v2/admin/advanced-crm-groups/{id}

Data / Response:

N/A

{
  "Id": "string",
  "Name": "string",
  "Alias": "string",
  "ApplyToTypes": [
    "Contacts"
  ],
  "Properties": [
    {
      "Id": 0,
      "Name": "string",
      "Type": "DateTime",
      "IsMandatory": true,
      "Options": [
        "string"
      ]
    }
  ]
}

PUT CRM Advanced Crm Group Update

Updates a single Advanced Crm Group based on the ID passed in the endpoint URL and data provided.

/api/v2/admin/advanced-crm-groups/{id}

Data / Response:

{
  "Properties": [
    {
      "Id": 0,
      "Name": "string",
      "Type": "DateTime",
      "IsMandatory": true,
      "Options": [
        "string"
      ]
    }
  ],
  "Name": "string",
  "Alias": "string",
  "ApplyToTypes": [
    "Contacts"
  ]
}

{
  "Id": "string",
  "Name": "string",
  "Alias": "string",
  "ApplyToTypes": [
    "Contacts"
  ],
  "Properties": [
    {
      "Id": 0,
      "Name": "string",
      "Type": "DateTime",
      "IsMandatory": true,
      "Options": [
        "string"
      ]
    }
  ]
}

DELETE CRM Advanced Crm Group Delete

Deletes a single Advanced Crm Group based on the ID passed in the endpoint URL.

/api/v2/admin/advanced-crm-groups/{id}

Data / Response:

N/A

Status 204

GET CRM Advanced Crm Group Field Types List

Retrieves a list of Advanced Crm Group field types as a JSON response.

/api/v2/admin/advanced-crm-groups/field-types

Data / Response:

N/A

[
  "string"
]

GET CRM Advanced Crm Group Types List

Retrieves a list of Advanced Crm Group apply-to types as a JSON response.

/api/v2/admin/advanced-crm-groups/types

Data / Response:

N/A

[
  {
    "DisplayName": "string",
    "Value": "string"
  }
]