Segments

Segments are the customer groups, that can be defined and created in CRM CareCloud according to many different criteria. Customers in the Segment share some specific common information or property and can be managed via this resource.

Available methods

All available methods for resource Segment.

HTTP method Endpoint Description
[badge-blue GET] /segments Get information about all segments
[badge-blue GET] /segments/{segment_id} Get information about a segment

Available methods with sub-resources

All available methods for sub-resources of resource segments.

HTTP method Endpoint Description
[badge-blue GET] / segments/{segment_id}/segment-records Get all cutomers in a segment

Actions

Action methods for resource segments.

HTTP method Endpoint Description
[badge-green POST] /segments/{segment_id}/actions/add-customer Add a customer to a segment
[badge-green POST] /segments/{segment_id}/actions/remove-customer Remove a customer from a segment


Get all segments

Get information about segments as a list of all segments
[badge-blue GET] /segments

Query string

Parameter name Type Description Mandatory (Yes/No)
count integer The number of records to return.
Default value is 100.		 No
offset integer The number of records from a collection to skip.
Default value is 0.		 No
sort_field string One of the query string parameters for sorting.
Response is sorted by the specified field.		 No
sort_direction string Direction of sorting the response list.
Possible values are: ASC / DESC		 No

Response

Status code: 200 OK
Output structure : object

Parameter name Type Description
segments Segment[] List of all segments
total_items integer Count of all found segments

Example Request

GET https://<projectURL>/rest-api/enterprise-interface/v1.0/segments?count=2
Content-Type: application/json
Accept-Language: cs, en-gb;q=0.8
Authorization: Basic ZW50ZXJwcmlzZV9pbnRlcmZhY2U6NDU3NDJhMDAxNmEyZjc1NDI3YWUwMTM0NmMyOWQxNmE4NzI1MWZlzZmMzcwNmI2MDJmDfN2Q2Mw==

Example response

HTTP/1.1 200 OK
Date: Tue, 20 Oct 2020 14:36:44 GMT
Content-Type: application/json; charset=utf-8

{
  "data": {
    "segments": [
      {
        "segment_id": "8dc1e66b44796af5cd377910e1",
        "name": "readers",
        "note": "Customers that like to read more than 1 book a month",
        "last_change": "2019-03-04 10:01:12"
      },
      {
        "segment_id": "80ce27674699b5997fdfffe72c",
        "name": "beer_lovers",
        "note": "This segment cointain all beer lovers",
        "last_change": "2019-08-29 13:04:45"
      }
    ],
    "total_items": 4
  }
}


Get a segment

Get information about a specific segment
[badge-blue GET] /segments/{segment_id}

Path parameters

Parameter name Type Description
segment_id string The unique id for the segment

Response

Status code: 200 OK
Output structure : Segment

Example Request

GET https://<projectURL>/rest-api/enterprise-interface/v1.0/segments/8dc1e66b44796af5cd377910e1
Content-Type: application/json
Accept-Language: cs, en-gb;q=0.8
Authorization: Basic ZW50ZXJwcmlzZV9pbnRlcmZhY2U6NDU3NJhMDAxNmEyZjc1NDI3YWUwMTM0NmMyOWQxNmE4NzI1MWZlzZmMzcwNmI2MDJmDfN2Q2Mw==

Example response

HTTP/1.1 200 OK
Date: Tue, 20 Oct 2020 14:37:14 GMT
Content-Type: application/json; charset=utf-8

{
  "data": {
    "segment_id": "8dc1e66b44796af5cd377910e1",
    "name": "readers",
    "note": "Customers that like to read more than 1 book a month",
    "last_change": "2019-03-04 10:01:12"
  }
}


Add customer to a segment

Action method that adds customer to specified segment.
[badge-green POST] /segments/{segment_id}/actions/add-customer

Path parameters

Parameter name Type Description Mandatory (Yes/No)
segment_id string The unique id for the segment Yes

Request

Parameter name Type Description Mandatory (Yes/No)
customer_id string The unique id for the customer Yes

Response

Status code: 204 No Content

Example Request

POST https://<projectURL>/rest-api/enterprise-interface/v1.0/segments/8dc1e66b4476af5cd377910e1/actions/add-customer
Content-Type: application/json
Accept-Language: cs, en-gb;q=0.8
Authorization: Basic ZW50ZXJwcmlzZV9pbnRlcmZhY2U6NDU3NDJhMDAxNmEyZjcNDI3YWUwMTM0NmMyOWQxNmE4NzI1MWZlzZmMzcwNmI2MDJmDfN2Q2Mw==

{
  "customer_id" : "83a176d32c72ed608d1430dc7"
}

Example response

HTTP/1.1 204 No Content
Date: Tue, 20 Oct 2020 14:39:07 GMT
Content-Type: application/json; charset=utf-8


Remove customer from a segment

[badge-green POST] /segments/{segment_id}/actions/remove-customer
Action method that removes customer from a specified segment.

Path parameters

Parameter name Type Description Mandatory (Yes/No)
segment_id string The unique id for the segment Yes

Request

Parameter name Type Description Mandatory (Yes/No)
customer_id string The unique id for the customer Yes

Response

Status code: 204 No Content

Example Request

POST https://<projectURL>/rest-api/enterprise-interface/v1.0/segments/8dc1e66b4476af5cd377910e1/actions/remove-customer
Content-Type: application/json
Accept-Language: cs, en-gb;q=0.8
Authorization: Basic ZW50ZXJwcmlzZV9pbnRlcmZhY2U6NDU3NDJhMDAxNmEyZjc1NDIYWUwMTM0NmMyOWQxNmE4NzI1MWZlzZmMzcwNmI2MDJmDfN2Q2Mw==

{
  "customer_id" : "83a176d3272bed608d1430dc7"
}

Example response

HTTP/1.1 204 No Content
Date: Tue, 20 Oct 2020 14:40:00 GMT
Content-Type: application/json; charset=utf-8