Skip to main content
PUT
@firma-dev/sdk

Autorisations

Authorization
string
header
requis

Clé API pour l'authentification. Utilisez votre clé API directement sans préfixe (par exemple, 'your-api-key'). Le préfixe Bearer est optionnel mais pas obligatoire.

Corps

application/json
default_expiration_hours
integer

Expiration par défaut de la demande de signature en heures

Plage requise: x >= 1
require_terms_acceptance
boolean

Indique si les signataires doivent accepter les conditions avant de signer

show_custom_branding_only
boolean
require_otp_verification
boolean
allow_presigning_download
boolean
disable_guided_navigation
boolean
show_signature_frame
boolean
show_partial_watermark
boolean
email_local_part
string
color_primary
string | null
Pattern: ^#[0-9A-Fa-f]{6}$
color_primary_fg
string | null
Pattern: ^#[0-9A-Fa-f]{6}$
color_background
string | null
Pattern: ^#[0-9A-Fa-f]{6}$
color_foreground
string | null
Pattern: ^#[0-9A-Fa-f]{6}$
color_card
string | null
Pattern: ^#[0-9A-Fa-f]{6}$
color_border
string | null
Pattern: ^#[0-9A-Fa-f]{6}$
color_accent
string | null
Pattern: ^#[0-9A-Fa-f]{6}$
color_accent_fg
string | null
Pattern: ^#[0-9A-Fa-f]{6}$
color_canvas
string | null
Pattern: ^#[0-9A-Fa-f]{6}$
color_muted
string | null
Pattern: ^#[0-9A-Fa-f]{6}$
color_muted_fg
string | null
Pattern: ^#[0-9A-Fa-f]{6}$
show_qr_code
boolean | null

Afficher un QR code sur la page de signature qui permet aux signataires de continuer sur leur téléphone. C'est le paramètre par défaut au niveau de l'entreprise ; les espaces de travail, modèles et demandes de signature peuvent le remplacer.

completion_title
string | null

Titre par défaut au niveau de l'entreprise pour la page de finalisation affichée après la signature. Null (ou une chaîne vide) supprime la valeur par défaut d'entreprise.

Maximum string length: 200
completion_message
string | null

Texte principal par défaut au niveau de l'entreprise pour la page de finalisation affichée après la signature. Null (ou une chaîne vide) supprime la valeur par défaut d'entreprise.

Maximum string length: 1000
completion_redirect_url
string<uri> | null

URL par défaut au niveau de l'entreprise vers laquelle le signataire est redirigé depuis la page de finalisation. Doit utiliser https://. Null (ou une chaîne vide) supprime la valeur par défaut d'entreprise.

Maximum string length: 2000
Pattern: ^https://
completion_redirect_delay
integer | null

Nombre de secondes par défaut au niveau de l'entreprise pendant lesquelles la page de finalisation attend avant de rediriger (0 redirige immédiatement). Null supprime la valeur par défaut d'entreprise.

Plage requise: 0 <= x <= 30

Réponse

Paramètres de l'entreprise mis à jour avec succès

default_expiration_hours
integer
requis
Plage requise: x >= 1
require_terms_acceptance
boolean
show_custom_branding_only
boolean
require_otp_verification
boolean
allow_presigning_download
boolean
disable_guided_navigation
boolean
show_signature_frame
boolean
show_partial_watermark
boolean
email_local_part
string
color_primary
string | null
color_primary_fg
string | null
color_background
string | null
color_foreground
string | null
color_card
string | null
color_border
string | null
color_accent
string | null
color_accent_fg
string | null
color_canvas
string | null
color_muted
string | null
color_muted_fg
string | null
show_qr_code
boolean | null

Afficher un QR code sur la page de signature permettant aux signataires de continuer sur leur téléphone. Il s'agit de la valeur par défaut au niveau de l'entreprise ; les espaces de travail, modèles et demandes de signature peuvent la remplacer.

completion_title
string | null

Titre par défaut au niveau de l'entreprise pour la page de finalisation affichée après la signature. Les espaces de travail, modèles et demandes de signature peuvent le surcharger. Null signifie l'absence de valeur par défaut d'entreprise ; le titre traduit intégré est alors utilisé.

Maximum string length: 200
completion_message
string | null

Texte principal par défaut au niveau de l'entreprise pour la page de finalisation affichée après la signature. Les espaces de travail, modèles et demandes de signature peuvent le surcharger. Null signifie l'absence de valeur par défaut d'entreprise ; le message traduit intégré est alors utilisé.

Maximum string length: 1000
completion_redirect_url
string<uri> | null

URL par défaut au niveau de l'entreprise vers laquelle le signataire est redirigé depuis la page de finalisation. Doit utiliser https://. Les espaces de travail, modèles et demandes de signature peuvent la surcharger. Null signifie aucune redirection sauf si un niveau inférieur en définit une.

Maximum string length: 2000
Pattern: ^https://
completion_redirect_delay
integer | null

Nombre de secondes par défaut au niveau de l'entreprise pendant lesquelles la page de finalisation attend avant de rediriger (0 redirige immédiatement). S'applique uniquement lorsqu'une URL de redirection est résolue ; la page utilise 5 secondes lorsqu'aucun niveau ne définit de délai.

Plage requise: 0 <= x <= 30