What you’ll have
By the end of this guide:- A case created from one of your templates, owned by a member of your client’s team
- Its contact set to the customer the case is about
- Structured data written into it
- A document uploaded and stored on one of its fields
Finish Onboard a Client first. You need the workspace id and
the token it returned.
1
Find the case template
The templates you listed in Cache the ids per workspace — they are stable, and you need one every time you open a case.
template_source were copied into the workspace. Read their ids
with List Case Templates:2
Create the case
Instantiate the template with Create Case:
workspace.id is required for an API token — it is never inferred. The case inherits the
template’s fields and statuses.3
Push data into the case
Write any field of the case’s schema with
Update Case Data:Penbox keeps the full history of every field: send a new value and the previous one stays
retrievable — you never have to version data on your side. Field types and on-the-fly schema
additions are covered in the Data Schema reference.
4
Attach a document
Upload the file with
Upload Attachment — multipart or base64, up to
10GB:The response carries the attachment’s Always send the complete reference. This value is not validated, so a bare id can be saved
successfully and then fail to display or download. A field configured for several files takes an
array of references.Uploading alone does not put the file on the case — the second call is what does. Like any
other field, a file field keeps the full history of everything ever added to it.Limits, access rules and the reading path are covered in
Add a Document to a Case.
id, name and type. Store them in one of the case’s
file fields as a reference object — not as a bare id:You’ve created a case
The workspace now holds a real case:- Built from your template, with its fields and its statuses
- Owned by a member of your client’s team
- Pointing at the customer it is about
- Carrying structured data and a document, both with full history