Skip to main content
POST
Import animals

Authorizations

Authorization
string
header
required

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

Body

application/json
rows
object[]
required
Required array length: 1 - 2000 elements
dry_run
boolean
default:false

Check every row and say what would happen, writing nothing.

Response

What was done, or on a dry run what would be. A dry run with errors answers 200 too, listing them.

dry_run
boolean
total_rows
integer
would_create
integer

How many rows are new animals.

created
integer

How many were created: 0 on a dry run or when any row is wrong.

skipped
object[]

Rows whose Pet ID is already in use.

errors
object[]

What is wrong, by row. Nothing is written while this is not empty.

preview
object[]

The first 10 animals to be created.

import_id
string
fetches
object

How many photo and attachment links will be fetched.