Circle V2 API Docs
    Preparing search index...

    Type Alias CreateRpaRunParams

    type CreateRpaRunParams = {
        dryRun?: boolean;
        entityId?: EntityId | null;
        externalRunId?: string | null;
        failureReason?: string | null;
        integrationId?: IntegrationId | null;
        patientId?: PatientId | null;
        rawPayload?: Record<string, unknown> | null;
        status?: RpaRunStatus;
        syncType?: string | null;
        treatmentEpisodeId?: TreatmentEpisodeId | null;
        triggeredBy?: UserId | null;
    }
    Index

    Properties

    dryRun?: boolean
    entityId?: EntityId | null
    externalRunId?: string | null
    failureReason?: string | null
    integrationId?: IntegrationId | null
    patientId?: PatientId | null
    rawPayload?: Record<string, unknown> | null
    status?: RpaRunStatus
    syncType?: string | null
    treatmentEpisodeId?: TreatmentEpisodeId | null

    The episode an episode_docs run is scoped to; null for unbounded / non-episode runs.

    triggeredBy?: UserId | null