Data & Documents
The REST API includes functions to retrieve, create and update cases, record contacts and process documents. Depending on the function, structured data is transferred as JSON or documents are sent through upload interfaces.
Typical API calls in your service process
- Create customer cases: POST /concerns creates a case in a new or existing file.
- Retrieve and update cases: GET /concerns/{id} retrieves case information. PATCH /concerns/{id} updates supported details such as status, labels or dynamic fields.
- Record contacts: POST /contacts records an incoming or outgoing contact for a customer case. Documents can be linked to the contact.
- Import documents: POST /upload uploads documents. POST /documents/{id}/indexing assigns them to a file or case. It can also create a new case.
Selected calls relative to the API base path /tfapi. Available functions and fields depend on the API version and access permissions.