---
title: Create a PetParent
slug: create-a-petparent
docTags:
createdAt: 2026-04-21T15:22:49.957Z
---
{
"id": "bswPCXxu4Oc9hxn5byGNk",
"type": "api-oas-v2",
"data": {
"method": "POST",
"url": "https://developer.digitail.io/api/v1/pet-parents",
"servers": [
{
"url": "https://developer.digitail.io/api/v1/pet-parents",
"description": "Sandbox server (uses test data)"
},
{
"url": "https://vet.digitail.io/api/v1/pet-parents",
"description": "Production server (uses live data)"
}
],
"name": "Create a PetParent",
"description": "Permissions needed: CREATE_PATIENTS\nCreate a new pet parent. If the cross-clinic account validation feature is enabled, the email must be unique globally. If an existing account is found with the same email, and the feature is active, validation will fail.
",
"contentType": "application/json",
"request": {
"pathParameters": [],
"headerParameters": [
{
"name": "accept",
"type": "string",
"kind": "optional",
"description": "Generated from available response content types",
"enum": [
"application/json"
],
"default": "application/json"
}
],
"queryParameters": [],
"bodyDataParameters": [
{
"kind": "required",
"name": "body",
"type": "object",
"description": "",
"schema": [
{
"name": "clinic_id",
"kind": "optional",
"type": "integer",
"nullable": false,
"description": "Clinic id.",
"example": 1
},
{
"name": "name",
"kind": "required",
"type": "string",
"description": "",
"example": "John"
},
{
"name": "last_name",
"kind": "required",
"type": "string",
"description": "",
"example": "Doe"
},
{
"name": "email",
"kind": "optional",
"type": "string",
"description": "",
"example": "john@example.com"
},
{
"name": "password",
"kind": "optional",
"type": "string",
"description": "If omitted, a random password will be generated and sent to the user on creation and the old one will be kept on update.
",
"example": "password"
},
{
"name": "phone",
"kind": "optional",
"type": "string",
"nullable": false,
"description": "Phone number in E.164 format",
"example": "+16175551212"
},
{
"name": "secondary_phone",
"kind": "optional",
"type": "string",
"nullable": true,
"description": "Phone number in E.164 format",
"example": "+16175551212"
},
{
"name": "google_place_id",
"kind": "optional",
"type": "string",
"nullable": true,
"description": ""
},
{
"name": "address",
"kind": "optional",
"type": "string",
"nullable": true,
"description": "",
"example": "Flowers St. 300, Palo Alto, 123456, USA"
},
{
"name": "address2",
"kind": "optional",
"type": "string",
"nullable": true,
"description": "",
"example": "Flowers St 123"
},
{
"name": "city",
"kind": "optional",
"type": "string",
"nullable": true,
"description": "",
"example": "Palo Alto"
},
{
"name": "birthdate",
"kind": "optional",
"type": "string",
"nullable": true,
"description": "",
"example": "1990-01-01"
},
{
"name": "zip_code",
"kind": "optional",
"type": "string",
"nullable": true,
"description": "",
"example": "123456"
},
{
"name": "street",
"kind": "optional",
"type": "string",
"nullable": true,
"description": "",
"example": "Flowers St."
},
{
"name": "street_number",
"kind": "optional",
"type": "string",
"nullable": true,
"description": "",
"example": "123"
},
{
"name": "region",
"kind": "optional",
"type": "string",
"nullable": true,
"description": "",
"example": "California"
},
{
"name": "region_short_code",
"kind": "optional",
"type": "string",
"nullable": true,
"description": "",
"example": "CA"
},
{
"name": "country_id",
"kind": "optional",
"type": "string",
"nullable": true,
"description": "",
"example": "US"
},
{
"name": "latitude",
"kind": "optional",
"type": "string",
"nullable": true,
"description": "",
"example": "37.4419"
},
{
"name": "longitude",
"kind": "optional",
"type": "string",
"nullable": true,
"description": "",
"example": "122.1430"
},
{
"name": "cnp",
"kind": "optional",
"type": "string",
"nullable": true,
"description": "",
"example": "1234567890123"
},
{
"name": "terms_and_conditions",
"kind": "required",
"type": "boolean",
"description": "",
"example": true
},
{
"name": "observations",
"kind": "optional",
"type": "string",
"nullable": true,
"description": "",
"example": "happy"
},
{
"name": "tag_ids",
"kind": "optional",
"type": "array",
"nullable": true,
"description": "",
"example": "",
"itemType": "integer",
"customType": "integer[]",
"itemExample": "",
"itemDefault": ""
},
{
"name": "enable_chat_without_app",
"kind": "optional",
"type": "boolean",
"nullable": true,
"description": "",
"example": false
},
{
"name": "referral_source_type",
"kind": "optional",
"type": "string",
"nullable": true,
"description": "",
"enum": [
"google_search",
"social_media",
"referral",
"walk_in",
"local_event",
"paid_ad",
"blog",
"signage",
"walk_by",
"online_reviews",
"vet_referral",
"other"
]
},
{
"name": "referral_source_details",
"kind": "optional",
"type": "string",
"nullable": true,
"description": ""
},
{
"name": "avatar",
"kind": "optional",
"type": "string",
"description": "",
"format": "binary"
}
],
"isExpanded": true
}
],
"formDataParameters": [],
"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": "PetParent = User = Customer = Owner. PetParent is the preferred term.
",
"example": "",
"schema": [
{
"name": "id",
"kind": "optional",
"type": "integer",
"description": "",
"example": 1
},
{
"name": "name",
"kind": "optional",
"type": "string",
"description": "",
"example": "John"
},
{
"name": "last_name",
"kind": "optional",
"type": "string",
"description": "",
"example": "Doe"
},
{
"name": "email",
"kind": "optional",
"type": "string",
"nullable": true,
"description": "",
"example": "john@example.com"
},
{
"name": "phone",
"kind": "optional",
"type": "string",
"description": "In E164 format",
"example": "+19772480544"
},
{
"name": "secondary_phone",
"kind": "optional",
"type": "string",
"nullable": true,
"description": "In E164 format",
"example": "+19772480544"
},
{
"name": "chatUid",
"kind": "optional",
"type": "string",
"nullable": true,
"description": "",
"example": "cjfiem-c9hg-apzm-23sod"
},
{
"name": "has_app",
"kind": "optional",
"type": "integer",
"description": "",
"example": 1
},
{
"name": "has_app_date",
"kind": "optional",
"type": "string",
"nullable": true,
"description": "",
"example": "2020-06-12 15:45:43"
},
{
"name": "enable_chat_without_app",
"kind": "optional",
"type": "integer",
"description": "",
"example": 1
},
{
"name": "created_at",
"kind": "optional",
"type": "string",
"description": "",
"example": "2020-06-12 15:45:43"
},
{
"name": "updated_at",
"kind": "optional",
"type": "string",
"description": "",
"example": "2020-06-12 15:45:43"
},
{
"name": "address",
"kind": "optional",
"type": "string",
"nullable": true,
"description": "",
"example": "Flowers St. 300, Palo Alto, 123456, USA"
},
{
"name": "address_2",
"kind": "optional",
"type": "string",
"nullable": true,
"description": "",
"example": ""
},
{
"name": "city",
"kind": "optional",
"type": "string",
"nullable": true,
"description": "",
"example": "Buenos Aires"
},
{
"name": "birthdate",
"kind": "optional",
"type": "string",
"nullable": true,
"description": "",
"example": "1990-04-04",
"format": "date-time"
},
{
"name": "observations",
"kind": "optional",
"type": "string",
"nullable": true,
"description": "",
"example": "happy"
},
{
"name": "cnp",
"kind": "optional",
"type": "string",
"nullable": true,
"description": "",
"example": "1234567890123"
},
{
"name": "chip_number",
"kind": "optional",
"type": "string",
"nullable": true,
"description": "",
"example": "99281028"
},
{
"name": "discounts",
"kind": "optional",
"type": "array",
"description": "",
"example": "",
"itemType": "object",
"customType": "object[]",
"schema": [
{
"name": "id",
"kind": "optional",
"type": "integer",
"description": "",
"example": 10
},
{
"name": "name",
"kind": "optional",
"type": "string",
"description": "",
"example": "digitail disc10"
},
{
"name": "description",
"kind": "optional",
"type": "string",
"nullable": true,
"description": "",
"example": "digitail disc10"
},
{
"name": "discount",
"kind": "optional",
"type": "integer",
"nullable": true,
"description": "",
"example": 10
},
{
"name": "discount_type",
"kind": "optional",
"type": "integer",
"description": "0 - fixed 1 - percentage
",
"enum": [
"0",
"1"
]
},
{
"name": "apply_on_cogs",
"kind": "optional",
"type": "boolean",
"description": "",
"example": false
},
{
"name": "discount_products",
"kind": "optional",
"type": "number",
"nullable": true,
"description": "",
"example": 10
},
{
"name": "discount_type_products",
"kind": "optional",
"type": "integer",
"description": "0 - fixed 1 - percentage
",
"enum": [
"0",
"1"
]
},
{
"name": "discount_services",
"kind": "optional",
"type": "number",
"nullable": true,
"description": "",
"example": 10
},
{
"name": "discount_type_services",
"kind": "optional",
"type": "integer",
"description": "0 - fixed 1 - percentage
",
"enum": [
"0",
"1"
]
},
{
"name": "enabled",
"kind": "optional",
"type": "boolean",
"description": "",
"example": true
}
]
},
{
"name": "address_meta_data",
"kind": "optional",
"type": "object",
"description": "",
"example": "",
"schema": [
{
"name": "zip_code",
"kind": "optional",
"type": "string",
"description": "",
"example": "123456"
},
{
"name": "city",
"kind": "optional",
"type": "string",
"description": "",
"example": "Palo Alto"
},
{
"name": "street",
"kind": "optional",
"type": "string",
"description": "",
"example": "Flowers St."
},
{
"name": "street_number",
"kind": "optional",
"type": "string",
"description": "",
"example": "1990"
},
{
"name": "region",
"kind": "optional",
"type": "string",
"description": "",
"example": "California"
},
{
"name": "region_short_code",
"kind": "optional",
"type": "string",
"description": "",
"example": "CA"
},
{
"name": "country_id",
"kind": "optional",
"type": "integer",
"description": "",
"example": 6
},
{
"name": "latitude",
"kind": "optional",
"type": "string",
"description": "",
"example": "37.4419"
},
{
"name": "longitude",
"kind": "optional",
"type": "string",
"description": "",
"example": "122.1430"
},
{
"name": "address_2",
"kind": "optional",
"type": "string",
"description": "",
"example": ""
}
]
},
{
"name": "current_client_id",
"kind": "optional",
"type": "integer",
"nullable": true,
"description": "",
"example": 30
},
{
"name": "clients",
"kind": "optional",
"type": "array",
"description": "",
"example": "",
"itemType": "object",
"customType": "object[]",
"schema": [
{
"name": "id",
"kind": "optional",
"type": "integer",
"description": "",
"example": 1
},
{
"name": "clinic_id",
"kind": "optional",
"type": "integer",
"description": "",
"example": 1
},
{
"name": "referral_source_type",
"kind": "optional",
"type": "string",
"nullable": true,
"description": "",
"enum": [
"google_search",
"social_media",
"referral",
"walk_in",
"local_event",
"paid_ad",
"blog",
"signage",
"walk_by",
"online_reviews",
"vet_referral",
"other"
]
},
{
"name": "referral_source_details",
"kind": "optional",
"type": "string",
"nullable": true,
"description": ""
}
]
},
{
"name": "preferences",
"kind": "optional",
"type": "object",
"nullable": true,
"description": "",
"example": "",
"schema": []
}
]
}
],
"isExpanded": true
}
]
}
],
"hasXCodeSamples": false,
"examples": {
"languages": [
{
"id": "dzP1ttYLFrh_DqgJX556d",
"language": "curl",
"label": "cURL",
"code": "curl --request POST \\\n --url https://developer.digitail.io/api/v1/pet-parents \\\n --header 'accept: application/json' \\\n --header 'content-type: application/json' \\\n --data '{\n \"name\": \"John\",\n \"last_name\": \"Doe\",\n \"terms_and_conditions\": true\n }'"
},
{
"id": "jgez0n1ojqnyno5-ceO8z",
"language": "javascript",
"label": "javascript",
"code": "var myHeaders = new Headers();\nmyHeaders.append(\"accept\", \"application/json\");\nmyHeaders.append(\"content-type\", \"application/json\");\n\nvar raw = JSON.stringify({\n \"name\": \"John\",\n \"last_name\": \"Doe\",\n \"terms_and_conditions\": true\n});\n\nvar requestOptions = {\n method: 'POST',\n headers: myHeaders,\n body: raw,\n redirect: 'follow'\n};\n\nfetch(\"https://developer.digitail.io/api/v1/pet-parents\", requestOptions)\n .then(response => response.text())\n .then(result => console.log(result))\n .catch(error => console.log('error', error));"
},
{
"id": "buR79NPoI4wkhTgM_CjpA",
"language": "ruby",
"label": "Ruby",
"code": "require \"uri\"\nrequire \"json\"\nrequire \"net/http\"\n\nurl = URI(\"https://developer.digitail.io/api/v1/pet-parents\")\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\"] = \"application/json\"\nrequest.body = JSON.dump({\n \"name\": \"John\",\n \"last_name\": \"Doe\",\n \"terms_and_conditions\": true\n})\n\nresponse = https.request(request)\nputs response.read_body\n"
},
{
"id": "RGqUFRyv1U25MRsDKT6LQ",
"language": "python",
"label": "Python",
"code": "import requests\nimport json\n\nurl = \"https://developer.digitail.io/api/v1/pet-parents\"\n\npayload = json.dumps({\n \"name\": \"John\",\n \"last_name\": \"Doe\",\n \"terms_and_conditions\": True\n})\nheaders = {\n 'accept': 'application/json',\n 'content-type': 'application/json'\n}\n\nresponse = requests.request(\"POST\", url, headers=headers, data=payload)\n\nprint(response.text)\n"
}
],
"selectedLanguageId": "dzP1ttYLFrh_DqgJX556d"
},
"results": {
"languages": [
{
"id": "SsfMs9NXXXCsXO8ab6_tS",
"language": "201",
"code": "// successful operation\n{\n \"data\": {\n \"id\": 1,\n \"name\": \"John\",\n \"last_name\": \"Doe\",\n \"email\": \"john@example.com\",\n \"phone\": \"+19772480544\",\n \"secondary_phone\": \"+19772480544\",\n \"chatUid\": \"cjfiem-c9hg-apzm-23sod\",\n \"has_app\": 1,\n \"has_app_date\": \"2020-06-12 15:45:43\",\n \"enable_chat_without_app\": 1,\n \"created_at\": \"2020-06-12 15:45:43\",\n \"updated_at\": \"2020-06-12 15:45:43\",\n \"address\": \"Flowers St. 300, Palo Alto, 123456, USA\",\n \"address_2\": \"\",\n \"city\": \"Buenos Aires\",\n \"birthdate\": \"1990-04-04\",\n \"observations\": \"happy\",\n \"cnp\": \"1234567890123\",\n \"chip_number\": \"99281028\",\n \"discounts\": [\n {\n \"id\": 10,\n \"name\": \"digitail disc10\",\n \"description\": \"digitail disc10\",\n \"discount\": 10,\n \"discount_type\": 0,\n \"apply_on_cogs\": false,\n \"discount_products\": 10,\n \"discount_type_products\": 0,\n \"discount_services\": 10,\n \"discount_type_services\": 0,\n \"enabled\": true\n }\n ],\n \"address_meta_data\": {\n \"zip_code\": \"123456\",\n \"city\": \"Palo Alto\",\n \"street\": \"Flowers St.\",\n \"street_number\": \"1990\",\n \"region\": \"California\",\n \"region_short_code\": \"CA\",\n \"country_id\": 6,\n \"latitude\": \"37.4419\",\n \"longitude\": \"122.1430\",\n \"address_2\": \"\"\n },\n \"current_client_id\": 30,\n \"clients\": [\n {\n \"id\": 1,\n \"clinic_id\": 1,\n \"referral_source_type\": \"\",\n \"referral_source_details\": \"\"\n }\n ],\n \"preferences\": {}\n }\n}"
}
],
"selectedLanguageId": "SsfMs9NXXXCsXO8ab6_tS"
}
},
"children": [
{
"text": ""
}
]
}