Editar paciente

PATCH

patients

{id}

Editar paciente

curl --request PATCH \
  --url https://api.westhetics.io/v1/patients/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{}'

const options = {
  method: 'PATCH',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({})
};

fetch('https://api.westhetics.io/v1/patients/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://api.westhetics.io/v1/patients/{id}"

payload = {}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)

{
  "data": {
    "id": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
    "audience": "patient",
    "status": "active",
    "name": "Amanda Ribeiro Costa",
    "birthDate": "1992-04-18",
    "isMinor": false,
    "docType": "cpf",
    "docNumber": "44595830890",
    "foreignDocument": null,
    "rg": null,
    "gender": "female",
    "maritalStatus": "married",
    "occupation": "Arquiteta",
    "email": "amanda@email.com",
    "whatsapp": "+5511987654321",
    "address": {
      "postalCode": "01310100",
      "street": "Avenida Paulista",
      "number": "1000",
      "complement": "apto 52",
      "district": "Bela Vista",
      "city": "São Paulo",
      "state": "SP",
      "country": "BR"
    },
    "guardian": null,
    "imageConsent": "yes",
    "instagram": "amanda.ribeiro",
    "referralSource": {
      "channel": "instagram",
      "detail": null
    },
    "notes": null,
    "patientSince": "2026-10-15",
    "selfRegisteredAt": null,
    "mergedIntoId": null,
    "createdAt": "2026-10-15T14:30:00Z",
    "updatedAt": "2026-10-15T14:30:00Z",
    "archivedAt": null
  }
}

{
  "error": {
    "code": "bad_request",
    "message": "<string>",
    "requestId": "<string>",
    "fields": {}
  }
}

{
  "error": {
    "code": "bad_request",
    "message": "<string>",
    "requestId": "<string>",
    "fields": {}
  }
}

{
  "error": {
    "code": "bad_request",
    "message": "<string>",
    "requestId": "<string>",
    "fields": {}
  }
}

{
  "error": {
    "code": "bad_request",
    "message": "<string>",
    "requestId": "<string>",
    "fields": {}
  }
}

{
  "error": {
    "code": "bad_request",
    "message": "<string>",
    "requestId": "<string>",
    "fields": {}
  }
}

{
  "error": {
    "code": "bad_request",
    "message": "<string>",
    "requestId": "<string>",
    "fields": {}
  }
}

{
  "error": {
    "code": "bad_request",
    "message": "<string>",
    "requestId": "<string>",
    "fields": {}
  }
}

Autorizações

Authorization

string

header

obrigatório

A chave do app de integração, criada em Integrações. Escopos: patients:read (Listar, buscar e ler pacientes; os eventos patient..); patients:write (Criar e editar pacientes. Inclui ler.); anamneses:read (Listar e ler anamneses, sem as respostas; os eventos anamnesis..); anamneses:write (Enviar, reenviar e cancelar anamnese. Inclui ler.); anamneses:answers (Ler as respostas da anamnese preenchida. É dado de saúde.); documents:read (Atendimentos, documentos, status da assinatura e o PDF; os eventos appointment.* e signature_request.*.); documents:write (Gerar contrato e termos e enviar para assinatura, reenviar e cancelar. Inclui ler.); catalog:read (Procedimentos, prestadores e modelos de documento da clínica.); webhooks:write (Criar, alterar e remover os webhooks do próprio app pela API.)

Parâmetros de caminho

string<uuid>

obrigatório

Corpo

application/json

name

string

Minimum string length: 1

string

Minimum string length: 1

dialCode

string

Pattern: ^\+[0-9]{1,3}$

audience

enum<string> | null

Opções disponíveis:

patient,

student,

employee,

third_party

string

Minimum string length: 1

birthDate

string<date> | null

Pattern:

^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))$

docNumber

string | null

docType

enum<string> | null

Opções disponíveis:

cnpj,

cpf

foreignDocument

object | null

Show child attributes

string | null

gender

enum<string> | null

Opções disponíveis:

female,

male,

other,

not_provided

maritalStatus

enum<string> | null

Opções disponíveis:

single,

married,

domestic_partnership,

separated,

divorced,

widowed

occupation

string | null

address

object | null

Show child attributes

guardian

object | null

Show child attributes

Opções disponíveis:

yes,

no,

not_provided

instagram

string | null

Pattern: ^[A-Za-z0-9._]{1,30}$

notes

string | null

referralSource

object | null

Show child attributes

Resposta

Sucesso.

data

object

obrigatório

O cadastro da paciente na clínica.

Show child attributes

Editar paciente

curl --request PATCH \
  --url https://api.westhetics.io/v1/patients/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{}'

const options = {
  method: 'PATCH',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({})
};

fetch('https://api.westhetics.io/v1/patients/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://api.westhetics.io/v1/patients/{id}"

payload = {}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)

{
  "data": {
    "id": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
    "audience": "patient",
    "status": "active",
    "name": "Amanda Ribeiro Costa",
    "birthDate": "1992-04-18",
    "isMinor": false,
    "docType": "cpf",
    "docNumber": "44595830890",
    "foreignDocument": null,
    "rg": null,
    "gender": "female",
    "maritalStatus": "married",
    "occupation": "Arquiteta",
    "email": "amanda@email.com",
    "whatsapp": "+5511987654321",
    "address": {
      "postalCode": "01310100",
      "street": "Avenida Paulista",
      "number": "1000",
      "complement": "apto 52",
      "district": "Bela Vista",
      "city": "São Paulo",
      "state": "SP",
      "country": "BR"
    },
    "guardian": null,
    "imageConsent": "yes",
    "instagram": "amanda.ribeiro",
    "referralSource": {
      "channel": "instagram",
      "detail": null
    },
    "notes": null,
    "patientSince": "2026-10-15",
    "selfRegisteredAt": null,
    "mergedIntoId": null,
    "createdAt": "2026-10-15T14:30:00Z",
    "updatedAt": "2026-10-15T14:30:00Z",
    "archivedAt": null
  }
}

{
  "error": {
    "code": "bad_request",
    "message": "<string>",
    "requestId": "<string>",
    "fields": {}
  }
}

{
  "error": {
    "code": "bad_request",
    "message": "<string>",
    "requestId": "<string>",
    "fields": {}
  }
}

{
  "error": {
    "code": "bad_request",
    "message": "<string>",
    "requestId": "<string>",
    "fields": {}
  }
}

{
  "error": {
    "code": "bad_request",
    "message": "<string>",
    "requestId": "<string>",
    "fields": {}
  }
}

{
  "error": {
    "code": "bad_request",
    "message": "<string>",
    "requestId": "<string>",
    "fields": {}
  }
}

{
  "error": {
    "code": "bad_request",
    "message": "<string>",
    "requestId": "<string>",
    "fields": {}
  }
}

{
  "error": {
    "code": "bad_request",
    "message": "<string>",
    "requestId": "<string>",
    "fields": {}
  }
}

Visão geral

Endpoints

Autorizações

Parâmetros de caminho

Corpo

Resposta