Ir al contenido
Nuntius

Create Appointment

Ver como Markdown
POST
/public/v1/appointments
curl --request POST \
  --url https://api.nuntius.chat/public/v1/appointments \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <X-API-Key>' \
  --data '{ "assignedUserId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "title": "example", "appointmentType": "example", "startsAt": "2026-04-15T12:00:00Z", "endsAt": "2026-04-15T12:00:00Z", "customerId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "conversationId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "leadId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "notes": "example" }'

Create a scheduled appointment (source='manual', SPEC_API_PUBLICA.md §2.4).

Every id in the body (assignedUserId/customerId/conversationId/leadId) resolves (id, tenant_id) inside AppointmentService – unknown/foreign -> 404, zero persistence. A real overlap -> 409 APPOINTMENT_OVERLAP.

Idempotency-Key (API-3, D-API-4) is optional: a repeat with the SAME header and SAME body replays the original response without creating a second appointment; the SAME header with a DIFFERENT body -> 422 IDEMPOTENCY_KEY_REUSE_MISMATCH.

Permiso necesario: tenant:appointments.manage

Authorizations

Sección titulada «Authorizations»

Request Bodyrequired

Sección titulada «Request Bodyrequired»
Media typeapplication/json
PublicCreateAppointmentRequest

POST /public/v1/appointments body.

Curated to drop holdToken (a booking-WIDGET-only optimisation for a hold-then-confirm UI flow a public API caller never participates in – omitting it simply means every create runs the live re-check, same as the internal endpoint does for a caller with no/expired hold).

object
assignedUserId
required
Assigneduserid
string format: uuid
title
required
Title
string
>= 1 characters <= 255 characters
appointmentType
required
Appointmenttype
string
>= 1 characters <= 50 characters
startsAt
required
Startsat
string format: date-time
endsAt
required
Endsat
string format: date-time
customerId
Any of:
string format: uuid
conversationId
Any of:
string format: uuid
leadId
Any of:
string format: uuid
notes
Any of:
string

Examplegenerated

{
  "assignedUserId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
  "title": "example",
  "appointmentType": "example",
  "startsAt": "2026-04-15T12:00:00Z",
  "endsAt": "2026-04-15T12:00:00Z",
  "customerId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
  "conversationId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
  "leadId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
  "notes": "example"
}

Responses

Sección titulada «Responses»

201

Sección titulada «201»

Successful Response

Media typeapplication/json
PublicAppointmentOut

A single appointment, curated subset of the internal AppointmentOut.

Drops googleEventId (CAL-11 internal Google Calendar mirror id, meaningless to a third party) and createdBy (the internal actor id – Platform-only attribution; a public caller already knows who acted, it was its own key).

object
id
required
Id
string
assignedUserId
required
Assigneduserid
string
customerId
Any of:
string
conversationId
Any of:
string
leadId
Any of:
string
title
required
Title
string
appointmentType
required
Appointmenttype
string
startsAt
required
Startsat
string
endsAt
required
Endsat
string
status
required
Status
string
source
required
Source
string
notes
Any of:
string
createdAt
required
Createdat
string
updatedAt
required
Updatedat
string

Examplegenerated

{
  "id": "example",
  "assignedUserId": "example",
  "customerId": "example",
  "conversationId": "example",
  "leadId": "example",
  "title": "example",
  "appointmentType": "example",
  "startsAt": "example",
  "endsAt": "example",
  "status": "example",
  "source": "example",
  "notes": "example",
  "createdAt": "example",
  "updatedAt": "example"
}

422

Sección titulada «422»

Validation Error

Media typeapplication/json
HTTPValidationError
object
detail
Detail
Array<object>
ValidationError
object
loc
required
Location
Array
msg
required
Message
string
type
required
Error Type
string
input
Input
ctx
Context
object

Examplegenerated

{
  "detail": [
    {
      "loc": [
        "example"
      ],
      "msg": "example",
      "type": "example",
      "input": "example",
      "ctx": {}
    }
  ]
}