API documentation

GET /api/v1/agent_messages
List Agent Message records.

Params

Param name	Description Validations
ids Optional	Return records matching these ids. Validations: Must be an array of decimal values. EG: `[0, 1, 2, 3]`
page Optional	Return the next page of results. Validations: Must be a number.
per_page Optional	How many results to return per page. The default is 25. Validations: Must be a number.
created_at_to Optional	Date formatted like 2016-01-01 12:25:15 -0500 Validations: Must be a String
created_at_from Optional	Date formatted like 2016-01-01 12:25:15 -0500 Validations: Must be a String
fulltext Optional	Search for any record that matches this text Validations: Must be a String
time_zone Optional	Date ranges will be parsed using this time zone. Validations: Must be a valid time zone. See the list of valid time zones.
columns Optional	Specify the columns you would like returned by the API for a given resource. Limiting the columns can significantly increase API response time since only the requested data will be processed. columns=uuid,number,created_at Must be any combination of: id legacy_id type uuid created_at updated_at deleted_at user_updated_at routes_show_path routes_edit_path external_record_id company_id content agent_status_id user_id agent_widget_count Validations: Must be a String
root Optional	Pass `root=false` to return results without a root node and metadata. For example: `GET /api/v1/calls?root=false` will return `[call1, call2, call3]` While: `GET /api/v1/calls` will return `{calls: [call1, call2, call3], metadata: {}}` Validations: Must be a boolean value: 1, true, yes, on, 0, false, no, off

GET /api/v1/agent_messages/new
Build Agent Message with defaults.

Params

Param name	Description Validations
content Optional Blank Value Allowed	Content Validations: Must be a String
agent_status_id Optional Blank Value Allowed	Agent Status Validations: Must be a valid foreign key reference to an Agent Status. Refer to: /api/docs/1.0/agent_statuses

POST /api/v1/agent_messages
Create Agent Message.

Params

Param name	Description Validations
content Required	Content Validations: Must be a String
agent_status_id Optional Blank Value Allowed	Agent Status Validations: Must be a valid foreign key reference to an Agent Status. Refer to: /api/docs/1.0/agent_statuses
buyer_ids Optional Blank Value Allowed	Agents Validations: Must be a valid array of integers. Each integer ID must be a valid foreign key reference to an Buyer. Refer to: /api/docs/1.0/buyers
buyer_group_ids Optional Blank Value Allowed	Buyer Groups Validations: Must be a valid array of integers. Each integer ID must be a valid foreign key reference to an Buyer Group. Refer to: /api/docs/1.0/buyer_groups
call_center_ids Optional Blank Value Allowed	Call Centers Validations: Must be a valid array of integers. Each integer ID must be a valid foreign key reference to an Call Center. Refer to: /api/docs/1.0/call_centers

GET /api/v1/agent_messages/:id
Get Agent Message by id.

PUT /api/v1/agent_messages/:id
Update Agent Message by id.

Params

Param name	Description Validations
agent_status_id Optional Blank Value Allowed	Agent Status Validations: Must be a valid foreign key reference to an Agent Status. Refer to: /api/docs/1.0/agent_statuses
buyer_ids Optional Blank Value Allowed	Agents Validations: Must be a valid array of integers. Each integer ID must be a valid foreign key reference to an Buyer. Refer to: /api/docs/1.0/buyers
buyer_group_ids Optional Blank Value Allowed	Buyer Groups Validations: Must be a valid array of integers. Each integer ID must be a valid foreign key reference to an Buyer Group. Refer to: /api/docs/1.0/buyer_groups
call_center_ids Optional Blank Value Allowed	Call Centers Validations: Must be a valid array of integers. Each integer ID must be a valid foreign key reference to an Call Center. Refer to: /api/docs/1.0/call_centers

DELETE /api/v1/agent_messages/:id
Destroy Agent Message by id.