Import households

Each row becomes a person with the pantry_client role, with their dogs, cats and other pets counted from today and their proof of need. Send dry_run true to see what it would do first; the same checks run either way. The whole file is checked before anything is written, and a row whose email is already here is skipped. At most 2,000 rows. A pantry that keeps no names answers 404. While the pantry is switched off it answers 404 saying so. Needs write on People.

POST

https://{organization}.rescueconsole.com

api

people

pantry

households

import

Import households

curl --request POST \
  --url https://{organization}.rescueconsole.com/api/people/pantry/households/import \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "rows": [
    {
      "first_name": "Rosa",
      "last_name": "Delgado",
      "phone": "5550191",
      "dogs": "2",
      "proof_until": "2027-03-31"
    }
  ],
  "dry_run": true
}
'

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    rows: [
      {
        first_name: 'Rosa',
        last_name: 'Delgado',
        phone: '5550191',
        dogs: '2',
        proof_until: '2027-03-31'
      }
    ],
    dry_run: true
  })
};

fetch('https://{organization}.rescueconsole.com/api/people/pantry/households/import', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://{organization}.rescueconsole.com/api/people/pantry/households/import"

payload = {
    "rows": [
        {
            "first_name": "Rosa",
            "last_name": "Delgado",
            "phone": "5550191",
            "dogs": "2",
            "proof_until": "2027-03-31"
        }
    ],
    "dry_run": True
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

{
  "dry_run": true,
  "total_rows": 123,
  "would_create": 123,
  "created": 123,
  "skipped": [
    {
      "line": 123,
      "email": "<string>",
      "reason": "<string>"
    }
  ],
  "errors": [
    {
      "line": 123,
      "message": "<string>"
    }
  ],
  "preview": [
    {}
  ]
}

{
  "dry_run": true,
  "total_rows": 123,
  "would_create": 123,
  "created": 123,
  "skipped": [
    {
      "line": 123,
      "email": "<string>",
      "reason": "<string>"
    }
  ],
  "errors": [
    {
      "line": 123,
      "message": "<string>"
    }
  ],
  "preview": [
    {}
  ]
}

{
  "error": "house_trained must be 1, 0 or null (not assessed)"
}

{
  "error": "house_trained must be 1, 0 or null (not assessed)"
}

{
  "error": "house_trained must be 1, 0 or null (not assessed)"
}

Authorizations

Authorization

string

header

required

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

Body

application/json

rows

object[]

required

Show child attributes

dry_run

boolean

Response

What it did, or would do.

dry_run

boolean

required

total_rows

integer

required

would_create

integer

required

created

integer

required

skipped

object[]

required

Show child attributes

errors

object[]

required

Show child attributes

preview

object[]

required

The first ten households it would create.

Import households

curl --request POST \
  --url https://{organization}.rescueconsole.com/api/people/pantry/households/import \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "rows": [
    {
      "first_name": "Rosa",
      "last_name": "Delgado",
      "phone": "5550191",
      "dogs": "2",
      "proof_until": "2027-03-31"
    }
  ],
  "dry_run": true
}
'

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    rows: [
      {
        first_name: 'Rosa',
        last_name: 'Delgado',
        phone: '5550191',
        dogs: '2',
        proof_until: '2027-03-31'
      }
    ],
    dry_run: true
  })
};

fetch('https://{organization}.rescueconsole.com/api/people/pantry/households/import', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://{organization}.rescueconsole.com/api/people/pantry/households/import"

payload = {
    "rows": [
        {
            "first_name": "Rosa",
            "last_name": "Delgado",
            "phone": "5550191",
            "dogs": "2",
            "proof_until": "2027-03-31"
        }
    ],
    "dry_run": True
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

{
  "dry_run": true,
  "total_rows": 123,
  "would_create": 123,
  "created": 123,
  "skipped": [
    {
      "line": 123,
      "email": "<string>",
      "reason": "<string>"
    }
  ],
  "errors": [
    {
      "line": 123,
      "message": "<string>"
    }
  ],
  "preview": [
    {}
  ]
}

{
  "dry_run": true,
  "total_rows": 123,
  "would_create": 123,
  "created": 123,
  "skipped": [
    {
      "line": 123,
      "email": "<string>",
      "reason": "<string>"
    }
  ],
  "errors": [
    {
      "line": 123,
      "message": "<string>"
    }
  ],
  "preview": [
    {}
  ]
}

{
  "error": "house_trained must be 1, 0 or null (not assessed)"
}

{
  "error": "house_trained must be 1, 0 or null (not assessed)"
}

{
  "error": "house_trained must be 1, 0 or null (not assessed)"
}

Using the API

Endpoints

Import households

Authorizations

Body

Response