Skip to main content

Customer Exchange

List of customer exchanges, feedback

HTTP Request

[GET] /api/v6/accounts/{id}/comments

Query Parameters

Fields

FieldsTypeDescription
idintegerIdentifier
comment_titlestringComment title
contentstringComment content
creatorintegerCreator identifier
creator_display_namestringCreator name
account_idintegerCustomer identifier
account_namestringCustomer name
account_avatarstringCustomer avatar
is_feedbackintegerDetermine if it's an exchange or feedback (0: exchange, 1: feedback)
created_atstringExchange date in (Y-m-d H:i:s) format

Filtering

FieldsSupportTypeDescription
ideqintegerComment identifier
is_feedbackeqintegerExchange or feedback

Sort

| Sort (field) | Direction |
|:-------------|-----------|
| id | asc,desc |\

Limit & Offset

| | Type | Description |
|:-------|---------|--------------------------|
| Limit | integer | Number of records to retrieve |
| Offset | integer | Number of records to skip |\

Example

HTTP Request

GET api/v6/accounts/1/comments?fields=content&filtering[is_feedback]=0&limit=1&offset=1 HTTP/1.1
Host: example.getflycrm.com
Authorization: API TOKEN

Status

200 OK

Response

{
"data": [
{
"id": 4,
"content": "TEST ACCOUNT COMMENT API"
}
],
"has_more": false,
"offset": 0,
"limited": 1
}

Customer Exchange

HTTP Request

[POST] /api/v6/accounts/{id}/comments

Body Parameters

ParameterTypeNullableRequireDescription
contentstringyesExchange content
user_idintegeryesUser identifier

Example

HTTP Request

POST api/v6/accounts/{id}/comments HTTP/1.1
Host: example.getflycrm.com
Content-Type: application/json
{
"content": "TEST",
"user_id": 1
}

Status

200 OK

Response

{
"message": "Successfully added",
"id": 4
}