AlphaAlpha Docs
API ReferenceCrm settings

Get CRM settings

Returns CRM settings, creating defaults if not exists

GET
/crm/settings
AuthorizationBearer <token>

In: header

Response Body

application/json

application/json

application/json

application/json

application/json

curl -X GET "http://localhost:18080/api/v1/crm/settings"
{
  "createSalesOrderWithSchedule": true,
  "erpNotificationTriggers": [
    {
      "createTask": true,
      "customBody": "string",
      "customTitle": "string",
      "eventType": "ESTIMATE_SENT",
      "id": "string",
      "recipientRoleNames": [
        "string"
      ],
      "recipientUserIds": [
        "string"
      ],
      "sendEmail": true,
      "siteIds": [
        "string"
      ],
      "taskAssigneeUserId": "string",
      "taskDescription": "string",
      "taskEpicId": "string",
      "taskName": "string",
      "taskPriority": "LOW"
    }
  ],
  "id": "string",
  "leadFieldVisibility": {
    "instagramVisible": true,
    "isInstagramVisible": true
  },
  "leadSourceConfigs": [
    {
      "active": true,
      "color": "string",
      "displayName": "string",
      "isActive": true,
      "responseTimeHours": 0,
      "source": "string"
    }
  ],
  "notificationTriggers": [
    {
      "createTask": true,
      "customBody": "string",
      "customTitle": "string",
      "eventType": "OPPORTUNITY_STATUS_CHANGED",
      "id": "string",
      "recipientRoleNames": [
        "string"
      ],
      "recipientUserIds": [
        "string"
      ],
      "sendEmail": true,
      "targetActivityType": "CALL",
      "targetLeadStatus": "NEW",
      "targetStatus": "NEW",
      "taskAssigneeUserId": "string",
      "taskDescription": "string",
      "taskEpicId": "string",
      "taskName": "string",
      "taskPriority": "LOW"
    }
  ],
  "overdueNotificationUserIds": [
    "string"
  ],
  "paymentScheduleTemplate": [
    {
      "id": "string",
      "includeChangeOrders": true,
      "label": "string",
      "paymentDueDays": 0,
      "percentage": 0.1,
      "relativeDays": 0,
      "sortOrder": 0,
      "triggerStatus": "NEW",
      "triggerType": "STATUS_CHANGE"
    }
  ],
  "paymentScheduleTemplates": [
    {
      "id": "string",
      "milestones": [
        {
          "id": "string",
          "includeChangeOrders": true,
          "label": "string",
          "paymentDueDays": 0,
          "percentage": 0.1,
          "relativeDays": 0,
          "sortOrder": 0,
          "triggerStatus": "NEW",
          "triggerType": "STATUS_CHANGE"
        }
      ],
      "name": "string"
    }
  ],
  "questionnaireTemplate": [
    {
      "id": "string",
      "label": "string",
      "options": [
        "string"
      ],
      "required": true,
      "sortOrder": 0,
      "type": "TEXT"
    }
  ],
  "tenantId": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}