Skip to main content
PATCH
@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.

Paramètres de chemin

id
string<uuid>
requis

Corps

application/json

Mettre à jour les propriétés du modèle

name
string

Nom du modèle

Maximum string length: 255
description
string

Description du modèle

document
string<byte>

PDF ou DOCX encodé en base64 pour remplacer le document. Les fichiers DOCX sont automatiquement convertis en PDF. Pour les documents de plus de 5 Mo, utilisez POST /documents et transmettez le document_id à la place. (mutuellement exclusif avec document_id)

document_id
string<uuid>

ID d'un document précédemment téléversé (mutuellement exclusif avec document). À obtenir en appelant d'abord POST /documents.

Exemple:

"123e4567-e89b-12d3-a456-426614174000"

expiration_hours
integer

Heures avant expiration

Plage requise: x >= 1
settings
object

Réponse

Modèle partiellement mis à jour avec succès

Résultat de la mise à jour partielle du modèle

message
string
requis
updated_fields
string[]
requis

Retourné lors de la mise à jour des propriétés

user
object

Retourné lors de la mise à jour/création d'un utilisateur