Update a Pet (JSON)

1 min

PATCH

https://developer.digitail.io/api/v1/pets/{id}

Permissions needed: UPDATE_PATIENTS Update Pet by ID, empty values will overwrite, omit key to leave unchanged. For text-only updates (no photo). To upload a new avatar, use the multipart/form-data operation on this same path instead, since file uploads are not delivered on a native PATCH request body.

Body Parameters

bodyobjectrequired
- nicknamestring
  Example
  Fluffy
  Description
  Nickname
- birthdaystring
  Example
  2017-11-28
  Description
  Birthday (Y-m-d)
- species_idinteger
  Example
  1
  Description
  Species Id.
- breed_idinteger
  Example
  1
  Description
  Breed ID.
- crossbreedboolean
  Description
  Set to true if crossbreed. Do not send empty value, omit the key completely
- crossbreed_detailsstring
  Description
  Crossbreed id (see breeds endpoint) Do not send empty value, omit the key completely
- colorstring
  Example
  Pink
  Description
  Color
- color_maskinteger[]
  Description
  Color mask
- distinctive_marksstring
  Example
  One spot on right ear
  Description
  Distinctive marks
- genderstring<male | female | unknown>
  Description
  Gender
  Allowed
  malefemaleunknown
- observationsstring
  Description
  Observations (Pet notes)
- chip_numberstring
  Example
  123456789
  Description
  Chip number
- microchip_locationstring
  Example
  Neck
  Description
  Microchip Location
- insurance_numberstring
  Example
  123456789
  Description
  Insurance Number
- insurance_providerstring
  Example
  Petplan
  Description
  Insurance Provider
- policy_idstring
  Example
  POLICY-123
  Description
  Policy ID
- passportstring
  Example
  123456789
  Description
  Passport
- descriptionstring
  Description
  Description
- constitutionstring
  Description
  Constitution
- conformationstring
  Description
  Conformation
- allergiesstring
  Description
  Allergies
- blood_type_idinteger
  Description
  Blood Type Id (see blood-types endpoint) Do not send empty value, omit the key completely
- hormonal_statusinteger
  Description
  Hormonal Status (0=neutered,1=normal,2=unknown)
  Allowed
  012

Responses

200successful operation

object
- datadata

curl

curl --request PATCH \
     --url https://developer.digitail.io/api/v1/pets/{id} \
     --header 'accept: application/json'

javascript

var myHeaders = new Headers();
myHeaders.append("accept", "application/json");
myHeaders.append("content-type", "application/json");

var requestOptions = {
   method: 'PATCH',
   headers: myHeaders,
   redirect: 'follow'
};

fetch("https://developer.digitail.io/api/v1/pets/{id}", requestOptions)
   .then(response => response.text())
   .then(result => console.log(result))
   .catch(error => console.log('error', error));

ruby

require "uri"
require "json"
require "net/http"

url = URI("https://developer.digitail.io/api/v1/pets/{id}")

https = Net::HTTP.new(url.host, url.port)
https.use_ssl = true

request = Net::HTTP::Patch.new(url)
request["accept"] = "application/json"
request["content-type"] = "application/json"

response = https.request(request)
puts response.read_body

python

import requests
import json

url = "https://developer.digitail.io/api/v1/pets/{id}"

payload = {}
headers = {
   'accept': 'application/json',
   'content-type': 'application/json'
}

response = requests.request("PATCH", url, headers=headers, data=payload)

print(response.text)

200

// successful operation
{
  "data": {}
}