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}

 

Creating a Case Update

Creates a new case update record for a given case.

POST /api/v1/case/updates

Available Parameters

Name Type Required Description
casefile_id integer yes ID of the case. API Reference - Cases
subject_id integer no ID of the subject. API Reference - Subjects
event_id integer no ID of the event/task. API Reference - Events
access_group_id integer yes ID of the access groups. See Access Groups
activity_at date no The date and time in ISO format (YYYY-MM-DD).  Time can also be appended in ISO format (YYYY-MM-DD HH:MM:SS).
is_allday boolean no True if "activity_at" does not contain time.
title string yes The title or subject line of the update.
body string yes

The body or message of the update. 

Note: Basic HTML string formatting (e.g. bold, italic), as well as HTML lists are supported in this field.

Example New Case Update 

A new case update is created by POSTing a JSON object to the specified end point using the above criteria.  The JSON object must contain the required fields (as shown above) and must be nested under the update object.  See the following example request:

{
"update": {
"access_group_id": 1,
"casefile_id": 123,
"subject_id": 456,
"title": "This is a test from the API",
"body": "This is the body or message of the update.",
"activity_at": "2021-06-03",
"is_allday": true
}
}

Note: The above request is for demonstration purposes only, your implementation will require unique data provided by your account.

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