Version: v1
API V1
DSPTCH API public endpoints.
PATCH semantics
Unless an endpoint says otherwise, PATCH requests use merge-style update semantics:
- Omitted fields are left unchanged.
- Included scalar fields replace existing values.
- Included array fields replace the entire existing array.
- To clear an array, send an explicit empty array (
[]). - To clear a nullable scalar field, send
nullwhen that field supports null values.
This means clients can safely send partial updates without unintentionally overwriting unrelated fields.
Examples
Preserve manager assignments and timecodes while updating only a name:
{ "name": "Updated Job Name" }
Replace all managers on a job:
{ "manager_user_ids": ["user_123", "user_456"] }
Clear all managers on a job:
{ "manager_user_ids": [] }
Authentication
- API Key: api_key
Security Scheme Type: | apiKey |
|---|---|
Header parameter name: | X-Api-Key |