Gerar contrato e termos

POST

appointments

curl --request POST \
  --url https://api.westhetics.io/v1/appointments \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "patientId": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
  "procedureIds": [
    "b8e2c4d6-1f3a-4b5c-8d7e-9f0a1b2c3d4e"
  ],
  "practitionerId": "7c1d9e2f-3a4b-4c5d-8e6f-7a8b9c0d1e2f",
  "imageConsent": "yes",
  "procedureDate": "2026-10-20",
  "procedureTime": "14:30"
}
'

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    patientId: 'f47ac10b-58cc-4372-a567-0e02b2c3d479',
    procedureIds: ['b8e2c4d6-1f3a-4b5c-8d7e-9f0a1b2c3d4e'],
    practitionerId: '7c1d9e2f-3a4b-4c5d-8e6f-7a8b9c0d1e2f',
    imageConsent: 'yes',
    procedureDate: '2026-10-20',
    procedureTime: '14:30'
  })
};

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

import requests

url = "https://api.westhetics.io/v1/appointments"

payload = {
    "patientId": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
    "procedureIds": ["b8e2c4d6-1f3a-4b5c-8d7e-9f0a1b2c3d4e"],
    "practitionerId": "7c1d9e2f-3a4b-4c5d-8e6f-7a8b9c0d1e2f",
    "imageConsent": "yes",
    "procedureDate": "2026-10-20",
    "procedureTime": "14:30"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

{
  "data": {
    "id": "3c9d1e2f-4a5b-4c7d-8e9f-0a1b2c3d4e5f",
    "parentAppointmentId": null,
    "type": "procedure",
    "state": "generated",
    "patientId": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
    "anamnesisId": "5e1d2c3b-4a59-4687-b6a5-948372615049",
    "practitioner": {
      "id": "7c1d9e2f-3a4b-4c5d-8e6f-7a8b9c0d1e2f",
      "name": "Ana Oliveira"
    },
    "procedures": [
      {
        "id": "b8e2c4d6-1f3a-4b5c-8d7e-9f0a1b2c3d4e",
        "name": "Preenchimento labial",
        "type": "single",
        "amountCents": 190000
      }
    ],
    "totalAmountCents": 190000,
    "paymentTerms": "PIX, débito ou crédito em até 10× sem juros.",
    "imageConsent": "yes",
    "isModelPatient": false,
    "procedureDate": "2026-10-20",
    "procedureTime": "14:30",
    "generation": 1,
    "generatedAt": "2026-10-15T14:30:00Z",
    "documents": [
      {
        "id": "d4e5f6a7-b8c9-4123-8ef4-567890123456",
        "appointmentId": "3c9d1e2f-4a5b-4c7d-8e9f-0a1b2c3d4e5f",
        "patientId": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
        "templateId": "a1b2c3d4-e5f6-4a7b-8c9d-0e1f2a3b4c5d",
        "name": "Contrato de prestação de serviços",
        "category": "service_contract",
        "versionLabel": "5",
        "status": "awaiting_patient",
        "contentHash": "a3f9c1e7d2b84f6a9e0c1d2b3a4f5e6d7c8b9a0f1e2d3c4b5a6978877665544",
        "pageCount": 4,
        "hasFile": true,
        "isRestricted": false,
        "signedFileHash": null,
        "generatedAt": "2026-10-15T14:30:00Z",
        "patientSignedAt": null,
        "signedAt": null,
        "expiredAt": null,
        "canceledAt": null,
        "updatedAt": "2026-10-15T14:30:00Z"
      }
    ],
    "signature": {
      "status": "generated",
      "request": null
    },
    "createdAt": "2026-10-15T14:30:00Z",
    "updatedAt": "2026-10-15T14:30:00Z"
  }
}

{
  "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": {}
  }
}

{
  "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.)

Cabeçalhos

Idempotency-Key

string<uuid>

Um uuid. A mesma chave nas 24 horas devolve a mesma resposta, sem repetir o efeito; com outro corpo, ou enquanto a primeira chamada ainda roda, 409. A resposta repetida não traz o segredo do webhook.

Corpo

application/json

patientId

string<uuid>

Pattern:

^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$

parentAppointmentId

string<uuid>

Para acrescentar termos a um atendimento já enviado: o id dele. Paciente, procedimentos, prestador e valor vêm dele; o adicional tem envio, protocolo e link próprios.

Pattern:

^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$

type

enum<string>

padrão:procedure

Opções disponíveis:

procedure,

standalone

procedureIds

string<uuid>[]

Maximum array length: 20

Pattern:

^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$

practitionerId

string<uuid>

Pattern:

^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$

templateIds

string<uuid>[]

Maximum array length: 12

Pattern:

^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$

Se a paciente autoriza o uso de imagem por esta clínica. Ao gerar, atualiza o cadastro dela nesta clínica.

Opções disponíveis:

yes,

no

totalAmountCents

integer

Intervalo obrigatório: 0 <= x <= 10000000000

procedureDate

string<date>

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])))$

procedureTime

string

Pattern: ^([01]\d|2[0-3]):[0-5]\d$

freeText

string

Maximum string length: 2000

anamnesisId

string<uuid>

Pattern:

^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$

isModelPatient

boolean

Resposta

Criado.

data

object

obrigatório

O atendimento: os procedimentos, o valor, os documentos e a assinatura.

Show child attributes

Gerar contrato e termos

curl --request POST \
  --url https://api.westhetics.io/v1/appointments \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "patientId": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
  "procedureIds": [
    "b8e2c4d6-1f3a-4b5c-8d7e-9f0a1b2c3d4e"
  ],
  "practitionerId": "7c1d9e2f-3a4b-4c5d-8e6f-7a8b9c0d1e2f",
  "imageConsent": "yes",
  "procedureDate": "2026-10-20",
  "procedureTime": "14:30"
}
'

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    patientId: 'f47ac10b-58cc-4372-a567-0e02b2c3d479',
    procedureIds: ['b8e2c4d6-1f3a-4b5c-8d7e-9f0a1b2c3d4e'],
    practitionerId: '7c1d9e2f-3a4b-4c5d-8e6f-7a8b9c0d1e2f',
    imageConsent: 'yes',
    procedureDate: '2026-10-20',
    procedureTime: '14:30'
  })
};

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

import requests

url = "https://api.westhetics.io/v1/appointments"

payload = {
    "patientId": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
    "procedureIds": ["b8e2c4d6-1f3a-4b5c-8d7e-9f0a1b2c3d4e"],
    "practitionerId": "7c1d9e2f-3a4b-4c5d-8e6f-7a8b9c0d1e2f",
    "imageConsent": "yes",
    "procedureDate": "2026-10-20",
    "procedureTime": "14:30"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

{
  "data": {
    "id": "3c9d1e2f-4a5b-4c7d-8e9f-0a1b2c3d4e5f",
    "parentAppointmentId": null,
    "type": "procedure",
    "state": "generated",
    "patientId": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
    "anamnesisId": "5e1d2c3b-4a59-4687-b6a5-948372615049",
    "practitioner": {
      "id": "7c1d9e2f-3a4b-4c5d-8e6f-7a8b9c0d1e2f",
      "name": "Ana Oliveira"
    },
    "procedures": [
      {
        "id": "b8e2c4d6-1f3a-4b5c-8d7e-9f0a1b2c3d4e",
        "name": "Preenchimento labial",
        "type": "single",
        "amountCents": 190000
      }
    ],
    "totalAmountCents": 190000,
    "paymentTerms": "PIX, débito ou crédito em até 10× sem juros.",
    "imageConsent": "yes",
    "isModelPatient": false,
    "procedureDate": "2026-10-20",
    "procedureTime": "14:30",
    "generation": 1,
    "generatedAt": "2026-10-15T14:30:00Z",
    "documents": [
      {
        "id": "d4e5f6a7-b8c9-4123-8ef4-567890123456",
        "appointmentId": "3c9d1e2f-4a5b-4c7d-8e9f-0a1b2c3d4e5f",
        "patientId": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
        "templateId": "a1b2c3d4-e5f6-4a7b-8c9d-0e1f2a3b4c5d",
        "name": "Contrato de prestação de serviços",
        "category": "service_contract",
        "versionLabel": "5",
        "status": "awaiting_patient",
        "contentHash": "a3f9c1e7d2b84f6a9e0c1d2b3a4f5e6d7c8b9a0f1e2d3c4b5a6978877665544",
        "pageCount": 4,
        "hasFile": true,
        "isRestricted": false,
        "signedFileHash": null,
        "generatedAt": "2026-10-15T14:30:00Z",
        "patientSignedAt": null,
        "signedAt": null,
        "expiredAt": null,
        "canceledAt": null,
        "updatedAt": "2026-10-15T14:30:00Z"
      }
    ],
    "signature": {
      "status": "generated",
      "request": null
    },
    "createdAt": "2026-10-15T14:30:00Z",
    "updatedAt": "2026-10-15T14:30:00Z"
  }
}

{
  "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": {}
  }
}

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

Visão geral

Endpoints

Autorizações

Cabeçalhos

Corpo

Resposta