Adding Pets via API

You can add new pet profiles to your PawPlacer account using the API.

Note: This feature is in beta and may be subject to changes. DO NOT use this feature in production environments until it is officially released. Please contact us with any feedback or issues.

Endpoint

POST /api/pets

Authentication

All API requests require an API key, which can be retrieved from your account settings. Include the API key in the request headers as follows:

"x-api-key": process.env.PAWPLACER_API_KEY

Request Body

Required Fields

The request will fail if any of these fields are missing or do not meet the specified types. The error message will indicate which field is causing the issue.

Optional Fields

Types

Required

Optional (fixed values)

The values for these fields are fixed and cannot be modified. If you provide a value that does not match the list, the request will fail.

Optional (dynamic values)

You may upload any values for these fields, but we strongly recommend using the values provided below for consistency, better search results, and compatibility with PetFinder's API.

Breed

Examples

Request (Basic)

{
  "name": "Buddy",
  "species": "dog",
  "age_category": "young",
  "sex": "male",
  "size": "medium",
  "status": "available",
  "health": "good"
}

Request (Full)

{
  "name": "Luna",
  "species": "cat",
  "age_category": "young",
  "sex": "female", 
  "size": "medium",
  "status": "available",
  "health": "great",
  "breed": ["Persian", "Egyptian Mau"],
  "color": ["Smoke", "Tortoiseshell"],
  "age_years": "2",
  "age_months": "3",
  "description": "Luna is a gentle, affectionate Persian mix who loves to cuddle.",
  "spayed": true,
  "adoption_fee": "150",
  "microchip_id": "985141004534221",
  "good_with": ["cats", "seniors", "smallApartments", "sedentaryLifestyle"],
  "bad_with": ["dogs", "kids"],
  "temperaments": ["affectionate", "gentle", "quiet", "social"],
  "image_urls": [
    "https://mysite.com/pets/luna-1.webp",
    "https://mysite.com/pets/luna-2.webp"
  ]
}

Code

async function addPet() {
  try {
    const response = await fetch("https://pawplacer.com/api/pets", {
      method: "POST",
      headers: {
        "x-api-key": process.env.PAWPLACER_API_KEY,
        "Content-Type": "application/json"
      },
      body: JSON.stringify({
        name: "Buddy",
        species: "dog",
        age_category: "young",
        sex: "male",
        size: "medium",
        status: "available",
        health: "good"
      })
    });

    if (!response.ok) {
      throw new Error('Failed to add pet');
    }

    const result = await response.json();
    console.log('Pet added successfully:', result);
  } catch (error) {
    console.error('Error:', error);
  }
}

Error Handling

Best Practices

• Upload images in .webp format for better performance. If you upload images via the PawPlacer website, they will be automatically converted to .webp.
• Keep API keys secure and do not expose them publicly.
• Handle errors gracefully to ensure smooth application operation.