Skip to main content
POST
Open a field case

Authorizations

Authorization
string
header
required

An API key from Settings, API keys. It starts with rc_live_.

Body

application/json
title
string
required

What was reported, in a line.

Maximum string length: 200
type_id
string | null

One of your case types, switched on.

priority
enum<integer> | null

1 Emergency, 2 Urgent, 3 Routine, 4 Low.

Available options:
1,
2,
3,
4,
null
description
string | null
Maximum string length: 4000
address
object

The structured address: country (ISO 3166-1 alpha-2), line1, line2, city, administrative_area, postal_code.

location_notes
string | null

What helps an officer find it.

Maximum string length: 300
jurisdiction_id
string | null

Left out on a new case, it is the one the address names, else your default.

zone_id
string | null
reported_at
string<date-time>

Now when left out. Not in the future.

due_on
string<date> | null
reported_anonymously
boolean

A case reported anonymously keeps no reporter.

assigned_person_id
string | null

An officer on the field team. A new case is open from the moment it has one, and the officer is told.

people
object[]
Maximum array length: 20
animal_ids
string[]
Maximum array length: 20

Response

The new case.

case
object