--- title: Create a Pet slug: create-a-pet docTags: createdAt: 2026-04-21T15:22:49.957Z --- { "id": "wK4iei13wOiZO68R3B5q1", "type": "api-oas-v2", "data": { "method": "POST", "url": "https://developer.digitail.io/api/v1/pets", "servers": [ { "url": "https://developer.digitail.io/api/v1/pets", "description": "Sandbox server (uses test data)" }, { "url": "https://vet.digitail.io/api/v1/pets", "description": "Production server (uses live data)" } ], "name": "Create a Pet", "description": "

Permissions needed: CREATE_PATIENTS\nCreate a pet

", "contentType": "multipart/form-data", "request": { "pathParameters": [], "headerParameters": [ { "name": "accept", "type": "string", "kind": "optional", "description": "Generated from available response content types", "enum": [ "application/json" ], "default": "application/json" } ], "queryParameters": [], "bodyDataParameters": [], "formDataParameters": [ { "name": "clinic_id", "kind": "required", "type": "integer", "description": "Clinic id.", "example": 1 }, { "name": "vet_id", "kind": "required", "type": "integer", "description": "Vet id.", "example": 1 }, { "name": "owner_id", "kind": "required", "type": "integer", "description": "Owner Id.", "example": 1 }, { "name": "nickname", "kind": "required", "type": "string", "description": "Nickname", "example": "Fluffy" }, { "name": "birthday", "kind": "required", "type": "string", "description": "

Birthday (Y-m-d)

", "example": "2017-11-28" }, { "name": "avatar", "kind": "optional", "type": "string", "description": "Profile picture.", "example": "avatar.jpg", "format": "binary" }, { "name": "species_id", "kind": "required", "type": "integer", "nullable": true, "description": "Species Id.", "example": 1 }, { "name": "breed_id", "kind": "required", "type": "integer", "description": "Breed ID.", "example": 1 }, { "name": "crossbreed", "kind": "optional", "type": "boolean", "description": "

Set to true if crossbreed. Do not send empty value, omit the key completely

" }, { "name": "crossbreed_details", "kind": "optional", "type": "string", "description": "

Crossbreed id (see breeds endpoint) Do not send empty value, omit the key completely

" }, { "name": "color", "kind": "optional", "type": "string", "description": "Color", "example": "Pink" }, { "name": "color_mask", "kind": "optional", "type": "array", "nullable": true, "description": "Color mask", "example": "", "itemType": "integer", "customType": "integer[]", "itemExample": 1, "itemDefault": "" }, { "name": "distinctive_marks", "kind": "optional", "type": "string", "description": "Distinctive marks", "example": "One spot on right ear" }, { "name": "gender", "kind": "required", "type": "string", "description": "Gender", "enum": [ "male", "female", "unknown" ] }, { "name": "observations", "kind": "optional", "type": "string", "nullable": true, "description": "

Observations (Pet notes)

" }, { "name": "chip_number", "kind": "optional", "type": "string", "nullable": true, "description": "Chip number", "example": "123456789" }, { "name": "microchip_location", "kind": "optional", "type": "string", "nullable": true, "description": "Microchip Location", "example": "Neck" }, { "name": "insurance_number", "kind": "optional", "type": "string", "nullable": true, "description": "Insurance Number", "example": "123456789" }, { "name": "insurance_provider", "kind": "optional", "type": "string", "nullable": true, "description": "Insurance Provider", "example": "Petplan" }, { "name": "policy_id", "kind": "optional", "type": "string", "nullable": true, "description": "Policy ID", "example": "POLICY-123" }, { "name": "passport", "kind": "optional", "type": "string", "nullable": true, "description": "Passport", "example": "123456789" }, { "name": "description", "kind": "optional", "type": "string", "nullable": true, "description": "Description" }, { "name": "constitution", "kind": "optional", "type": "string", "description": "Constitution" }, { "name": "conformation", "kind": "optional", "type": "string", "description": "Conformation" }, { "name": "allergies", "kind": "optional", "type": "string", "description": "Allergies" }, { "name": "blood_type_id", "kind": "optional", "type": "integer", "description": "

Blood Type Id (see blood-types endpoint) Do not send empty value, omit the key completely

" }, { "name": "hormonal_status", "kind": "required", "type": "integer", "description": "

Hormonal Status (0=neutered,1=normal,2=unknown)

", "enum": [ "0", "1", "2" ] } ], "oAuthParameters": [ { "id": "passport", "name": "passport", "kind": "optional", "type": "oauth2", "description": "Laravel passport oauth2 security.", "oauth2Flows": { "authorizationCode": { "authorizationUrl": "https://digitail.test/oauth/authorize", "tokenUrl": "https://digitail.test/oauth/token", "refreshUrl": "https://digitail.test/oauth/token" } } }, { "id": "Bearer", "name": "Bearer", "kind": "optional", "type": "http", "scheme": "bearer" } ], "cookieParameters": [] }, "responses": [ { "statusCode": "201", "description": "Successful operation", "jsonExample": "", "isExpanded": true, "schema": [ { "kind": "optional", "type": "object", "description": "", "schema": [ { "name": "data", "kind": "optional", "type": "object", "description": "

A pet is an individual entity unique in all of Figitail. A pet can have a single PetParent, multiple contact persons and can be present on multiple clinics. The linkage between a pet and a clinics is called a patient.

", "example": "", "schema": [ { "name": "id", "kind": "optional", "type": "integer", "description": "", "example": 1 }, { "name": "nickname", "kind": "optional", "type": "string", "description": "", "example": "Fritz" }, { "name": "species_id", "kind": "optional", "type": "string", "description": "", "example": "1" }, { "name": "breed_id", "kind": "optional", "type": "string", "description": "", "example": "1" }, { "name": "trupanion_species", "kind": "optional", "type": "object", "nullable": true, "description": "

Trupanion species mapping. Present when include=trupanionSpecies is used.

", "example": "", "schema": [ { "name": "id", "kind": "optional", "type": "integer", "description": "", "example": 1 }, { "name": "external_id", "kind": "optional", "type": "integer", "description": "", "example": 1 }, { "name": "name", "kind": "optional", "type": "string", "description": "", "example": "Dog" } ] }, { "name": "trupanion_breed", "kind": "optional", "type": "object", "nullable": true, "description": "

Trupanion breed mapping. Present when include=trupanionBreed is used.

", "example": "", "schema": [ { "name": "id", "kind": "optional", "type": "integer", "description": "", "example": 1 }, { "name": "external_id", "kind": "optional", "type": "integer", "description": "", "example": 101 }, { "name": "name", "kind": "optional", "type": "string", "description": "", "example": "Golden Retriever" } ] }, { "name": "observations", "kind": "optional", "type": "string", "nullable": true, "description": "", "example": "" }, { "name": "gender", "kind": "optional", "type": "string", "description": "", "example": "male", "enum": [ "male", "female", "unknown" ] }, { "name": "microchip", "kind": "optional", "type": "string", "nullable": true, "description": "", "example": "" }, { "name": "crossbreed", "kind": "optional", "type": "string<0 | 1>", "description": "", "example": "0", "enum": [ "0", "1" ] }, { "name": "crossbreed_details_id", "kind": "optional", "type": "integer", "nullable": true, "description": "", "example": "" }, { "name": "crossbreed_details", "kind": "optional", "type": "object", "description": "", "example": "", "schema": [ { "name": "id", "kind": "optional", "type": "integer", "description": "" }, { "name": "label", "kind": "optional", "type": "string", "description": "" }, { "name": "breed", "kind": "optional", "type": "string", "description": "" }, { "name": "species_id", "kind": "optional", "type": "integer", "description": "" } ] }, { "name": "color", "kind": "optional", "type": "string", "description": "", "example": "NavajoWhite" }, { "name": "distinctive_marks", "kind": "optional", "type": "string", "description": "", "example": "" }, { "name": "birthday", "kind": "optional", "type": "string", "description": "", "example": "1983-03-29", "format": "date" }, { "name": "gender_string", "kind": "optional", "type": "string", "nullable": true, "description": "", "example": "" }, { "name": "chip_number", "kind": "optional", "type": "string", "nullable": true, "description": "", "example": "" }, { "name": "microchip_location", "kind": "optional", "type": "string", "nullable": true, "description": "", "example": "" }, { "name": "insurance_number", "kind": "optional", "type": "string", "nullable": true, "description": "", "example": "" }, { "name": "passport", "kind": "optional", "type": "string", "nullable": true, "description": "", "example": "" }, { "name": "profile_picture", "kind": "optional", "type": "string", "nullable": true, "description": "", "example": "https://dev-1-public-digitail.s3.eu-central-1.amazonaws.com/ionut/uploads/KXy8Rlv2vluiZYqwRCy2" }, { "name": "description", "kind": "optional", "type": "string", "nullable": true, "description": "", "example": "Lorem ipsum" }, { "name": "constitution", "kind": "optional", "type": "string", "nullable": true, "description": "", "example": "" }, { "name": "conformation", "kind": "optional", "type": "string", "nullable": true, "description": "", "example": "" }, { "name": "weight", "kind": "optional", "type": "string", "nullable": true, "description": "", "example": "" }, { "name": "weight_evolution", "kind": "optional", "type": "integer", "nullable": true, "description": "", "enum": [ "0", "1", "-1" ] }, { "name": "allergies", "kind": "optional", "type": "string", "nullable": true, "description": "", "example": "" }, { "name": "nr_recs", "kind": "optional", "type": "integer", "nullable": true, "description": "", "example": "" }, { "name": "blood_type", "kind": "optional", "type": "string", "nullable": true, "description": "", "example": "" }, { "name": "has_hormonal_change_case", "kind": "optional", "type": "boolean", "description": "

Whether the pet has a record with a spay/neuter visit type, either as the record's reason visit type or among its visit types. Only present when hasHormonalChangeCase is appended.

", "example": true }, { "name": "hormonal_status", "kind": "optional", "type": "integer", "description": "

0: 'Unknown' 1: 'Intact' 2: 'Neutered'

", "example": 0, "enum": [ "0", "1", "2" ] }, { "name": "age", "kind": "optional", "type": "string", "description": "", "example": "38 Years, 3 Months, 19 Days" }, { "name": "age_breakdown", "kind": "optional", "type": "object", "description": "", "example": "", "schema": [ { "name": "years", "kind": "optional", "type": "integer", "description": "", "example": 38 }, { "name": "months", "kind": "optional", "type": "integer", "description": "", "example": 3 }, { "name": "days", "kind": "optional", "type": "integer", "description": "", "example": 19 } ] }, { "name": "patientNumber", "kind": "optional", "type": "string", "description": "", "example": "mxc-1 #jwq-1" }, { "name": "is_verified", "kind": "optional", "type": "string<0 | 1>", "description": "", "example": "1", "enum": [ "0", "1" ] }, { "name": "breeder", "kind": "optional", "type": "string", "nullable": true, "description": "", "example": "" }, { "name": "archive", "kind": "optional", "type": "object", "nullable": true, "description": "

Slim resource for archive, usually attached to other resources. Same as PetArchive

", "example": "", "schema": [ { "name": "id", "kind": "optional", "type": "integer", "description": "", "example": 1 }, { "name": "reason", "kind": "optional", "type": "string", "description": "", "example": "The patient was archived because..." }, { "name": "type", "kind": "optional", "type": "string", "description": "", "example": "Deceased", "enum": [ "Deceased", "Moved away", "Change of owner", "Other" ] } ] }, { "name": "patients", "kind": "optional", "type": "array", "description": "", "example": "", "itemType": "object", "customType": "object[]", "schema": [ { "name": "id", "kind": "optional", "type": "integer", "description": "", "example": 1 }, { "name": "pet_id", "kind": "optional", "type": "integer", "description": "", "example": 1 }, { "name": "clinic_id", "kind": "optional", "type": "integer", "description": "", "example": 1 }, { "name": "number", "kind": "optional", "type": "string", "nullable": true, "description": "", "example": "DGT-102" }, { "name": "archived_at", "kind": "optional", "type": "string", "nullable": true, "description": "", "example": "2020-08-16T08:56:44.000000Z", "format": "date-time" }, { "name": "archive_type_id", "kind": "optional", "type": "integer", "nullable": true, "description": "", "example": 1 }, { "name": "archive_reason", "kind": "optional", "type": "string", "nullable": true, "description": "", "example": "Pet deceased" } ] }, { "name": "birthday_estimated", "kind": "optional", "type": "boolean", "description": "", "example": false }, { "name": "rabic_tag_number", "kind": "optional", "type": "string", "description": "", "example": "12109384" }, { "name": "updated_at", "kind": "optional", "type": "string", "description": "", "example": "2020-06-12 15:45:43" }, { "name": "insurance", "kind": "optional", "type": "object", "description": "Pet insurance information", "example": "", "schema": [ { "name": "id", "kind": "optional", "type": "integer", "description": "", "example": 1 }, { "name": "pet_id", "kind": "optional", "type": "integer", "description": "", "example": 100 }, { "name": "provider", "kind": "optional", "type": "string", "description": "", "example": "trupanion" }, { "name": "policy_id", "kind": "optional", "type": "string", "nullable": true, "description": "", "example": "abc-123-def" }, { "name": "edo_status", "kind": "optional", "type": "string", "nullable": true, "description": "

pending - Certificate issued, awaiting activation\nactive - Certificate activated\nfailed - Certificate failed or expired\npending_reconfirmation - Pending reconfirmation by the pet owner

", "example": "active", "enum": [ "pending", "active", "failed", "pending_reconfirmation" ] }, { "name": "edo_last_sent_at", "kind": "optional", "type": "string", "nullable": true, "description": "", "example": "2026-05-05T10:00:00Z", "format": "date-time" }, { "name": "edo_activated_at", "kind": "optional", "type": "string", "nullable": true, "description": "", "example": "2026-05-06T09:00:00Z", "format": "date-time" }, { "name": "edo_reconfirmed_at", "kind": "optional", "type": "string", "nullable": true, "description": "", "example": "", "format": "date-time" } ] } ] } ], "isExpanded": true } ] } ], "hasXCodeSamples": false, "examples": { "languages": [ { "id": "SyuodQywfRWS7j_aKh25e", "language": "curl", "label": "cURL", "code": "curl --request POST \\\n --url https://developer.digitail.io/api/v1/pets \\\n --header 'accept: application/json' \\\n --header 'content-type: multipart/form-data' \\\n --form 'clinic_id=\"1\"' \\\n --form 'vet_id=\"1\"' \\\n --form 'owner_id=\"1\"' \\\n --form 'nickname=\"Fluffy\"' \\\n --form 'birthday=\"2017-11-28\"' \\\n --form 'species_id=\"1\"' \\\n --form 'breed_id=\"1\"' \\\n --form 'gender=\"male\"' \\\n --form 'hormonal_status=\"0\"'" }, { "id": "V2StumFAf9XcXCzYRqFnJ", "language": "javascript", "label": "javascript", "code": "var myHeaders = new Headers();\nmyHeaders.append(\"accept\", \"application/json\");\nmyHeaders.append(\"content-type\", \"multipart/form-data\");\n\nvar formdata = new FormData();\nformdata.append(\"clinic_id\", \"1\");\nformdata.append(\"vet_id\", \"1\");\nformdata.append(\"owner_id\", \"1\");\nformdata.append(\"nickname\", \"Fluffy\");\nformdata.append(\"birthday\", \"2017-11-28\");\nformdata.append(\"species_id\", \"1\");\nformdata.append(\"breed_id\", \"1\");\nformdata.append(\"gender\", \"male\");\nformdata.append(\"hormonal_status\", \"0\");\n\nvar requestOptions = {\n method: 'POST',\n headers: myHeaders,\n body: formdata,\n redirect: 'follow'\n};\n\nfetch(\"https://developer.digitail.io/api/v1/pets\", requestOptions)\n .then(response => response.text())\n .then(result => console.log(result))\n .catch(error => console.log('error', error));" }, { "id": "Yw-78TKUzkRyBRKAf3QtI", "language": "ruby", "label": "Ruby", "code": "require \"uri\"\nrequire \"net/http\"\n\nurl = URI(\"https://developer.digitail.io/api/v1/pets\")\n\nhttps = Net::HTTP.new(url.host, url.port)\nhttps.use_ssl = true\n\nrequest = Net::HTTP::Post.new(url)\nrequest[\"accept\"] = \"application/json\"\nrequest[\"content-type\"] = \"multipart/form-data\"\nform_data = [['clinic_id', File.open('undefined')],['vet_id', File.open('undefined')],['owner_id', File.open('undefined')],['nickname', File.open('undefined')],['birthday', File.open('undefined')],['species_id', File.open('undefined')],['breed_id', File.open('undefined')],['gender', File.open('undefined')],['hormonal_status', File.open('undefined')]]\nrequest.set_form form_data, 'multipart/form-data'\nresponse = https.request(request)\nputs response.read_body\n" }, { "id": "32IStAd2jMNUmlONb51Ho", "language": "python", "label": "Python", "code": "import requests\n\nurl = \"https://developer.digitail.io/api/v1/pets\"\n\npayload = {}\nfiles=[\n\n]\nheaders = {\n 'accept': 'application/json',\n 'content-type': 'multipart/form-data'\n}\n\nresponse = requests.request(\"POST\", url, headers=headers, data=payload, files=files)\n\nprint(response.text)\n" } ], "selectedLanguageId": "SyuodQywfRWS7j_aKh25e" }, "results": { "languages": [ { "id": "o9Qh9sdlo_QGukH0kgcJW", "language": "201", "code": "// Successful operation\n{\n \"data\": {\n \"id\": 1,\n \"nickname\": \"Fritz\",\n \"species_id\": \"1\",\n \"breed_id\": \"1\",\n \"trupanion_species\": {\n \"id\": 1,\n \"external_id\": 1,\n \"name\": \"Dog\"\n },\n \"trupanion_breed\": {\n \"id\": 1,\n \"external_id\": 101,\n \"name\": \"Golden Retriever\"\n },\n \"observations\": \"\",\n \"gender\": \"male\",\n \"microchip\": \"\",\n \"crossbreed\": \"0\",\n \"crossbreed_details_id\": 0,\n \"crossbreed_details\": {\n \"id\": 0,\n \"label\": \"\",\n \"breed\": \"\",\n \"species_id\": 0\n },\n \"color\": \"NavajoWhite\",\n \"distinctive_marks\": \"\",\n \"birthday\": \"1983-03-29\",\n \"gender_string\": \"\",\n \"chip_number\": \"\",\n \"microchip_location\": \"\",\n \"insurance_number\": \"\",\n \"passport\": \"\",\n \"profile_picture\": \"https://dev-1-public-digitail.s3.eu-central-1.amazonaws.com/ionut/uploads/KXy8Rlv2vluiZYqwRCy2\",\n \"description\": \"Lorem ipsum\",\n \"constitution\": \"\",\n \"conformation\": \"\",\n \"weight\": \"\",\n \"weight_evolution\": 0,\n \"allergies\": \"\",\n \"nr_recs\": 0,\n \"blood_type\": \"\",\n \"has_hormonal_change_case\": true,\n \"hormonal_status\": 0,\n \"age\": \"38 Years, 3 Months, 19 Days\",\n \"age_breakdown\": {\n \"years\": 38,\n \"months\": 3,\n \"days\": 19\n },\n \"patientNumber\": \"mxc-1 #jwq-1\",\n \"is_verified\": \"1\",\n \"breeder\": \"\",\n \"archive\": {\n \"id\": 1,\n \"reason\": \"The patient was archived because...\",\n \"type\": \"Deceased\"\n },\n \"patients\": [\n {\n \"id\": 1,\n \"pet_id\": 1,\n \"clinic_id\": 1,\n \"number\": \"DGT-102\",\n \"archived_at\": \"2020-08-16T08:56:44.000000Z\",\n \"archive_type_id\": 1,\n \"archive_reason\": \"Pet deceased\"\n }\n ],\n \"birthday_estimated\": false,\n \"rabic_tag_number\": \"12109384\",\n \"updated_at\": \"2020-06-12 15:45:43\",\n \"insurance\": {\n \"id\": 1,\n \"pet_id\": 100,\n \"provider\": \"trupanion\",\n \"policy_id\": \"abc-123-def\",\n \"edo_status\": \"active\",\n \"edo_last_sent_at\": \"2026-05-05T10:00:00Z\",\n \"edo_activated_at\": \"2026-05-06T09:00:00Z\",\n \"edo_reconfirmed_at\": \"\"\n }\n }\n}" } ], "selectedLanguageId": "o9Qh9sdlo_QGukH0kgcJW" } }, "children": [ { "text": "" } ] }