Skip to main content
POST
Plan a field visit

Authorizations

Authorization
string
header
required

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

Body

application/json
kind
enum<string>
required
Available options:
stray_pickup,
welfare_check,
colony,
pantry_delivery,
owner_support,
other
visit_on
string<date>
required
address
string | null
Maximum string length: 300
summary
string | null
Maximum string length: 200
notes
string | null
Maximum string length: 2000
assigned_person_id
string | null
person_id
string | null
animal_id
string | null
colony_id
string | null
status
enum<string>
Available options:
planned,
done,
cancelled
outcome
enum<string> | null
Available options:
brought_in,
returned_to_owner,
left_in_place,
referred,
no_contact,
resolved,
other,
null
cats_trapped
integer | null
Required range: 0 <= x <= 500
cats_returned
integer | null
Required range: 0 <= x <= 500
photo_file_ids
string[]

Your files, uploaded to /api/files first.

Maximum array length: 10

Response

The visit.

visit
object
required