AlphaAlpha Docs
API Reference

C R M Activity

API calls for CRM activities

Create an activity

POST
/crm/activities

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/activities" \  -H "Content-Type: application/json" \  -d '{    "attendees": [      "string"    ],    "priority": "LOW",    "subject": "string",    "type": "CALL"  }'
{
  "attendees": [
    "string"
  ],
  "completedAt": "2019-08-24T14:15:22Z",
  "contactEmail": "string",
  "contactName": "string",
  "contactPhone": "string",
  "created": "2019-08-24T14:15:22Z",
  "createdBy": "string",
  "customer": {
    "email": "string",
    "id": "string",
    "name": "string",
    "phone": "string"
  },
  "customerId": "string",
  "description": "string",
  "dueDate": "2019-08-24T14:15:22Z",
  "durationMinutes": 0,
  "events": [
    {
      "authorId": "string",
      "date": "2019-08-24T14:15:22Z",
      "description": "string",
      "id": "string",
      "type": "CREATE"
    }
  ],
  "id": "string",
  "isCompleted": true,
  "location": "string",
  "opportunity": {
    "id": "string",
    "name": "string",
    "value": 0.1
  },
  "opportunityId": "string",
  "outcome": "string",
  "owner": {
    "displayName": "string",
    "id": "string",
    "username": "string"
  },
  "ownerId": "string",
  "priority": "LOW",
  "scheduledAt": "2019-08-24T14:15:22Z",
  "subject": "string",
  "tenantId": "string",
  "type": "CALL",
  "updated": "2019-08-24T14:15:22Z",
  "updatedBy": "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 activities by customer

GET
/crm/activities/by-customer/{customerId}

Authorization

AuthorizationBearer <token>

In: header

Path Parameters

customerId*string

Response Body

application/json

application/json

application/json

application/json

curl -X GET "http://localhost:18080/api/v1/crm/activities/by-customer/string"
[
  {
    "attendees": [
      "string"
    ],
    "completed": true,
    "completedAt": "2019-08-24T14:15:22Z",
    "contactEmail": "string",
    "contactName": "string",
    "contactPhone": "string",
    "created": "2019-08-24T14:15:22Z",
    "createdBy": "string",
    "customerId": "string",
    "description": "string",
    "dueDate": "2019-08-24T14:15:22Z",
    "dueNotifiedAt": "2019-08-24T14:15:22Z",
    "durationMinutes": 0,
    "events": [
      {
        "authorId": "string",
        "date": "2019-08-24T14:15:22Z",
        "description": "string",
        "id": "string",
        "type": "CREATE"
      }
    ],
    "id": "string",
    "isCompleted": true,
    "location": "string",
    "opportunityId": "string",
    "outcome": "string",
    "ownerId": "string",
    "priority": "LOW",
    "scheduledAt": "2019-08-24T14:15:22Z",
    "subject": "string",
    "tenantId": "string",
    "type": "CALL",
    "updated": "2019-08-24T14:15:22Z",
    "updatedBy": "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 activities by opportunity

GET
/crm/activities/by-opportunity/{opportunityId}

Authorization

AuthorizationBearer <token>

In: header

Path Parameters

opportunityId*string

Response Body

application/json

application/json

application/json

application/json

curl -X GET "http://localhost:18080/api/v1/crm/activities/by-opportunity/string"
[
  {
    "attendees": [
      "string"
    ],
    "completed": true,
    "completedAt": "2019-08-24T14:15:22Z",
    "contactEmail": "string",
    "contactName": "string",
    "contactPhone": "string",
    "created": "2019-08-24T14:15:22Z",
    "createdBy": "string",
    "customerId": "string",
    "description": "string",
    "dueDate": "2019-08-24T14:15:22Z",
    "dueNotifiedAt": "2019-08-24T14:15:22Z",
    "durationMinutes": 0,
    "events": [
      {
        "authorId": "string",
        "date": "2019-08-24T14:15:22Z",
        "description": "string",
        "id": "string",
        "type": "CREATE"
      }
    ],
    "id": "string",
    "isCompleted": true,
    "location": "string",
    "opportunityId": "string",
    "outcome": "string",
    "ownerId": "string",
    "priority": "LOW",
    "scheduledAt": "2019-08-24T14:15:22Z",
    "subject": "string",
    "tenantId": "string",
    "type": "CALL",
    "updated": "2019-08-24T14:15:22Z",
    "updatedBy": "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 activities by owner

GET
/crm/activities/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/activities/by-owner/string"
[
  {
    "attendees": [
      "string"
    ],
    "completed": true,
    "completedAt": "2019-08-24T14:15:22Z",
    "contactEmail": "string",
    "contactName": "string",
    "contactPhone": "string",
    "created": "2019-08-24T14:15:22Z",
    "createdBy": "string",
    "customerId": "string",
    "description": "string",
    "dueDate": "2019-08-24T14:15:22Z",
    "dueNotifiedAt": "2019-08-24T14:15:22Z",
    "durationMinutes": 0,
    "events": [
      {
        "authorId": "string",
        "date": "2019-08-24T14:15:22Z",
        "description": "string",
        "id": "string",
        "type": "CREATE"
      }
    ],
    "id": "string",
    "isCompleted": true,
    "location": "string",
    "opportunityId": "string",
    "outcome": "string",
    "ownerId": "string",
    "priority": "LOW",
    "scheduledAt": "2019-08-24T14:15:22Z",
    "subject": "string",
    "tenantId": "string",
    "type": "CALL",
    "updated": "2019-08-24T14:15:22Z",
    "updatedBy": "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 activities by type

GET
/crm/activities/by-type/{type}

Authorization

AuthorizationBearer <token>

In: header

Path Parameters

type*string
Value in"CALL" | "EMAIL" | "MEETING" | "NOTE" | "TASK"

Response Body

application/json

application/json

application/json

application/json

curl -X GET "http://localhost:18080/api/v1/crm/activities/by-type/CALL"
[
  {
    "attendees": [
      "string"
    ],
    "completed": true,
    "completedAt": "2019-08-24T14:15:22Z",
    "contactEmail": "string",
    "contactName": "string",
    "contactPhone": "string",
    "created": "2019-08-24T14:15:22Z",
    "createdBy": "string",
    "customerId": "string",
    "description": "string",
    "dueDate": "2019-08-24T14:15:22Z",
    "dueNotifiedAt": "2019-08-24T14:15:22Z",
    "durationMinutes": 0,
    "events": [
      {
        "authorId": "string",
        "date": "2019-08-24T14:15:22Z",
        "description": "string",
        "id": "string",
        "type": "CREATE"
      }
    ],
    "id": "string",
    "isCompleted": true,
    "location": "string",
    "opportunityId": "string",
    "outcome": "string",
    "ownerId": "string",
    "priority": "LOW",
    "scheduledAt": "2019-08-24T14:15:22Z",
    "subject": "string",
    "tenantId": "string",
    "type": "CALL",
    "updated": "2019-08-24T14:15:22Z",
    "updatedBy": "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 completed activities

GET
/crm/activities/completed

Authorization

AuthorizationBearer <token>

In: header

Response Body

application/json

application/json

application/json

application/json

curl -X GET "http://localhost:18080/api/v1/crm/activities/completed"
[
  {
    "attendees": [
      "string"
    ],
    "completed": true,
    "completedAt": "2019-08-24T14:15:22Z",
    "contactEmail": "string",
    "contactName": "string",
    "contactPhone": "string",
    "created": "2019-08-24T14:15:22Z",
    "createdBy": "string",
    "customerId": "string",
    "description": "string",
    "dueDate": "2019-08-24T14:15:22Z",
    "dueNotifiedAt": "2019-08-24T14:15:22Z",
    "durationMinutes": 0,
    "events": [
      {
        "authorId": "string",
        "date": "2019-08-24T14:15:22Z",
        "description": "string",
        "id": "string",
        "type": "CREATE"
      }
    ],
    "id": "string",
    "isCompleted": true,
    "location": "string",
    "opportunityId": "string",
    "outcome": "string",
    "ownerId": "string",
    "priority": "LOW",
    "scheduledAt": "2019-08-24T14:15:22Z",
    "subject": "string",
    "tenantId": "string",
    "type": "CALL",
    "updated": "2019-08-24T14:15:22Z",
    "updatedBy": "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_ Activity

GET
/crm/activities/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/activities/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/activities/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/activities/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_ Activity

GET
/crm/activities/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/activities/dynamic-search"
{
  "content": [
    {
      "attendees": [
        "string"
      ],
      "completed": true,
      "completedAt": "2019-08-24T14:15:22Z",
      "contactEmail": "string",
      "contactName": "string",
      "contactPhone": "string",
      "created": "2019-08-24T14:15:22Z",
      "createdBy": "string",
      "customerId": "string",
      "description": "string",
      "dueDate": "2019-08-24T14:15:22Z",
      "dueNotifiedAt": "2019-08-24T14:15:22Z",
      "durationMinutes": 0,
      "events": [
        {
          "authorId": "string",
          "date": "2019-08-24T14:15:22Z",
          "description": "string",
          "id": "string",
          "type": "CREATE"
        }
      ],
      "id": "string",
      "isCompleted": true,
      "location": "string",
      "opportunityId": "string",
      "outcome": "string",
      "ownerId": "string",
      "priority": "LOW",
      "scheduledAt": "2019-08-24T14:15:22Z",
      "subject": "string",
      "tenantId": "string",
      "type": "CALL",
      "updated": "2019-08-24T14:15:22Z",
      "updatedBy": "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_ Activity

POST
/crm/activities/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/activities/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": [
    {
      "attendees": [
        "string"
      ],
      "completed": true,
      "completedAt": "2019-08-24T14:15:22Z",
      "contactEmail": "string",
      "contactName": "string",
      "contactPhone": "string",
      "created": "2019-08-24T14:15:22Z",
      "createdBy": "string",
      "customerId": "string",
      "description": "string",
      "dueDate": "2019-08-24T14:15:22Z",
      "dueNotifiedAt": "2019-08-24T14:15:22Z",
      "durationMinutes": 0,
      "events": [
        {
          "authorId": "string",
          "date": "2019-08-24T14:15:22Z",
          "description": "string",
          "id": "string",
          "type": "CREATE"
        }
      ],
      "id": "string",
      "isCompleted": true,
      "location": "string",
      "opportunityId": "string",
      "outcome": "string",
      "ownerId": "string",
      "priority": "LOW",
      "scheduledAt": "2019-08-24T14:15:22Z",
      "subject": "string",
      "tenantId": "string",
      "type": "CALL",
      "updated": "2019-08-24T14:15:22Z",
      "updatedBy": "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 activities enriched

GET
/crm/activities/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/activities/dynamic-search-enriched"
{
  "content": [
    {
      "attendees": [
        "string"
      ],
      "completedAt": "2019-08-24T14:15:22Z",
      "contactEmail": "string",
      "contactName": "string",
      "contactPhone": "string",
      "created": "2019-08-24T14:15:22Z",
      "createdBy": "string",
      "customer": {
        "email": "string",
        "id": "string",
        "name": "string",
        "phone": "string"
      },
      "customerId": "string",
      "description": "string",
      "dueDate": "2019-08-24T14:15:22Z",
      "durationMinutes": 0,
      "events": [
        {
          "authorId": "string",
          "date": "2019-08-24T14:15:22Z",
          "description": "string",
          "id": "string",
          "type": "CREATE"
        }
      ],
      "id": "string",
      "isCompleted": true,
      "location": "string",
      "opportunity": {
        "id": "string",
        "name": "string",
        "value": 0.1
      },
      "opportunityId": "string",
      "outcome": "string",
      "owner": {
        "displayName": "string",
        "id": "string",
        "username": "string"
      },
      "ownerId": "string",
      "priority": "LOW",
      "scheduledAt": "2019-08-24T14:15:22Z",
      "subject": "string",
      "tenantId": "string",
      "type": "CALL",
      "updated": "2019-08-24T14:15:22Z",
      "updatedBy": "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/activities/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/activities/find?ids=string"
[
  {
    "attendees": [
      "string"
    ],
    "completed": true,
    "completedAt": "2019-08-24T14:15:22Z",
    "contactEmail": "string",
    "contactName": "string",
    "contactPhone": "string",
    "created": "2019-08-24T14:15:22Z",
    "createdBy": "string",
    "customerId": "string",
    "description": "string",
    "dueDate": "2019-08-24T14:15:22Z",
    "dueNotifiedAt": "2019-08-24T14:15:22Z",
    "durationMinutes": 0,
    "events": [
      {
        "authorId": "string",
        "date": "2019-08-24T14:15:22Z",
        "description": "string",
        "id": "string",
        "type": "CREATE"
      }
    ],
    "id": "string",
    "isCompleted": true,
    "location": "string",
    "opportunityId": "string",
    "outcome": "string",
    "ownerId": "string",
    "priority": "LOW",
    "scheduledAt": "2019-08-24T14:15:22Z",
    "subject": "string",
    "tenantId": "string",
    "type": "CALL",
    "updated": "2019-08-24T14:15:22Z",
    "updatedBy": "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/activities/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/activities/find-all"
[
  {
    "attendees": [
      "string"
    ],
    "completed": true,
    "completedAt": "2019-08-24T14:15:22Z",
    "contactEmail": "string",
    "contactName": "string",
    "contactPhone": "string",
    "created": "2019-08-24T14:15:22Z",
    "createdBy": "string",
    "customerId": "string",
    "description": "string",
    "dueDate": "2019-08-24T14:15:22Z",
    "dueNotifiedAt": "2019-08-24T14:15:22Z",
    "durationMinutes": 0,
    "events": [
      {
        "authorId": "string",
        "date": "2019-08-24T14:15:22Z",
        "description": "string",
        "id": "string",
        "type": "CREATE"
      }
    ],
    "id": "string",
    "isCompleted": true,
    "location": "string",
    "opportunityId": "string",
    "outcome": "string",
    "ownerId": "string",
    "priority": "LOW",
    "scheduledAt": "2019-08-24T14:15:22Z",
    "subject": "string",
    "tenantId": "string",
    "type": "CALL",
    "updated": "2019-08-24T14:15:22Z",
    "updatedBy": "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/activities/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/activities/find-list"
[
  {
    "attendees": [
      "string"
    ],
    "completed": true,
    "completedAt": "2019-08-24T14:15:22Z",
    "contactEmail": "string",
    "contactName": "string",
    "contactPhone": "string",
    "created": "2019-08-24T14:15:22Z",
    "createdBy": "string",
    "customerId": "string",
    "description": "string",
    "dueDate": "2019-08-24T14:15:22Z",
    "dueNotifiedAt": "2019-08-24T14:15:22Z",
    "durationMinutes": 0,
    "events": [
      {
        "authorId": "string",
        "date": "2019-08-24T14:15:22Z",
        "description": "string",
        "id": "string",
        "type": "CREATE"
      }
    ],
    "id": "string",
    "isCompleted": true,
    "location": "string",
    "opportunityId": "string",
    "outcome": "string",
    "ownerId": "string",
    "priority": "LOW",
    "scheduledAt": "2019-08-24T14:15:22Z",
    "subject": "string",
    "tenantId": "string",
    "type": "CALL",
    "updated": "2019-08-24T14:15:22Z",
    "updatedBy": "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/activities/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/activities/find/string"
{
  "attendees": [
    "string"
  ],
  "completed": true,
  "completedAt": "2019-08-24T14:15:22Z",
  "contactEmail": "string",
  "contactName": "string",
  "contactPhone": "string",
  "created": "2019-08-24T14:15:22Z",
  "createdBy": "string",
  "customerId": "string",
  "description": "string",
  "dueDate": "2019-08-24T14:15:22Z",
  "dueNotifiedAt": "2019-08-24T14:15:22Z",
  "durationMinutes": 0,
  "events": [
    {
      "authorId": "string",
      "date": "2019-08-24T14:15:22Z",
      "description": "string",
      "id": "string",
      "type": "CREATE"
    }
  ],
  "id": "string",
  "isCompleted": true,
  "location": "string",
  "opportunityId": "string",
  "outcome": "string",
  "ownerId": "string",
  "priority": "LOW",
  "scheduledAt": "2019-08-24T14:15:22Z",
  "subject": "string",
  "tenantId": "string",
  "type": "CALL",
  "updated": "2019-08-24T14:15:22Z",
  "updatedBy": "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 my pending activities

GET
/crm/activities/my-pending

Authorization

AuthorizationBearer <token>

In: header

Response Body

application/json

application/json

application/json

application/json

curl -X GET "http://localhost:18080/api/v1/crm/activities/my-pending"
[
  {
    "attendees": [
      "string"
    ],
    "completed": true,
    "completedAt": "2019-08-24T14:15:22Z",
    "contactEmail": "string",
    "contactName": "string",
    "contactPhone": "string",
    "created": "2019-08-24T14:15:22Z",
    "createdBy": "string",
    "customerId": "string",
    "description": "string",
    "dueDate": "2019-08-24T14:15:22Z",
    "dueNotifiedAt": "2019-08-24T14:15:22Z",
    "durationMinutes": 0,
    "events": [
      {
        "authorId": "string",
        "date": "2019-08-24T14:15:22Z",
        "description": "string",
        "id": "string",
        "type": "CREATE"
      }
    ],
    "id": "string",
    "isCompleted": true,
    "location": "string",
    "opportunityId": "string",
    "outcome": "string",
    "ownerId": "string",
    "priority": "LOW",
    "scheduledAt": "2019-08-24T14:15:22Z",
    "subject": "string",
    "tenantId": "string",
    "type": "CALL",
    "updated": "2019-08-24T14:15:22Z",
    "updatedBy": "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 activities

GET
/crm/activities/overdue

Authorization

AuthorizationBearer <token>

In: header

Response Body

application/json

application/json

application/json

application/json

curl -X GET "http://localhost:18080/api/v1/crm/activities/overdue"
[
  {
    "attendees": [
      "string"
    ],
    "completed": true,
    "completedAt": "2019-08-24T14:15:22Z",
    "contactEmail": "string",
    "contactName": "string",
    "contactPhone": "string",
    "created": "2019-08-24T14:15:22Z",
    "createdBy": "string",
    "customerId": "string",
    "description": "string",
    "dueDate": "2019-08-24T14:15:22Z",
    "dueNotifiedAt": "2019-08-24T14:15:22Z",
    "durationMinutes": 0,
    "events": [
      {
        "authorId": "string",
        "date": "2019-08-24T14:15:22Z",
        "description": "string",
        "id": "string",
        "type": "CREATE"
      }
    ],
    "id": "string",
    "isCompleted": true,
    "location": "string",
    "opportunityId": "string",
    "outcome": "string",
    "ownerId": "string",
    "priority": "LOW",
    "scheduledAt": "2019-08-24T14:15:22Z",
    "subject": "string",
    "tenantId": "string",
    "type": "CALL",
    "updated": "2019-08-24T14:15:22Z",
    "updatedBy": "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 tasks

GET
/crm/activities/overdue-tasks

Authorization

AuthorizationBearer <token>

In: header

Response Body

application/json

application/json

application/json

application/json

curl -X GET "http://localhost:18080/api/v1/crm/activities/overdue-tasks"
[
  {
    "attendees": [
      "string"
    ],
    "completed": true,
    "completedAt": "2019-08-24T14:15:22Z",
    "contactEmail": "string",
    "contactName": "string",
    "contactPhone": "string",
    "created": "2019-08-24T14:15:22Z",
    "createdBy": "string",
    "customerId": "string",
    "description": "string",
    "dueDate": "2019-08-24T14:15:22Z",
    "dueNotifiedAt": "2019-08-24T14:15:22Z",
    "durationMinutes": 0,
    "events": [
      {
        "authorId": "string",
        "date": "2019-08-24T14:15:22Z",
        "description": "string",
        "id": "string",
        "type": "CREATE"
      }
    ],
    "id": "string",
    "isCompleted": true,
    "location": "string",
    "opportunityId": "string",
    "outcome": "string",
    "ownerId": "string",
    "priority": "LOW",
    "scheduledAt": "2019-08-24T14:15:22Z",
    "subject": "string",
    "tenantId": "string",
    "type": "CALL",
    "updated": "2019-08-24T14:15:22Z",
    "updatedBy": "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 activities

GET
/crm/activities/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/activities/page"
{
  "content": [
    {
      "attendees": [
        "string"
      ],
      "completed": true,
      "completedAt": "2019-08-24T14:15:22Z",
      "contactEmail": "string",
      "contactName": "string",
      "contactPhone": "string",
      "created": "2019-08-24T14:15:22Z",
      "createdBy": "string",
      "customerId": "string",
      "description": "string",
      "dueDate": "2019-08-24T14:15:22Z",
      "dueNotifiedAt": "2019-08-24T14:15:22Z",
      "durationMinutes": 0,
      "events": [
        {
          "authorId": "string",
          "date": "2019-08-24T14:15:22Z",
          "description": "string",
          "id": "string",
          "type": "CREATE"
        }
      ],
      "id": "string",
      "isCompleted": true,
      "location": "string",
      "opportunityId": "string",
      "outcome": "string",
      "ownerId": "string",
      "priority": "LOW",
      "scheduledAt": "2019-08-24T14:15:22Z",
      "subject": "string",
      "tenantId": "string",
      "type": "CALL",
      "updated": "2019-08-24T14:15:22Z",
      "updatedBy": "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 pending activities

GET
/crm/activities/pending

Authorization

AuthorizationBearer <token>

In: header

Response Body

application/json

application/json

application/json

application/json

curl -X GET "http://localhost:18080/api/v1/crm/activities/pending"
[
  {
    "attendees": [
      "string"
    ],
    "completed": true,
    "completedAt": "2019-08-24T14:15:22Z",
    "contactEmail": "string",
    "contactName": "string",
    "contactPhone": "string",
    "created": "2019-08-24T14:15:22Z",
    "createdBy": "string",
    "customerId": "string",
    "description": "string",
    "dueDate": "2019-08-24T14:15:22Z",
    "dueNotifiedAt": "2019-08-24T14:15:22Z",
    "durationMinutes": 0,
    "events": [
      {
        "authorId": "string",
        "date": "2019-08-24T14:15:22Z",
        "description": "string",
        "id": "string",
        "type": "CREATE"
      }
    ],
    "id": "string",
    "isCompleted": true,
    "location": "string",
    "opportunityId": "string",
    "outcome": "string",
    "ownerId": "string",
    "priority": "LOW",
    "scheduledAt": "2019-08-24T14:15:22Z",
    "subject": "string",
    "tenantId": "string",
    "type": "CALL",
    "updated": "2019-08-24T14:15:22Z",
    "updatedBy": "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 activity stats

GET
/crm/activities/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/activities/stats"
{
  "property1": 0,
  "property2": 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 tasks due today

GET
/crm/activities/tasks-due-today

Authorization

AuthorizationBearer <token>

In: header

Response Body

application/json

application/json

application/json

application/json

curl -X GET "http://localhost:18080/api/v1/crm/activities/tasks-due-today"
[
  {
    "attendees": [
      "string"
    ],
    "completed": true,
    "completedAt": "2019-08-24T14:15:22Z",
    "contactEmail": "string",
    "contactName": "string",
    "contactPhone": "string",
    "created": "2019-08-24T14:15:22Z",
    "createdBy": "string",
    "customerId": "string",
    "description": "string",
    "dueDate": "2019-08-24T14:15:22Z",
    "dueNotifiedAt": "2019-08-24T14:15:22Z",
    "durationMinutes": 0,
    "events": [
      {
        "authorId": "string",
        "date": "2019-08-24T14:15:22Z",
        "description": "string",
        "id": "string",
        "type": "CREATE"
      }
    ],
    "id": "string",
    "isCompleted": true,
    "location": "string",
    "opportunityId": "string",
    "outcome": "string",
    "ownerId": "string",
    "priority": "LOW",
    "scheduledAt": "2019-08-24T14:15:22Z",
    "subject": "string",
    "tenantId": "string",
    "type": "CALL",
    "updated": "2019-08-24T14:15:22Z",
    "updatedBy": "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 today's activities

GET
/crm/activities/today

Authorization

AuthorizationBearer <token>

In: header

Response Body

application/json

application/json

application/json

application/json

curl -X GET "http://localhost:18080/api/v1/crm/activities/today"
[
  {
    "attendees": [
      "string"
    ],
    "completed": true,
    "completedAt": "2019-08-24T14:15:22Z",
    "contactEmail": "string",
    "contactName": "string",
    "contactPhone": "string",
    "created": "2019-08-24T14:15:22Z",
    "createdBy": "string",
    "customerId": "string",
    "description": "string",
    "dueDate": "2019-08-24T14:15:22Z",
    "dueNotifiedAt": "2019-08-24T14:15:22Z",
    "durationMinutes": 0,
    "events": [
      {
        "authorId": "string",
        "date": "2019-08-24T14:15:22Z",
        "description": "string",
        "id": "string",
        "type": "CREATE"
      }
    ],
    "id": "string",
    "isCompleted": true,
    "location": "string",
    "opportunityId": "string",
    "outcome": "string",
    "ownerId": "string",
    "priority": "LOW",
    "scheduledAt": "2019-08-24T14:15:22Z",
    "subject": "string",
    "tenantId": "string",
    "type": "CALL",
    "updated": "2019-08-24T14:15:22Z",
    "updatedBy": "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 upcoming activities

GET
/crm/activities/upcoming

Authorization

AuthorizationBearer <token>

In: header

Response Body

application/json

application/json

application/json

application/json

curl -X GET "http://localhost:18080/api/v1/crm/activities/upcoming"
[
  {
    "attendees": [
      "string"
    ],
    "completed": true,
    "completedAt": "2019-08-24T14:15:22Z",
    "contactEmail": "string",
    "contactName": "string",
    "contactPhone": "string",
    "created": "2019-08-24T14:15:22Z",
    "createdBy": "string",
    "customerId": "string",
    "description": "string",
    "dueDate": "2019-08-24T14:15:22Z",
    "dueNotifiedAt": "2019-08-24T14:15:22Z",
    "durationMinutes": 0,
    "events": [
      {
        "authorId": "string",
        "date": "2019-08-24T14:15:22Z",
        "description": "string",
        "id": "string",
        "type": "CREATE"
      }
    ],
    "id": "string",
    "isCompleted": true,
    "location": "string",
    "opportunityId": "string",
    "outcome": "string",
    "ownerId": "string",
    "priority": "LOW",
    "scheduledAt": "2019-08-24T14:15:22Z",
    "subject": "string",
    "tenantId": "string",
    "type": "CALL",
    "updated": "2019-08-24T14:15:22Z",
    "updatedBy": "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 activity

GET
/crm/activities/{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/activities/string"
{
  "attendees": [
    "string"
  ],
  "completedAt": "2019-08-24T14:15:22Z",
  "contactEmail": "string",
  "contactName": "string",
  "contactPhone": "string",
  "created": "2019-08-24T14:15:22Z",
  "createdBy": "string",
  "customer": {
    "email": "string",
    "id": "string",
    "name": "string",
    "phone": "string"
  },
  "customerId": "string",
  "description": "string",
  "dueDate": "2019-08-24T14:15:22Z",
  "durationMinutes": 0,
  "events": [
    {
      "authorId": "string",
      "date": "2019-08-24T14:15:22Z",
      "description": "string",
      "id": "string",
      "type": "CREATE"
    }
  ],
  "id": "string",
  "isCompleted": true,
  "location": "string",
  "opportunity": {
    "id": "string",
    "name": "string",
    "value": 0.1
  },
  "opportunityId": "string",
  "outcome": "string",
  "owner": {
    "displayName": "string",
    "id": "string",
    "username": "string"
  },
  "ownerId": "string",
  "priority": "LOW",
  "scheduledAt": "2019-08-24T14:15:22Z",
  "subject": "string",
  "tenantId": "string",
  "type": "CALL",
  "updated": "2019-08-24T14:15:22Z",
  "updatedBy": "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 an activity

PATCH
/crm/activities/{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/activities/string" \  -H "Content-Type: application/json" \  -d '{    "attendees": [      "string"    ],    "priority": "LOW",    "subject": "string",    "type": "CALL"  }'
{
  "attendees": [
    "string"
  ],
  "completedAt": "2019-08-24T14:15:22Z",
  "contactEmail": "string",
  "contactName": "string",
  "contactPhone": "string",
  "created": "2019-08-24T14:15:22Z",
  "createdBy": "string",
  "customer": {
    "email": "string",
    "id": "string",
    "name": "string",
    "phone": "string"
  },
  "customerId": "string",
  "description": "string",
  "dueDate": "2019-08-24T14:15:22Z",
  "durationMinutes": 0,
  "events": [
    {
      "authorId": "string",
      "date": "2019-08-24T14:15:22Z",
      "description": "string",
      "id": "string",
      "type": "CREATE"
    }
  ],
  "id": "string",
  "isCompleted": true,
  "location": "string",
  "opportunity": {
    "id": "string",
    "name": "string",
    "value": 0.1
  },
  "opportunityId": "string",
  "outcome": "string",
  "owner": {
    "displayName": "string",
    "id": "string",
    "username": "string"
  },
  "ownerId": "string",
  "priority": "LOW",
  "scheduledAt": "2019-08-24T14:15:22Z",
  "subject": "string",
  "tenantId": "string",
  "type": "CALL",
  "updated": "2019-08-24T14:15:22Z",
  "updatedBy": "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/activities/{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/activities/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/activities/{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/activities/string/comment" \  -H "Content-Type: application/json" \  -d 'string'
{
  "attendees": [
    "string"
  ],
  "completedAt": "2019-08-24T14:15:22Z",
  "contactEmail": "string",
  "contactName": "string",
  "contactPhone": "string",
  "created": "2019-08-24T14:15:22Z",
  "createdBy": "string",
  "customer": {
    "email": "string",
    "id": "string",
    "name": "string",
    "phone": "string"
  },
  "customerId": "string",
  "description": "string",
  "dueDate": "2019-08-24T14:15:22Z",
  "durationMinutes": 0,
  "events": [
    {
      "authorId": "string",
      "date": "2019-08-24T14:15:22Z",
      "description": "string",
      "id": "string",
      "type": "CREATE"
    }
  ],
  "id": "string",
  "isCompleted": true,
  "location": "string",
  "opportunity": {
    "id": "string",
    "name": "string",
    "value": 0.1
  },
  "opportunityId": "string",
  "outcome": "string",
  "owner": {
    "displayName": "string",
    "id": "string",
    "username": "string"
  },
  "ownerId": "string",
  "priority": "LOW",
  "scheduledAt": "2019-08-24T14:15:22Z",
  "subject": "string",
  "tenantId": "string",
  "type": "CALL",
  "updated": "2019-08-24T14:15:22Z",
  "updatedBy": "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"
}

Complete an activity

POST
/crm/activities/{id}/complete

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/activities/string/complete" \  -H "Content-Type: application/json" \  -d '{}'
{
  "attendees": [
    "string"
  ],
  "completedAt": "2019-08-24T14:15:22Z",
  "contactEmail": "string",
  "contactName": "string",
  "contactPhone": "string",
  "created": "2019-08-24T14:15:22Z",
  "createdBy": "string",
  "customer": {
    "email": "string",
    "id": "string",
    "name": "string",
    "phone": "string"
  },
  "customerId": "string",
  "description": "string",
  "dueDate": "2019-08-24T14:15:22Z",
  "durationMinutes": 0,
  "events": [
    {
      "authorId": "string",
      "date": "2019-08-24T14:15:22Z",
      "description": "string",
      "id": "string",
      "type": "CREATE"
    }
  ],
  "id": "string",
  "isCompleted": true,
  "location": "string",
  "opportunity": {
    "id": "string",
    "name": "string",
    "value": 0.1
  },
  "opportunityId": "string",
  "outcome": "string",
  "owner": {
    "displayName": "string",
    "id": "string",
    "username": "string"
  },
  "ownerId": "string",
  "priority": "LOW",
  "scheduledAt": "2019-08-24T14:15:22Z",
  "subject": "string",
  "tenantId": "string",
  "type": "CALL",
  "updated": "2019-08-24T14:15:22Z",
  "updatedBy": "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"
}

Reopen an activity

POST
/crm/activities/{id}/reopen

Authorization

AuthorizationBearer <token>

In: header

Path Parameters

id*string

Response Body

application/json

application/json

application/json

application/json

curl -X POST "http://localhost:18080/api/v1/crm/activities/string/reopen"
{
  "attendees": [
    "string"
  ],
  "completedAt": "2019-08-24T14:15:22Z",
  "contactEmail": "string",
  "contactName": "string",
  "contactPhone": "string",
  "created": "2019-08-24T14:15:22Z",
  "createdBy": "string",
  "customer": {
    "email": "string",
    "id": "string",
    "name": "string",
    "phone": "string"
  },
  "customerId": "string",
  "description": "string",
  "dueDate": "2019-08-24T14:15:22Z",
  "durationMinutes": 0,
  "events": [
    {
      "authorId": "string",
      "date": "2019-08-24T14:15:22Z",
      "description": "string",
      "id": "string",
      "type": "CREATE"
    }
  ],
  "id": "string",
  "isCompleted": true,
  "location": "string",
  "opportunity": {
    "id": "string",
    "name": "string",
    "value": 0.1
  },
  "opportunityId": "string",
  "outcome": "string",
  "owner": {
    "displayName": "string",
    "id": "string",
    "username": "string"
  },
  "ownerId": "string",
  "priority": "LOW",
  "scheduledAt": "2019-08-24T14:15:22Z",
  "subject": "string",
  "tenantId": "string",
  "type": "CALL",
  "updated": "2019-08-24T14:15:22Z",
  "updatedBy": "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"
}

Reschedule an activity

POST
/crm/activities/{id}/reschedule

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/activities/string/reschedule" \  -H "Content-Type: application/json" \  -d '{    "scheduledAt": "2019-08-24T14:15:22Z"  }'
{
  "attendees": [
    "string"
  ],
  "completedAt": "2019-08-24T14:15:22Z",
  "contactEmail": "string",
  "contactName": "string",
  "contactPhone": "string",
  "created": "2019-08-24T14:15:22Z",
  "createdBy": "string",
  "customer": {
    "email": "string",
    "id": "string",
    "name": "string",
    "phone": "string"
  },
  "customerId": "string",
  "description": "string",
  "dueDate": "2019-08-24T14:15:22Z",
  "durationMinutes": 0,
  "events": [
    {
      "authorId": "string",
      "date": "2019-08-24T14:15:22Z",
      "description": "string",
      "id": "string",
      "type": "CREATE"
    }
  ],
  "id": "string",
  "isCompleted": true,
  "location": "string",
  "opportunity": {
    "id": "string",
    "name": "string",
    "value": 0.1
  },
  "opportunityId": "string",
  "outcome": "string",
  "owner": {
    "displayName": "string",
    "id": "string",
    "username": "string"
  },
  "ownerId": "string",
  "priority": "LOW",
  "scheduledAt": "2019-08-24T14:15:22Z",
  "subject": "string",
  "tenantId": "string",
  "type": "CALL",
  "updated": "2019-08-24T14:15:22Z",
  "updatedBy": "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"
}

Contact Form Widget Config

Previous Page

C R M Customer

Next Page