Natzar Partner API Reference - v1.0.0
    Preparing search index...

    Interface PatientResource

    A patient you provisioned via POST /v1/patients.

    Partner-provisioned patients have messageChannel: 'partner': the platform never contacts them over WhatsApp/SMS — every outbound message is persisted to the consult transcript and surfaced to you via webhooks (async_consult.message) and the embed widgets.

    interface PatientResource {
        id: string;
        externalId: string;
        phone: string;
        email: string;
        givenName: string;
        familyName: string;
        birthdate: string;
        sex: PatientSex;
        lang: PatientLang;
        messageChannel: "partner";
        createdAt: string;
        updatedAt: string;
        state?: string;
        country?: string;
    }
    Index
    id externalId phone email givenName familyName birthdate sex lang messageChannel createdAt updatedAt state? country?
    id: string

    Our id for the patient. Use it or externalId interchangeably in consult creation.

    externalId: string

    Your id for the patient, as supplied at provisioning. Unique within your tenant.

    phone: string

    E.164 phone number, e.g. +15551234567. The patient's identity key — immutable after creation (a phone change requires re-provisioning through support).

    email: string

    Contact email.

    givenName: string

    Given (first) name.

    familyName: string

    Family (last) name.

    birthdate: string

    Date of birth, YYYY-MM-DD.

    sex: PatientSex

    Biological sex.

    lang: PatientLang

    Locale for system messages and embeds; defaults to en_US.

    messageChannel: "partner"

    Always 'partner' for API-provisioned patients: delivery happens via your integration (webhooks/embeds), never over WhatsApp/SMS.

    createdAt: string

    When the patient record was created.

    updatedAt: string

    When the patient record was last modified.

    state?: string
    country?: string

    Settings
    Member Visibility

    On This Page
    Properties