Skip to main content
POST
/
v1
/
appointments
Create appointment
curl --request POST \
  --url https://api.mivicall.com/v1/appointments \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "professionalId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "serviceTypeId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "patientName": "Maria Silva",
  "patientPhone": "+351912345678",
  "startsAt": "2026-05-14T10:00:00+01:00",
  "patientNotes": "<string>"
}
'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "professionalId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "patientName": "Maria Silva",
  "startsAt": "2026-05-14T10:00:00+01:00",
  "endsAt": "2023-11-07T05:31:56Z",
  "status": "confirmed",
  "source": "voice_ai",
  "serviceTypeId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "patientPhoneHash": "<string>",
  "patientNotes": "<string>",
  "metadata": {},
  "createdAt": "2023-11-07T05:31:56Z"
}

Documentation Index

Fetch the complete documentation index at: https://docs.mivicall.com/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
required

API key no header Authorization: Bearer miv_live_.... Gere keys em Settings → Integrations.

Headers

​
Idempotency-Key
string

Identificador único para retry-safe. Ex: pms-create-{vosso-id}.

Body

application/json
​
professionalId
string<uuid>
required
​
serviceTypeId
string<uuid>
required
​
patientName
string
required
Example:

"Maria Silva"

​
patientPhone
string
required

E.164 format

Pattern: ^\+[1-9]\d{1,14}$
Example:

"+351912345678"

​
startsAt
string<date-time>
required
Example:

"2026-05-14T10:00:00+01:00"

​
patientNotes
string

Response

Marcação criada

​
id
string<uuid>
required
​
professionalId
string<uuid>
required
​
patientName
string
required
Example:

"Maria Silva"

​
startsAt
string<date-time>
required
Example:

"2026-05-14T10:00:00+01:00"

​
endsAt
string<date-time>
required
​
status
enum<string>
required
Available options:
confirmed,
attended,
no_show,
cancelled,
rescheduled
​
source
enum<string>
required
Available options:
voice_ai,
manual,
self_service,
sync_external
​
serviceTypeId
string<uuid> | null
​
patientPhoneHash
string

HMAC-SHA256 hash do telefone (PII protegida)

​
patientNotes
string | null
​
metadata
object
​
createdAt
string<date-time>