AlphaAlpha Docs
API Reference

C R M Lead

API calls for CRM leads

Create a lead

POST
/crm/leads

Authorization

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 POST "http://localhost:18080/api/v1/crm/leads" \  -H "Content-Type: application/json" \  -d '{    "email": "string",    "firstName": "string",    "lastName": "string",    "source": "string",    "status": "NEW"  }'
{
  "address": {
    "city": "string",
    "country": "string",
    "houseNumber": "string",
    "id": "string",
    "latitude": 0.1,
    "longitude": 0.1,
    "postalCode": "string",
    "street": "string"
  },
  "companyName": "string",
  "companyWebsite": "string",
  "created": "2019-08-24T14:15:22Z",
  "createdBy": "string",
  "customer": {
    "email": "string",
    "id": "string",
    "name": "string",
    "phone": "string"
  },
  "customerId": "string",
  "email": "string",
  "events": [
    {
      "authorId": "string",
      "date": "2019-08-24T14:15:22Z",
      "description": "string",
      "id": "string",
      "type": "CREATE"
    }
  ],
  "firstName": "string",
  "id": "string",
  "industry": "string",
  "interest": "string",
  "lastName": "string",
  "message": "string",
  "nextAction": "string",
  "nextActionDueDate": "2019-08-24T14:15:22Z",
  "opportunity": {
    "id": "string",
    "name": "string",
    "value": 0.1
  },
  "opportunityId": "string",
  "owner": {
    "displayName": "string",
    "id": "string",
    "username": "string"
  },
  "ownerId": "string",
  "pageUrl": "string",
  "phone": "string",
  "qualificationNotes": "string",
  "qualifiedBy": "string",
  "qualifiedByUser": {
    "displayName": "string",
    "id": "string",
    "username": "string"
  },
  "qualifiedDate": "2019-08-24T14:15:22Z",
  "referrerUrl": "string",
  "source": "string",
  "sourceDetail": "string",
  "status": "NEW",
  "subsidiary": {
    "id": "string",
    "name": "string"
  },
  "subsidiaryId": "string",
  "tenantId": "string",
  "updated": "2019-08-24T14:15:22Z",
  "updatedBy": "string",
  "utmCampaign": "string",
  "utmContent": "string",
  "utmMedium": "string",
  "utmSource": "string",
  "utmTerm": "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"
}

Get leads by owner

GET
/crm/leads/by-owner/{ownerId}

Authorization

AuthorizationBearer <token>

In: header

Path Parameters

ownerId*string

Response Body

application/json

application/json

application/json

application/json

curl -X GET "http://localhost:18080/api/v1/crm/leads/by-owner/string"
[
  {
    "address": {
      "city": "string",
      "country": "string",
      "houseNumber": "string",
      "id": "string",
      "latitude": 0.1,
      "longitude": 0.1,
      "postalCode": "string",
      "street": "string"
    },
    "companyName": "string",
    "companyWebsite": "string",
    "created": "2019-08-24T14:15:22Z",
    "createdBy": "string",
    "customerId": "string",
    "email": "string",
    "events": [
      {
        "authorId": "string",
        "date": "2019-08-24T14:15:22Z",
        "description": "string",
        "id": "string",
        "type": "CREATE"
      }
    ],
    "firstName": "string",
    "id": "string",
    "industry": "string",
    "interest": "string",
    "lastName": "string",
    "message": "string",
    "nextAction": "string",
    "nextActionDueDate": "2019-08-24T14:15:22Z",
    "opportunityId": "string",
    "overdueNotifiedAt": "2019-08-24T14:15:22Z",
    "ownerId": "string",
    "pageUrl": "string",
    "phone": "string",
    "qualificationNotes": "string",
    "qualifiedBy": "string",
    "qualifiedDate": "2019-08-24T14:15:22Z",
    "referrerUrl": "string",
    "source": "string",
    "sourceDetail": "string",
    "status": "NEW",
    "subsidiaryId": "string",
    "tenantId": "string",
    "updated": "2019-08-24T14:15:22Z",
    "updatedBy": "string",
    "utmCampaign": "string",
    "utmContent": "string",
    "utmMedium": "string",
    "utmSource": "string",
    "utmTerm": "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"
}

Get leads by source

GET
/crm/leads/by-source/{source}

Authorization

AuthorizationBearer <token>

In: header

Path Parameters

source*string

Response Body

application/json

application/json

application/json

application/json

curl -X GET "http://localhost:18080/api/v1/crm/leads/by-source/string"
[
  {
    "address": {
      "city": "string",
      "country": "string",
      "houseNumber": "string",
      "id": "string",
      "latitude": 0.1,
      "longitude": 0.1,
      "postalCode": "string",
      "street": "string"
    },
    "companyName": "string",
    "companyWebsite": "string",
    "created": "2019-08-24T14:15:22Z",
    "createdBy": "string",
    "customerId": "string",
    "email": "string",
    "events": [
      {
        "authorId": "string",
        "date": "2019-08-24T14:15:22Z",
        "description": "string",
        "id": "string",
        "type": "CREATE"
      }
    ],
    "firstName": "string",
    "id": "string",
    "industry": "string",
    "interest": "string",
    "lastName": "string",
    "message": "string",
    "nextAction": "string",
    "nextActionDueDate": "2019-08-24T14:15:22Z",
    "opportunityId": "string",
    "overdueNotifiedAt": "2019-08-24T14:15:22Z",
    "ownerId": "string",
    "pageUrl": "string",
    "phone": "string",
    "qualificationNotes": "string",
    "qualifiedBy": "string",
    "qualifiedDate": "2019-08-24T14:15:22Z",
    "referrerUrl": "string",
    "source": "string",
    "sourceDetail": "string",
    "status": "NEW",
    "subsidiaryId": "string",
    "tenantId": "string",
    "updated": "2019-08-24T14:15:22Z",
    "updatedBy": "string",
    "utmCampaign": "string",
    "utmContent": "string",
    "utmMedium": "string",
    "utmSource": "string",
    "utmTerm": "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"
}

Get leads by status

GET
/crm/leads/by-status/{status}

Authorization

AuthorizationBearer <token>

In: header

Path Parameters

status*string
Value in"NEW" | "CONTACTED" | "QUALIFIED" | "UNQUALIFIED"

Response Body

application/json

application/json

application/json

application/json

curl -X GET "http://localhost:18080/api/v1/crm/leads/by-status/NEW"
[
  {
    "address": {
      "city": "string",
      "country": "string",
      "houseNumber": "string",
      "id": "string",
      "latitude": 0.1,
      "longitude": 0.1,
      "postalCode": "string",
      "street": "string"
    },
    "companyName": "string",
    "companyWebsite": "string",
    "created": "2019-08-24T14:15:22Z",
    "createdBy": "string",
    "customerId": "string",
    "email": "string",
    "events": [
      {
        "authorId": "string",
        "date": "2019-08-24T14:15:22Z",
        "description": "string",
        "id": "string",
        "type": "CREATE"
      }
    ],
    "firstName": "string",
    "id": "string",
    "industry": "string",
    "interest": "string",
    "lastName": "string",
    "message": "string",
    "nextAction": "string",
    "nextActionDueDate": "2019-08-24T14:15:22Z",
    "opportunityId": "string",
    "overdueNotifiedAt": "2019-08-24T14:15:22Z",
    "ownerId": "string",
    "pageUrl": "string",
    "phone": "string",
    "qualificationNotes": "string",
    "qualifiedBy": "string",
    "qualifiedDate": "2019-08-24T14:15:22Z",
    "referrerUrl": "string",
    "source": "string",
    "sourceDetail": "string",
    "status": "NEW",
    "subsidiaryId": "string",
    "tenantId": "string",
    "updated": "2019-08-24T14:15:22Z",
    "updatedBy": "string",
    "utmCampaign": "string",
    "utmContent": "string",
    "utmMedium": "string",
    "utmSource": "string",
    "utmTerm": "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"
}

Download Csv_ Lead

GET
/crm/leads/csv-export

Authorization

AuthorizationBearer <token>

In: header

Query Parameters

search?array<>
filters?array<>
page?integer
Default0
Formatint32
size?integer
Default20
Formatint32
sort?string

Response Body

application/json

application/json

application/json

application/json

curl -X GET "http://localhost:18080/api/v1/crm/leads/csv-export"
"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"
}

Delete a list of entities by their IDs

DELETE
/crm/leads/delete-list

Authorization

AuthorizationBearer <token>

In: header

Query Parameters

ids*array<>

Response Body

application/json

application/json

application/json

curl -X DELETE "http://localhost:18080/api/v1/crm/leads/delete-list?ids=string"
Empty
{
  "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"
}

Dynamic Search_ Lead

GET
/crm/leads/dynamic-search

Authorization

AuthorizationBearer <token>

In: header

Query Parameters

search?array<>
filters?array<>
page?integer
Default0
Formatint32
size?integer
Default20
Formatint32
sort?string

Response Body

application/json

application/json

application/json

application/json

curl -X GET "http://localhost:18080/api/v1/crm/leads/dynamic-search"
{
  "content": [
    {
      "address": {
        "city": "string",
        "country": "string",
        "houseNumber": "string",
        "id": "string",
        "latitude": 0.1,
        "longitude": 0.1,
        "postalCode": "string",
        "street": "string"
      },
      "companyName": "string",
      "companyWebsite": "string",
      "created": "2019-08-24T14:15:22Z",
      "createdBy": "string",
      "customerId": "string",
      "email": "string",
      "events": [
        {
          "authorId": "string",
          "date": "2019-08-24T14:15:22Z",
          "description": "string",
          "id": "string",
          "type": "CREATE"
        }
      ],
      "firstName": "string",
      "id": "string",
      "industry": "string",
      "interest": "string",
      "lastName": "string",
      "message": "string",
      "nextAction": "string",
      "nextActionDueDate": "2019-08-24T14:15:22Z",
      "opportunityId": "string",
      "overdueNotifiedAt": "2019-08-24T14:15:22Z",
      "ownerId": "string",
      "pageUrl": "string",
      "phone": "string",
      "qualificationNotes": "string",
      "qualifiedBy": "string",
      "qualifiedDate": "2019-08-24T14:15:22Z",
      "referrerUrl": "string",
      "source": "string",
      "sourceDetail": "string",
      "status": "NEW",
      "subsidiaryId": "string",
      "tenantId": "string",
      "updated": "2019-08-24T14:15:22Z",
      "updatedBy": "string",
      "utmCampaign": "string",
      "utmContent": "string",
      "utmMedium": "string",
      "utmSource": "string",
      "utmTerm": "string"
    }
  ],
  "empty": true,
  "first": true,
  "last": true,
  "number": 0,
  "numberOfElements": 0,
  "pageable": {
    "offset": 0,
    "pageNumber": 0,
    "pageSize": 0,
    "paged": true,
    "sort": {
      "empty": true,
      "sorted": true,
      "unsorted": true
    },
    "unpaged": true
  },
  "size": 0,
  "sort": {
    "empty": true,
    "sorted": true,
    "unsorted": true
  },
  "totalElements": 0,
  "totalPages": 0
}
{
  "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"
}

Dynamic Search Post_ Lead

POST
/crm/leads/dynamic-search

Authorization

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 POST "http://localhost:18080/api/v1/crm/leads/dynamic-search" \  -H "Content-Type: application/json" \  -d '{    "filters": {      "property1": null,      "property2": null    },    "page": 0,    "search": [      "string"    ],    "size": 0,    "sort": [      {        "ascending": true,        "field": "string"      }    ]  }'
{
  "content": [
    {
      "address": {
        "city": "string",
        "country": "string",
        "houseNumber": "string",
        "id": "string",
        "latitude": 0.1,
        "longitude": 0.1,
        "postalCode": "string",
        "street": "string"
      },
      "companyName": "string",
      "companyWebsite": "string",
      "created": "2019-08-24T14:15:22Z",
      "createdBy": "string",
      "customerId": "string",
      "email": "string",
      "events": [
        {
          "authorId": "string",
          "date": "2019-08-24T14:15:22Z",
          "description": "string",
          "id": "string",
          "type": "CREATE"
        }
      ],
      "firstName": "string",
      "id": "string",
      "industry": "string",
      "interest": "string",
      "lastName": "string",
      "message": "string",
      "nextAction": "string",
      "nextActionDueDate": "2019-08-24T14:15:22Z",
      "opportunityId": "string",
      "overdueNotifiedAt": "2019-08-24T14:15:22Z",
      "ownerId": "string",
      "pageUrl": "string",
      "phone": "string",
      "qualificationNotes": "string",
      "qualifiedBy": "string",
      "qualifiedDate": "2019-08-24T14:15:22Z",
      "referrerUrl": "string",
      "source": "string",
      "sourceDetail": "string",
      "status": "NEW",
      "subsidiaryId": "string",
      "tenantId": "string",
      "updated": "2019-08-24T14:15:22Z",
      "updatedBy": "string",
      "utmCampaign": "string",
      "utmContent": "string",
      "utmMedium": "string",
      "utmSource": "string",
      "utmTerm": "string"
    }
  ],
  "empty": true,
  "first": true,
  "last": true,
  "number": 0,
  "numberOfElements": 0,
  "pageable": {
    "offset": 0,
    "pageNumber": 0,
    "pageSize": 0,
    "paged": true,
    "sort": {
      "empty": true,
      "sorted": true,
      "unsorted": true
    },
    "unpaged": true
  },
  "size": 0,
  "sort": {
    "empty": true,
    "sorted": true,
    "unsorted": true
  },
  "totalElements": 0,
  "totalPages": 0
}
{
  "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"
}

Dynamic search leads enriched

GET
/crm/leads/dynamic-search-enriched

Authorization

AuthorizationBearer <token>

In: header

Query Parameters

search?array<>
filters?array<>
page?integer
Default0
Formatint32
size?integer
Default20
Formatint32
sort?string

Response Body

application/json

application/json

application/json

application/json

curl -X GET "http://localhost:18080/api/v1/crm/leads/dynamic-search-enriched"
{
  "content": [
    {
      "address": {
        "city": "string",
        "country": "string",
        "houseNumber": "string",
        "id": "string",
        "latitude": 0.1,
        "longitude": 0.1,
        "postalCode": "string",
        "street": "string"
      },
      "companyName": "string",
      "companyWebsite": "string",
      "created": "2019-08-24T14:15:22Z",
      "createdBy": "string",
      "customer": {
        "email": "string",
        "id": "string",
        "name": "string",
        "phone": "string"
      },
      "customerId": "string",
      "email": "string",
      "events": [
        {
          "authorId": "string",
          "date": "2019-08-24T14:15:22Z",
          "description": "string",
          "id": "string",
          "type": "CREATE"
        }
      ],
      "firstName": "string",
      "id": "string",
      "industry": "string",
      "interest": "string",
      "lastName": "string",
      "message": "string",
      "nextAction": "string",
      "nextActionDueDate": "2019-08-24T14:15:22Z",
      "opportunity": {
        "id": "string",
        "name": "string",
        "value": 0.1
      },
      "opportunityId": "string",
      "owner": {
        "displayName": "string",
        "id": "string",
        "username": "string"
      },
      "ownerId": "string",
      "pageUrl": "string",
      "phone": "string",
      "qualificationNotes": "string",
      "qualifiedBy": "string",
      "qualifiedByUser": {
        "displayName": "string",
        "id": "string",
        "username": "string"
      },
      "qualifiedDate": "2019-08-24T14:15:22Z",
      "referrerUrl": "string",
      "source": "string",
      "sourceDetail": "string",
      "status": "NEW",
      "subsidiary": {
        "id": "string",
        "name": "string"
      },
      "subsidiaryId": "string",
      "tenantId": "string",
      "updated": "2019-08-24T14:15:22Z",
      "updatedBy": "string",
      "utmCampaign": "string",
      "utmContent": "string",
      "utmMedium": "string",
      "utmSource": "string",
      "utmTerm": "string"
    }
  ],
  "empty": true,
  "first": true,
  "last": true,
  "number": 0,
  "numberOfElements": 0,
  "pageable": {
    "offset": 0,
    "pageNumber": 0,
    "pageSize": 0,
    "paged": true,
    "sort": {
      "empty": true,
      "sorted": true,
      "unsorted": true
    },
    "unpaged": true
  },
  "size": 0,
  "sort": {
    "empty": true,
    "sorted": true,
    "unsorted": true
  },
  "totalElements": 0,
  "totalPages": 0
}
{
  "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"
}

Find by list of ids in current tenant

GET
/crm/leads/find

Authorization

AuthorizationBearer <token>

In: header

Query Parameters

ids*array<>

Response Body

application/json

application/json

application/json

application/json

curl -X GET "http://localhost:18080/api/v1/crm/leads/find?ids=string"
[
  {
    "address": {
      "city": "string",
      "country": "string",
      "houseNumber": "string",
      "id": "string",
      "latitude": 0.1,
      "longitude": 0.1,
      "postalCode": "string",
      "street": "string"
    },
    "companyName": "string",
    "companyWebsite": "string",
    "created": "2019-08-24T14:15:22Z",
    "createdBy": "string",
    "customerId": "string",
    "email": "string",
    "events": [
      {
        "authorId": "string",
        "date": "2019-08-24T14:15:22Z",
        "description": "string",
        "id": "string",
        "type": "CREATE"
      }
    ],
    "firstName": "string",
    "id": "string",
    "industry": "string",
    "interest": "string",
    "lastName": "string",
    "message": "string",
    "nextAction": "string",
    "nextActionDueDate": "2019-08-24T14:15:22Z",
    "opportunityId": "string",
    "overdueNotifiedAt": "2019-08-24T14:15:22Z",
    "ownerId": "string",
    "pageUrl": "string",
    "phone": "string",
    "qualificationNotes": "string",
    "qualifiedBy": "string",
    "qualifiedDate": "2019-08-24T14:15:22Z",
    "referrerUrl": "string",
    "source": "string",
    "sourceDetail": "string",
    "status": "NEW",
    "subsidiaryId": "string",
    "tenantId": "string",
    "updated": "2019-08-24T14:15:22Z",
    "updatedBy": "string",
    "utmCampaign": "string",
    "utmContent": "string",
    "utmMedium": "string",
    "utmSource": "string",
    "utmTerm": "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"
}

Find all for current tenant

GET
/crm/leads/find-all

Authorization

AuthorizationBearer <token>

In: header

Response Body

application/json

application/json

application/json

application/json

curl -X GET "http://localhost:18080/api/v1/crm/leads/find-all"
[
  {
    "address": {
      "city": "string",
      "country": "string",
      "houseNumber": "string",
      "id": "string",
      "latitude": 0.1,
      "longitude": 0.1,
      "postalCode": "string",
      "street": "string"
    },
    "companyName": "string",
    "companyWebsite": "string",
    "created": "2019-08-24T14:15:22Z",
    "createdBy": "string",
    "customerId": "string",
    "email": "string",
    "events": [
      {
        "authorId": "string",
        "date": "2019-08-24T14:15:22Z",
        "description": "string",
        "id": "string",
        "type": "CREATE"
      }
    ],
    "firstName": "string",
    "id": "string",
    "industry": "string",
    "interest": "string",
    "lastName": "string",
    "message": "string",
    "nextAction": "string",
    "nextActionDueDate": "2019-08-24T14:15:22Z",
    "opportunityId": "string",
    "overdueNotifiedAt": "2019-08-24T14:15:22Z",
    "ownerId": "string",
    "pageUrl": "string",
    "phone": "string",
    "qualificationNotes": "string",
    "qualifiedBy": "string",
    "qualifiedDate": "2019-08-24T14:15:22Z",
    "referrerUrl": "string",
    "source": "string",
    "sourceDetail": "string",
    "status": "NEW",
    "subsidiaryId": "string",
    "tenantId": "string",
    "updated": "2019-08-24T14:15:22Z",
    "updatedBy": "string",
    "utmCampaign": "string",
    "utmContent": "string",
    "utmMedium": "string",
    "utmSource": "string",
    "utmTerm": "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"
}

Find a list of entities by their IDs

GET
/crm/leads/find-list

Authorization

AuthorizationBearer <token>

In: header

Query Parameters

ids?array<>

Response Body

application/json

application/json

application/json

application/json

curl -X GET "http://localhost:18080/api/v1/crm/leads/find-list"
[
  {
    "address": {
      "city": "string",
      "country": "string",
      "houseNumber": "string",
      "id": "string",
      "latitude": 0.1,
      "longitude": 0.1,
      "postalCode": "string",
      "street": "string"
    },
    "companyName": "string",
    "companyWebsite": "string",
    "created": "2019-08-24T14:15:22Z",
    "createdBy": "string",
    "customerId": "string",
    "email": "string",
    "events": [
      {
        "authorId": "string",
        "date": "2019-08-24T14:15:22Z",
        "description": "string",
        "id": "string",
        "type": "CREATE"
      }
    ],
    "firstName": "string",
    "id": "string",
    "industry": "string",
    "interest": "string",
    "lastName": "string",
    "message": "string",
    "nextAction": "string",
    "nextActionDueDate": "2019-08-24T14:15:22Z",
    "opportunityId": "string",
    "overdueNotifiedAt": "2019-08-24T14:15:22Z",
    "ownerId": "string",
    "pageUrl": "string",
    "phone": "string",
    "qualificationNotes": "string",
    "qualifiedBy": "string",
    "qualifiedDate": "2019-08-24T14:15:22Z",
    "referrerUrl": "string",
    "source": "string",
    "sourceDetail": "string",
    "status": "NEW",
    "subsidiaryId": "string",
    "tenantId": "string",
    "updated": "2019-08-24T14:15:22Z",
    "updatedBy": "string",
    "utmCampaign": "string",
    "utmContent": "string",
    "utmMedium": "string",
    "utmSource": "string",
    "utmTerm": "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"
}

Find by id in current tenant

GET
/crm/leads/find/{id}

Authorization

AuthorizationBearer <token>

In: header

Path Parameters

id*string

Response Body

application/json

application/json

application/json

application/json

curl -X GET "http://localhost:18080/api/v1/crm/leads/find/string"
{
  "address": {
    "city": "string",
    "country": "string",
    "houseNumber": "string",
    "id": "string",
    "latitude": 0.1,
    "longitude": 0.1,
    "postalCode": "string",
    "street": "string"
  },
  "companyName": "string",
  "companyWebsite": "string",
  "created": "2019-08-24T14:15:22Z",
  "createdBy": "string",
  "customerId": "string",
  "email": "string",
  "events": [
    {
      "authorId": "string",
      "date": "2019-08-24T14:15:22Z",
      "description": "string",
      "id": "string",
      "type": "CREATE"
    }
  ],
  "firstName": "string",
  "id": "string",
  "industry": "string",
  "interest": "string",
  "lastName": "string",
  "message": "string",
  "nextAction": "string",
  "nextActionDueDate": "2019-08-24T14:15:22Z",
  "opportunityId": "string",
  "overdueNotifiedAt": "2019-08-24T14:15:22Z",
  "ownerId": "string",
  "pageUrl": "string",
  "phone": "string",
  "qualificationNotes": "string",
  "qualifiedBy": "string",
  "qualifiedDate": "2019-08-24T14:15:22Z",
  "referrerUrl": "string",
  "source": "string",
  "sourceDetail": "string",
  "status": "NEW",
  "subsidiaryId": "string",
  "tenantId": "string",
  "updated": "2019-08-24T14:15:22Z",
  "updatedBy": "string",
  "utmCampaign": "string",
  "utmContent": "string",
  "utmMedium": "string",
  "utmSource": "string",
  "utmTerm": "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"
}

Get overdue actions

GET
/crm/leads/overdue-actions

Authorization

AuthorizationBearer <token>

In: header

Response Body

application/json

application/json

application/json

application/json

curl -X GET "http://localhost:18080/api/v1/crm/leads/overdue-actions"
[
  {
    "address": {
      "city": "string",
      "country": "string",
      "houseNumber": "string",
      "id": "string",
      "latitude": 0.1,
      "longitude": 0.1,
      "postalCode": "string",
      "street": "string"
    },
    "companyName": "string",
    "companyWebsite": "string",
    "created": "2019-08-24T14:15:22Z",
    "createdBy": "string",
    "customerId": "string",
    "email": "string",
    "events": [
      {
        "authorId": "string",
        "date": "2019-08-24T14:15:22Z",
        "description": "string",
        "id": "string",
        "type": "CREATE"
      }
    ],
    "firstName": "string",
    "id": "string",
    "industry": "string",
    "interest": "string",
    "lastName": "string",
    "message": "string",
    "nextAction": "string",
    "nextActionDueDate": "2019-08-24T14:15:22Z",
    "opportunityId": "string",
    "overdueNotifiedAt": "2019-08-24T14:15:22Z",
    "ownerId": "string",
    "pageUrl": "string",
    "phone": "string",
    "qualificationNotes": "string",
    "qualifiedBy": "string",
    "qualifiedDate": "2019-08-24T14:15:22Z",
    "referrerUrl": "string",
    "source": "string",
    "sourceDetail": "string",
    "status": "NEW",
    "subsidiaryId": "string",
    "tenantId": "string",
    "updated": "2019-08-24T14:15:22Z",
    "updatedBy": "string",
    "utmCampaign": "string",
    "utmContent": "string",
    "utmMedium": "string",
    "utmSource": "string",
    "utmTerm": "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"
}

Get paginated leads

GET
/crm/leads/page

Authorization

AuthorizationBearer <token>

In: header

Query Parameters

pageNumber?integer
Formatint32
pageSize?integer
Formatint32
sortBy?string
direction?string
Value in"ASC" | "DESC"
search?string

Response Body

application/json

application/json

application/json

application/json

curl -X GET "http://localhost:18080/api/v1/crm/leads/page"
{
  "content": [
    {
      "address": {
        "city": "string",
        "country": "string",
        "houseNumber": "string",
        "id": "string",
        "latitude": 0.1,
        "longitude": 0.1,
        "postalCode": "string",
        "street": "string"
      },
      "companyName": "string",
      "companyWebsite": "string",
      "created": "2019-08-24T14:15:22Z",
      "createdBy": "string",
      "customerId": "string",
      "email": "string",
      "events": [
        {
          "authorId": "string",
          "date": "2019-08-24T14:15:22Z",
          "description": "string",
          "id": "string",
          "type": "CREATE"
        }
      ],
      "firstName": "string",
      "id": "string",
      "industry": "string",
      "interest": "string",
      "lastName": "string",
      "message": "string",
      "nextAction": "string",
      "nextActionDueDate": "2019-08-24T14:15:22Z",
      "opportunityId": "string",
      "overdueNotifiedAt": "2019-08-24T14:15:22Z",
      "ownerId": "string",
      "pageUrl": "string",
      "phone": "string",
      "qualificationNotes": "string",
      "qualifiedBy": "string",
      "qualifiedDate": "2019-08-24T14:15:22Z",
      "referrerUrl": "string",
      "source": "string",
      "sourceDetail": "string",
      "status": "NEW",
      "subsidiaryId": "string",
      "tenantId": "string",
      "updated": "2019-08-24T14:15:22Z",
      "updatedBy": "string",
      "utmCampaign": "string",
      "utmContent": "string",
      "utmMedium": "string",
      "utmSource": "string",
      "utmTerm": "string"
    }
  ],
  "empty": true,
  "first": true,
  "last": true,
  "number": 0,
  "numberOfElements": 0,
  "pageable": {
    "offset": 0,
    "pageNumber": 0,
    "pageSize": 0,
    "paged": true,
    "sort": {
      "empty": true,
      "sorted": true,
      "unsorted": true
    },
    "unpaged": true
  },
  "size": 0,
  "sort": {
    "empty": true,
    "sorted": true,
    "unsorted": true
  },
  "totalElements": 0,
  "totalPages": 0
}
{
  "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"
}

Get lead stats

GET
/crm/leads/stats

Authorization

AuthorizationBearer <token>

In: header

Response Body

application/json

application/json

application/json

application/json

curl -X GET "http://localhost:18080/api/v1/crm/leads/stats"
{
  "contactedLeads": 0,
  "conversionRate": 0.1,
  "leadsBySource": {
    "property1": 0,
    "property2": 0
  },
  "leadsCreatedLast30Days": 0,
  "leadsCreatedLast7Days": 0,
  "newLeads": 0,
  "qualifiedLeads": 0,
  "totalLeads": 0,
  "unassignedLeads": 0,
  "unqualifiedLeads": 0
}
{
  "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"
}

Get today's actions

GET
/crm/leads/todays-actions

Authorization

AuthorizationBearer <token>

In: header

Response Body

application/json

application/json

application/json

application/json

curl -X GET "http://localhost:18080/api/v1/crm/leads/todays-actions"
[
  {
    "address": {
      "city": "string",
      "country": "string",
      "houseNumber": "string",
      "id": "string",
      "latitude": 0.1,
      "longitude": 0.1,
      "postalCode": "string",
      "street": "string"
    },
    "companyName": "string",
    "companyWebsite": "string",
    "created": "2019-08-24T14:15:22Z",
    "createdBy": "string",
    "customerId": "string",
    "email": "string",
    "events": [
      {
        "authorId": "string",
        "date": "2019-08-24T14:15:22Z",
        "description": "string",
        "id": "string",
        "type": "CREATE"
      }
    ],
    "firstName": "string",
    "id": "string",
    "industry": "string",
    "interest": "string",
    "lastName": "string",
    "message": "string",
    "nextAction": "string",
    "nextActionDueDate": "2019-08-24T14:15:22Z",
    "opportunityId": "string",
    "overdueNotifiedAt": "2019-08-24T14:15:22Z",
    "ownerId": "string",
    "pageUrl": "string",
    "phone": "string",
    "qualificationNotes": "string",
    "qualifiedBy": "string",
    "qualifiedDate": "2019-08-24T14:15:22Z",
    "referrerUrl": "string",
    "source": "string",
    "sourceDetail": "string",
    "status": "NEW",
    "subsidiaryId": "string",
    "tenantId": "string",
    "updated": "2019-08-24T14:15:22Z",
    "updatedBy": "string",
    "utmCampaign": "string",
    "utmContent": "string",
    "utmMedium": "string",
    "utmSource": "string",
    "utmTerm": "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"
}

Get unassigned leads

GET
/crm/leads/unassigned

Authorization

AuthorizationBearer <token>

In: header

Response Body

application/json

application/json

application/json

application/json

curl -X GET "http://localhost:18080/api/v1/crm/leads/unassigned"
[
  {
    "address": {
      "city": "string",
      "country": "string",
      "houseNumber": "string",
      "id": "string",
      "latitude": 0.1,
      "longitude": 0.1,
      "postalCode": "string",
      "street": "string"
    },
    "companyName": "string",
    "companyWebsite": "string",
    "created": "2019-08-24T14:15:22Z",
    "createdBy": "string",
    "customerId": "string",
    "email": "string",
    "events": [
      {
        "authorId": "string",
        "date": "2019-08-24T14:15:22Z",
        "description": "string",
        "id": "string",
        "type": "CREATE"
      }
    ],
    "firstName": "string",
    "id": "string",
    "industry": "string",
    "interest": "string",
    "lastName": "string",
    "message": "string",
    "nextAction": "string",
    "nextActionDueDate": "2019-08-24T14:15:22Z",
    "opportunityId": "string",
    "overdueNotifiedAt": "2019-08-24T14:15:22Z",
    "ownerId": "string",
    "pageUrl": "string",
    "phone": "string",
    "qualificationNotes": "string",
    "qualifiedBy": "string",
    "qualifiedDate": "2019-08-24T14:15:22Z",
    "referrerUrl": "string",
    "source": "string",
    "sourceDetail": "string",
    "status": "NEW",
    "subsidiaryId": "string",
    "tenantId": "string",
    "updated": "2019-08-24T14:15:22Z",
    "updatedBy": "string",
    "utmCampaign": "string",
    "utmContent": "string",
    "utmMedium": "string",
    "utmSource": "string",
    "utmTerm": "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"
}

Get enriched lead

GET
/crm/leads/{id}

Authorization

AuthorizationBearer <token>

In: header

Path Parameters

id*string

Response Body

application/json

application/json

application/json

application/json

curl -X GET "http://localhost:18080/api/v1/crm/leads/string"
{
  "address": {
    "city": "string",
    "country": "string",
    "houseNumber": "string",
    "id": "string",
    "latitude": 0.1,
    "longitude": 0.1,
    "postalCode": "string",
    "street": "string"
  },
  "companyName": "string",
  "companyWebsite": "string",
  "created": "2019-08-24T14:15:22Z",
  "createdBy": "string",
  "customer": {
    "email": "string",
    "id": "string",
    "name": "string",
    "phone": "string"
  },
  "customerId": "string",
  "email": "string",
  "events": [
    {
      "authorId": "string",
      "date": "2019-08-24T14:15:22Z",
      "description": "string",
      "id": "string",
      "type": "CREATE"
    }
  ],
  "firstName": "string",
  "id": "string",
  "industry": "string",
  "interest": "string",
  "lastName": "string",
  "message": "string",
  "nextAction": "string",
  "nextActionDueDate": "2019-08-24T14:15:22Z",
  "opportunity": {
    "id": "string",
    "name": "string",
    "value": 0.1
  },
  "opportunityId": "string",
  "owner": {
    "displayName": "string",
    "id": "string",
    "username": "string"
  },
  "ownerId": "string",
  "pageUrl": "string",
  "phone": "string",
  "qualificationNotes": "string",
  "qualifiedBy": "string",
  "qualifiedByUser": {
    "displayName": "string",
    "id": "string",
    "username": "string"
  },
  "qualifiedDate": "2019-08-24T14:15:22Z",
  "referrerUrl": "string",
  "source": "string",
  "sourceDetail": "string",
  "status": "NEW",
  "subsidiary": {
    "id": "string",
    "name": "string"
  },
  "subsidiaryId": "string",
  "tenantId": "string",
  "updated": "2019-08-24T14:15:22Z",
  "updatedBy": "string",
  "utmCampaign": "string",
  "utmContent": "string",
  "utmMedium": "string",
  "utmSource": "string",
  "utmTerm": "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 a lead

PATCH
/crm/leads/{id}

Authorization

AuthorizationBearer <token>

In: header

Path Parameters

id*string

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/leads/string" \  -H "Content-Type: application/json" \  -d '{    "email": "string",    "firstName": "string",    "lastName": "string",    "source": "string",    "status": "NEW"  }'
{
  "address": {
    "city": "string",
    "country": "string",
    "houseNumber": "string",
    "id": "string",
    "latitude": 0.1,
    "longitude": 0.1,
    "postalCode": "string",
    "street": "string"
  },
  "companyName": "string",
  "companyWebsite": "string",
  "created": "2019-08-24T14:15:22Z",
  "createdBy": "string",
  "customer": {
    "email": "string",
    "id": "string",
    "name": "string",
    "phone": "string"
  },
  "customerId": "string",
  "email": "string",
  "events": [
    {
      "authorId": "string",
      "date": "2019-08-24T14:15:22Z",
      "description": "string",
      "id": "string",
      "type": "CREATE"
    }
  ],
  "firstName": "string",
  "id": "string",
  "industry": "string",
  "interest": "string",
  "lastName": "string",
  "message": "string",
  "nextAction": "string",
  "nextActionDueDate": "2019-08-24T14:15:22Z",
  "opportunity": {
    "id": "string",
    "name": "string",
    "value": 0.1
  },
  "opportunityId": "string",
  "owner": {
    "displayName": "string",
    "id": "string",
    "username": "string"
  },
  "ownerId": "string",
  "pageUrl": "string",
  "phone": "string",
  "qualificationNotes": "string",
  "qualifiedBy": "string",
  "qualifiedByUser": {
    "displayName": "string",
    "id": "string",
    "username": "string"
  },
  "qualifiedDate": "2019-08-24T14:15:22Z",
  "referrerUrl": "string",
  "source": "string",
  "sourceDetail": "string",
  "status": "NEW",
  "subsidiary": {
    "id": "string",
    "name": "string"
  },
  "subsidiaryId": "string",
  "tenantId": "string",
  "updated": "2019-08-24T14:15:22Z",
  "updatedBy": "string",
  "utmCampaign": "string",
  "utmContent": "string",
  "utmMedium": "string",
  "utmSource": "string",
  "utmTerm": "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"
}

Delete by id in current tenant

DELETE
/crm/leads/{id}

Authorization

AuthorizationBearer <token>

In: header

Path Parameters

id*string

Response Body

application/json

application/json

application/json

curl -X DELETE "http://localhost:18080/api/v1/crm/leads/string"
Empty
{
  "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"
}

Add a comment to an entity

POST
/crm/leads/{id}/comment

Authorization

AuthorizationBearer <token>

In: header

Path Parameters

id*string

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

body*string

Response Body

application/json

application/json

application/json

application/json

curl -X POST "http://localhost:18080/api/v1/crm/leads/string/comment" \  -H "Content-Type: application/json" \  -d 'string'
{
  "address": {
    "city": "string",
    "country": "string",
    "houseNumber": "string",
    "id": "string",
    "latitude": 0.1,
    "longitude": 0.1,
    "postalCode": "string",
    "street": "string"
  },
  "companyName": "string",
  "companyWebsite": "string",
  "created": "2019-08-24T14:15:22Z",
  "createdBy": "string",
  "customer": {
    "email": "string",
    "id": "string",
    "name": "string",
    "phone": "string"
  },
  "customerId": "string",
  "email": "string",
  "events": [
    {
      "authorId": "string",
      "date": "2019-08-24T14:15:22Z",
      "description": "string",
      "id": "string",
      "type": "CREATE"
    }
  ],
  "firstName": "string",
  "id": "string",
  "industry": "string",
  "interest": "string",
  "lastName": "string",
  "message": "string",
  "nextAction": "string",
  "nextActionDueDate": "2019-08-24T14:15:22Z",
  "opportunity": {
    "id": "string",
    "name": "string",
    "value": 0.1
  },
  "opportunityId": "string",
  "owner": {
    "displayName": "string",
    "id": "string",
    "username": "string"
  },
  "ownerId": "string",
  "pageUrl": "string",
  "phone": "string",
  "qualificationNotes": "string",
  "qualifiedBy": "string",
  "qualifiedByUser": {
    "displayName": "string",
    "id": "string",
    "username": "string"
  },
  "qualifiedDate": "2019-08-24T14:15:22Z",
  "referrerUrl": "string",
  "source": "string",
  "sourceDetail": "string",
  "status": "NEW",
  "subsidiary": {
    "id": "string",
    "name": "string"
  },
  "subsidiaryId": "string",
  "tenantId": "string",
  "updated": "2019-08-24T14:15:22Z",
  "updatedBy": "string",
  "utmCampaign": "string",
  "utmContent": "string",
  "utmMedium": "string",
  "utmSource": "string",
  "utmTerm": "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 next action

PATCH
/crm/leads/{id}/next-action

Authorization

AuthorizationBearer <token>

In: header

Path Parameters

id*string

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/leads/string/next-action" \  -H "Content-Type: application/json" \  -d '{}'
{
  "address": {
    "city": "string",
    "country": "string",
    "houseNumber": "string",
    "id": "string",
    "latitude": 0.1,
    "longitude": 0.1,
    "postalCode": "string",
    "street": "string"
  },
  "companyName": "string",
  "companyWebsite": "string",
  "created": "2019-08-24T14:15:22Z",
  "createdBy": "string",
  "customer": {
    "email": "string",
    "id": "string",
    "name": "string",
    "phone": "string"
  },
  "customerId": "string",
  "email": "string",
  "events": [
    {
      "authorId": "string",
      "date": "2019-08-24T14:15:22Z",
      "description": "string",
      "id": "string",
      "type": "CREATE"
    }
  ],
  "firstName": "string",
  "id": "string",
  "industry": "string",
  "interest": "string",
  "lastName": "string",
  "message": "string",
  "nextAction": "string",
  "nextActionDueDate": "2019-08-24T14:15:22Z",
  "opportunity": {
    "id": "string",
    "name": "string",
    "value": 0.1
  },
  "opportunityId": "string",
  "owner": {
    "displayName": "string",
    "id": "string",
    "username": "string"
  },
  "ownerId": "string",
  "pageUrl": "string",
  "phone": "string",
  "qualificationNotes": "string",
  "qualifiedBy": "string",
  "qualifiedByUser": {
    "displayName": "string",
    "id": "string",
    "username": "string"
  },
  "qualifiedDate": "2019-08-24T14:15:22Z",
  "referrerUrl": "string",
  "source": "string",
  "sourceDetail": "string",
  "status": "NEW",
  "subsidiary": {
    "id": "string",
    "name": "string"
  },
  "subsidiaryId": "string",
  "tenantId": "string",
  "updated": "2019-08-24T14:15:22Z",
  "updatedBy": "string",
  "utmCampaign": "string",
  "utmContent": "string",
  "utmMedium": "string",
  "utmSource": "string",
  "utmTerm": "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"
}

Qualify a lead

POST
/crm/leads/{id}/qualify

Authorization

AuthorizationBearer <token>

In: header

Path Parameters

id*string

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 POST "http://localhost:18080/api/v1/crm/leads/string/qualify" \  -H "Content-Type: application/json" \  -d '{    "createFollowUpActivity": true,    "opportunityName": "string"  }'
{
  "customerId": "string",
  "lead": {
    "address": {
      "city": "string",
      "country": "string",
      "houseNumber": "string",
      "id": "string",
      "latitude": 0.1,
      "longitude": 0.1,
      "postalCode": "string",
      "street": "string"
    },
    "companyName": "string",
    "companyWebsite": "string",
    "created": "2019-08-24T14:15:22Z",
    "createdBy": "string",
    "customer": {
      "email": "string",
      "id": "string",
      "name": "string",
      "phone": "string"
    },
    "customerId": "string",
    "email": "string",
    "events": [
      {
        "authorId": "string",
        "date": "2019-08-24T14:15:22Z",
        "description": "string",
        "id": "string",
        "type": "CREATE"
      }
    ],
    "firstName": "string",
    "id": "string",
    "industry": "string",
    "interest": "string",
    "lastName": "string",
    "message": "string",
    "nextAction": "string",
    "nextActionDueDate": "2019-08-24T14:15:22Z",
    "opportunity": {
      "id": "string",
      "name": "string",
      "value": 0.1
    },
    "opportunityId": "string",
    "owner": {
      "displayName": "string",
      "id": "string",
      "username": "string"
    },
    "ownerId": "string",
    "pageUrl": "string",
    "phone": "string",
    "qualificationNotes": "string",
    "qualifiedBy": "string",
    "qualifiedByUser": {
      "displayName": "string",
      "id": "string",
      "username": "string"
    },
    "qualifiedDate": "2019-08-24T14:15:22Z",
    "referrerUrl": "string",
    "source": "string",
    "sourceDetail": "string",
    "status": "NEW",
    "subsidiary": {
      "id": "string",
      "name": "string"
    },
    "subsidiaryId": "string",
    "tenantId": "string",
    "updated": "2019-08-24T14:15:22Z",
    "updatedBy": "string",
    "utmCampaign": "string",
    "utmContent": "string",
    "utmMedium": "string",
    "utmSource": "string",
    "utmTerm": "string"
  },
  "opportunityId": "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"
}

Reject a lead

POST
/crm/leads/{id}/reject

Authorization

AuthorizationBearer <token>

In: header

Path Parameters

id*string

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

reason?string

Response Body

application/json

application/json

application/json

application/json

curl -X POST "http://localhost:18080/api/v1/crm/leads/string/reject" \  -H "Content-Type: application/json" \  -d '{}'
{
  "address": {
    "city": "string",
    "country": "string",
    "houseNumber": "string",
    "id": "string",
    "latitude": 0.1,
    "longitude": 0.1,
    "postalCode": "string",
    "street": "string"
  },
  "companyName": "string",
  "companyWebsite": "string",
  "created": "2019-08-24T14:15:22Z",
  "createdBy": "string",
  "customer": {
    "email": "string",
    "id": "string",
    "name": "string",
    "phone": "string"
  },
  "customerId": "string",
  "email": "string",
  "events": [
    {
      "authorId": "string",
      "date": "2019-08-24T14:15:22Z",
      "description": "string",
      "id": "string",
      "type": "CREATE"
    }
  ],
  "firstName": "string",
  "id": "string",
  "industry": "string",
  "interest": "string",
  "lastName": "string",
  "message": "string",
  "nextAction": "string",
  "nextActionDueDate": "2019-08-24T14:15:22Z",
  "opportunity": {
    "id": "string",
    "name": "string",
    "value": 0.1
  },
  "opportunityId": "string",
  "owner": {
    "displayName": "string",
    "id": "string",
    "username": "string"
  },
  "ownerId": "string",
  "pageUrl": "string",
  "phone": "string",
  "qualificationNotes": "string",
  "qualifiedBy": "string",
  "qualifiedByUser": {
    "displayName": "string",
    "id": "string",
    "username": "string"
  },
  "qualifiedDate": "2019-08-24T14:15:22Z",
  "referrerUrl": "string",
  "source": "string",
  "sourceDetail": "string",
  "status": "NEW",
  "subsidiary": {
    "id": "string",
    "name": "string"
  },
  "subsidiaryId": "string",
  "tenantId": "string",
  "updated": "2019-08-24T14:15:22Z",
  "updatedBy": "string",
  "utmCampaign": "string",
  "utmContent": "string",
  "utmMedium": "string",
  "utmSource": "string",
  "utmTerm": "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 lead status

PATCH
/crm/leads/{id}/status

Authorization

AuthorizationBearer <token>

In: header

Path Parameters

id*string

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/leads/string/status" \  -H "Content-Type: application/json" \  -d '{    "status": "NEW"  }'
{
  "address": {
    "city": "string",
    "country": "string",
    "houseNumber": "string",
    "id": "string",
    "latitude": 0.1,
    "longitude": 0.1,
    "postalCode": "string",
    "street": "string"
  },
  "companyName": "string",
  "companyWebsite": "string",
  "created": "2019-08-24T14:15:22Z",
  "createdBy": "string",
  "customer": {
    "email": "string",
    "id": "string",
    "name": "string",
    "phone": "string"
  },
  "customerId": "string",
  "email": "string",
  "events": [
    {
      "authorId": "string",
      "date": "2019-08-24T14:15:22Z",
      "description": "string",
      "id": "string",
      "type": "CREATE"
    }
  ],
  "firstName": "string",
  "id": "string",
  "industry": "string",
  "interest": "string",
  "lastName": "string",
  "message": "string",
  "nextAction": "string",
  "nextActionDueDate": "2019-08-24T14:15:22Z",
  "opportunity": {
    "id": "string",
    "name": "string",
    "value": 0.1
  },
  "opportunityId": "string",
  "owner": {
    "displayName": "string",
    "id": "string",
    "username": "string"
  },
  "ownerId": "string",
  "pageUrl": "string",
  "phone": "string",
  "qualificationNotes": "string",
  "qualifiedBy": "string",
  "qualifiedByUser": {
    "displayName": "string",
    "id": "string",
    "username": "string"
  },
  "qualifiedDate": "2019-08-24T14:15:22Z",
  "referrerUrl": "string",
  "source": "string",
  "sourceDetail": "string",
  "status": "NEW",
  "subsidiary": {
    "id": "string",
    "name": "string"
  },
  "subsidiaryId": "string",
  "tenantId": "string",
  "updated": "2019-08-24T14:15:22Z",
  "updatedBy": "string",
  "utmCampaign": "string",
  "utmContent": "string",
  "utmMedium": "string",
  "utmSource": "string",
  "utmTerm": "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"
}

C R M Dashboard

Previous Page

C R M Opportunity

Next Page