AlphaAlpha Docs

C R M Settings

CRM Settings API

Get CRM settings

GET
/crm/settings
AuthorizationBearer <token>

In: header

Response Body

application/json

application/json

application/json

application/json

curl -X GET "http://localhost:18080/api/v1/crm/settings"
{
  "createSalesOrderWithSchedule": true,
  "id": "string",
  "leadSourceConfigs": [
    {
      "active": true,
      "color": "string",
      "displayName": "string",
      "isActive": true,
      "responseTimeHours": 0,
      "source": "string"
    }
  ],
  "overdueNotificationUserIds": [
    "string"
  ],
  "paymentScheduleTemplate": [
    {
      "id": "string",
      "includeChangeOrders": true,
      "label": "string",
      "paymentDueDays": 0,
      "percentage": 0.1,
      "relativeDays": 0,
      "sortOrder": 0,
      "triggerStatus": "NEW",
      "triggerType": "STATUS_CHANGE"
    }
  ],
  "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"
}

Update CRM settings

PATCH
/crm/settings
AuthorizationBearer <token>

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

curl -X PATCH "http://localhost:18080/api/v1/crm/settings" \  -H "Content-Type: application/json" \  -d '{}'
{
  "createSalesOrderWithSchedule": true,
  "id": "string",
  "leadSourceConfigs": [
    {
      "active": true,
      "color": "string",
      "displayName": "string",
      "isActive": true,
      "responseTimeHours": 0,
      "source": "string"
    }
  ],
  "overdueNotificationUserIds": [
    "string"
  ],
  "paymentScheduleTemplate": [
    {
      "id": "string",
      "includeChangeOrders": true,
      "label": "string",
      "paymentDueDays": 0,
      "percentage": 0.1,
      "relativeDays": 0,
      "sortOrder": 0,
      "triggerStatus": "NEW",
      "triggerType": "STATUS_CHANGE"
    }
  ],
  "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"
}