latestOpenAPI 3.0.0Apache 2.02026-08-201250995.7 KB

bd9694db5fce

Pet Parents

Create a PetParent

Permissions needed: CREATE_PATIENTS Create 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.

post/api/v1/pet-parents

Request body

clinic_idinteger

Clinic id.

namestring required

last_namestring required

emailstring

passwordstring

If omitted, a random password will be generated and sent to the user on creation and the old one will be kept on update.

phonestring

Phone number in E.164 format

secondary_phonestring nullable

Phone number in E.164 format

google_place_idstring nullable

addressstring nullable

address2string nullable

citystring nullable

birthdatestring nullable

zip_codestring nullable

streetstring nullable

street_numberstring nullable

regionstring nullable

region_short_codestring nullable

country_idstring nullable

latitudestring nullable

longitudestring nullable

cnpstring nullable

terms_and_conditionsboolean required

observationsstring nullable

tag_idsinteger[] nullable

enable_chat_without_appboolean nullable

referral_source_detailsstring nullable

avatarstring binary

Example request

{
  "clinic_id": 1,
  "name": "John",
  "last_name": "Doe",
  "email": "john@example.com",
  "password": "password",
  "phone": "+16175551212",
  "secondary_phone": "+16175551212",
  "address": "Flowers St. 300, Palo Alto, 123456, USA",
  "address2": "Flowers St 123",
  "city": "Palo Alto",
  "birthdate": "1990-01-01",
  "zip_code": "123456",
  "street": "Flowers St.",
  "street_number": "123",
  "region": "California",
  "region_short_code": "CA",
  "country_id": "US",
  "latitude": "37.4419",
  "longitude": "122.1430",
  "cnp": "1234567890123",
  "terms_and_conditions": true,
  "observations": "happy"
}

Response

successful operation

Example response

{
  "data": {
    "id": 1,
    "name": "John",
    "last_name": "Doe",
    "email": "john@example.com",
    "phone": "+19772480544",
    "secondary_phone": "+19772480544",
    "chatUid": "cjfiem-c9hg-apzm-23sod",
    "has_app": 1,
    "has_app_date": "2020-06-12 15:45:43",
    "enable_chat_without_app": 1,
    "created_at": "2020-06-12 15:45:43",
    "updated_at": "2020-06-12 15:45:43",
    "address": "Flowers St. 300, Palo Alto, 123456, USA",
    "city": "Buenos Aires",
    "birthdate": "1990-04-04",
    "observations": "happy",
    "cnp": "1234567890123",
    "chip_number": "99281028",
    "discounts": [
      {
        "id": 10,
        "name": "digitail disc10",
        "description": "digitail disc10",
        "discount": 10,
        "discount_products": 10,
        "discount_services": 10,
        "enabled": true
      }
    ],
    "address_meta_data": {
      "zip_code": "123456",
      "city": "Palo Alto",
      "street": "Flowers St.",
      "street_number": "1990",
      "region": "California",
      "region_short_code": "CA",
      "country_id": 6,
      "latitude": "37.4419",
      "longitude": "122.1430"
    },
    "current_client_id": 30,
    "clients": [
      {
        "id": 1,
        "clinic_id": 1
      }
    ]
  }
}