API Reference - Case Updates

Case Updates are the primary way that customers and staff members communicate.  Case updates must be connected to cases.

Listing Case Updates

Returns a collection of case update records, optionally filtered by the available request parameters.

GET /api/v1/case/updates

 

Available Request Parameters:

Name Type Required Description
id integer no ID of the update.
case integer no ID of the case the update belongs to.
access_group integer no ID of the access_group the update belongs to.
created_by integer no ID of the contact or staff member who created the update.
is_valid boolean no If yes, filter valid updates.  If no, filter invalid updates.
subject integer no ID of the case subject this update is associated with.
thread integer no ID of the thread (includes update and replies) this update belongs to.
activity_from timestamp no Activity on or after the date (Alias From).
activity_to timestamp no Activity on or before the date (Alias To).
created_from timestamp no Created on or after the date.
created_to timestamp no Created on or before the date.
updated_from timestamp no Updated on or after the date.
updated_to timestamp no Updated on or before the date.
validated_from timestamp no Validated on or after the date.
validated_to timestamp no Validated on or before the date.

Note: All timestamp parameters are queried and returned in UTC. 

Getting a Case Update

Returns a single case update record, based on the numeric ID.

GET /api/v1/case/updates/{case_update_id}

Was this article helpful?
0 out of 0 found this helpful
Have more questions? Submit a request