# Set a document synchronization status.

Use this endpoint to set a document synchronization status.

Endpoint: POST /documents/{uuid}/status
Version: 1.94.0
Security: oauth_auth_code

## Security:

  - `oauth_auth_code` (unknown)
    oauth2 scopes: write:document_integrations

## Path parameters:

  - `uuid` (string, required)
    Document identifier

## Query parameters:

  - `expand[]` (array)

## Request body:

  - `application/json, application/ld+json, multipart/form-data` (unknown)
    The new Document resource

## Request fields (application/json):

  - `success` (boolean | null, required)
    Whether the synchronization was successful or not.

  - `error` (string | null)
    Optional but recommended: Error message if synchronization failed (only when success is false).

## Response 200:

  - `200` (unknown)
    Document resource created

## Response 200 fields (application/json):

  - `uuid` (string)
    Document unique identifier.

  - `createdAt` (string)
    Document creation date.

  - `updatedAt` (string)
    Document update date.

  - `encounteredAt` (string | null)
    Document operation/cone beam specific date.

  - `user` (object)

  - `user.uuid` (string)
    User unique identifier.

  - `user.email` (string, required)
    User email address.

  - `user.createdAt` (string)
    User creation date.

  - `user.updatedAt` (string)
    User update date.

  - `user.firstName` (string | null, required)
    User first name.

  - `user.lastName` (string | null, required)
    User last name.

  - `user.gender` (string | null)
    User gender.
    Enum: "female", "male", "unknown", "null"

  - `user.phone` (string | null)
    User phone number.
    Example: +33757590893

  - `user.rpps` (string | null)
    User RPPS number (France).
    Example: 10101748050

  - `user.am` (string | null)
    User AM number (France).
    Example: 394003552

  - `user.isConventionne` (boolean)
    Whether the practitioner is "conventionne" (national administrative fact, sourced from the Ameli extract). Read-only.

  - `patient` (any)
    Document patient.

  - `patient.uuid` (string)
    Patient unique identifier.

  - `patient.firstName` (string | null, required)
    Patient first name.

  - `patient.lastName` (string | null, required)
    Patient last name.

  - `patient.languageSpoken` (string)
    Patient language.

  - `patient.createdAt` (string)
    Patient creation date.

  - `patient.updatedAt` (string)
    Patient update date.

  - `patient.synchronizedAt` (string | null)
    Patient synchronization date.

  - `patient.dateOfBirth` (string | null)
    Patient date of birth. Must be strictly before today.

  - `patient.gender` (string | null)
    Patient gender.
    Enum: "female", "male", "unknown", "null"

  - `patient.user` (any)
    Patient author.

  - `patient.visibilityOption` (string | null)
    Enum: "shared", "private", "null"

  - `patient.email` (string | null)
    Patient email address.

  - `patient.phone` (string | null)
    Patient phone number.
    Example: +33757590893

  - `patient.anonymousCode` (string | null)
    Patient anonymous code.

  - `patient.recordNumber` (string | null)
    Patient record/folder number from the source software (e.g. Logosw).

  - `patient.civility` (string | null)
    How the patient is addressed: mr | mrs | dr | pr | none. Null means nobody has declared it — clients fall back to the gender-derived form. Distinct from `gender`: a patient who is a doctor is addressed "Dr" whatever their gender.
    Enum: "mr", "mrs", "dr", "pr", "none", "null"

  - `audio` (any)

  - `audio.uuid` (string)
    Audio unique identifier.

  - `audio.patient` (any)
    Audio patient.

  - `audio.createdAt` (string)
    Audio creation date.

  - `audio.updatedAt` (string)
    Audio update date.

  - `audio.archivedAt` (string | null)
    Audio archive date.

  - `audio.audioWorkflowStepV3` (string)
    Get the current audio workflow step (v3).
    Enum: "audio_recording", "transcription", "transcribed", "edition", "validated", "failed"

  - `type` (string | null)
    Document type.
    Enum: "operative_report", "referral_letter", "cone_beam_report", "patient_letter", "prescription", "initial_medical_certificate", "attendance_certificate", "contraindication_certificate", "lab_slip", "endo_report", "ortho_letter", "meeting_report", "intervention_report", "panoramic_report", "administrative_report", "free_letter", "null"

  - `pdf` (any)
    Document PDF file.

  - `pdf.uuid` (string)
    PDF unique identifier.

  - `pdf.name` (string | null)
    PDF name.

  - `pdf.size` (integer | null)
    PDF size.

  - `pdf.createdAt` (string)
    PDF creation date.

  - `pdf.updatedAt` (string)
    PDF creation date.

  - `pdf.url` (string | null)
    PDF file URL.

  - `pdf.fileName` (string | null)
    PDF file name.

  - `isAnonymized` (boolean)
    Document anonymization status.

  - `genericContactSpecialty` (string | null)
    Generic contact specialty when no specific contact is selected (free text or predefined value).

## Response 200 fields (application/ld+json):

  - `@context` (any)

  - `@context.@vocab` (string, required)

  - `@context.hydra` (string, required)
    Enum: "http://www.w3.org/ns/hydra/core#"

  - `@id` (string, required)

  - `@type` (string, required)

## Response 400:

  - `400` (unknown)
    Invalid input

## Response 400 fields (application/ld+json):

  - `@context` (any)

  - `@context.@vocab` (string, required)

  - `@context.hydra` (string, required)
    Enum: "http://www.w3.org/ns/hydra/core#"

  - `@id` (string, required)

  - `@type` (string, required)

  - `title` (string | null)
    A short, human-readable summary of the problem.

  - `detail` (string | null)
    A human-readable explanation specific to this occurrence of the problem.

  - `status` (integer | null)

  - `instance` (string | null)
    A URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced.

  - `type` (string)
    A URI reference that identifies the problem type

  - `description` (string | null)

## Response 403:

  - `403` (unknown)
    Forbidden

## Response 403 fields (application/ld+json):

  - `@context` (any)

  - `@context.@vocab` (string, required)

  - `@context.hydra` (string, required)
    Enum: "http://www.w3.org/ns/hydra/core#"

  - `@id` (string, required)

  - `@type` (string, required)

  - `title` (string | null)
    A short, human-readable summary of the problem.

  - `detail` (string | null)
    A human-readable explanation specific to this occurrence of the problem.

  - `status` (integer | null)

  - `instance` (string | null)
    A URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced.

  - `type` (string)
    A URI reference that identifies the problem type

  - `description` (string | null)

## Response 422:

  - `422` (unknown)
    An error occurred

## Response 422 fields (application/ld+json):

  - `@context` (any)

  - `@context.@vocab` (string, required)

  - `@context.hydra` (string, required)
    Enum: "http://www.w3.org/ns/hydra/core#"

  - `@id` (string, required)

  - `@type` (string, required)

  - `status` (integer)

  - `violations` (array)

  - `violations.propertyPath` (string, required)
    The property path of the violation

  - `violations.message` (string, required)
    The message associated with the violation

  - `violations.code` (string)
    The code of the violation

  - `violations.hint` (string)
    An extra hint to understand the violation

  - `violations.payload` (object)
    The serialized payload of the violation

  - `detail` (string)

  - `description` (string)

  - `type` (string)

  - `title` (string | null)

  - `instance` (string | null)