Passer au contenu principal
PUT
/
company
/
settings
@firma-dev/sdk
import { FirmaClient } from "@firma-dev/sdk";

const firma = new FirmaClient({ apiKey: "YOUR_API_KEY" });

const response = await firma.company.updateCompanySettings();
console.log(response);
curl --request PUT \
  --url https://api.firma.dev/functions/v1/signing-request-api/company/settings \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "default_expiration_hours": 2,
  "require_terms_acceptance": true,
  "show_custom_branding_only": true,
  "require_otp_verification": true,
  "allow_presigning_download": true,
  "disable_guided_navigation": true,
  "show_signature_frame": true,
  "show_partial_watermark": true,
  "email_local_part": "<string>",
  "color_primary": "<string>",
  "color_primary_fg": "<string>",
  "color_background": "<string>",
  "color_foreground": "<string>",
  "color_card": "<string>",
  "color_border": "<string>",
  "color_accent": "<string>",
  "color_accent_fg": "<string>",
  "color_canvas": "<string>",
  "color_muted": "<string>",
  "color_muted_fg": "<string>",
  "show_qr_code": true
}
'
import requests

url = "https://api.firma.dev/functions/v1/signing-request-api/company/settings"

payload = {
    "default_expiration_hours": 2,
    "require_terms_acceptance": True,
    "show_custom_branding_only": True,
    "require_otp_verification": True,
    "allow_presigning_download": True,
    "disable_guided_navigation": True,
    "show_signature_frame": True,
    "show_partial_watermark": True,
    "email_local_part": "<string>",
    "color_primary": "<string>",
    "color_primary_fg": "<string>",
    "color_background": "<string>",
    "color_foreground": "<string>",
    "color_card": "<string>",
    "color_border": "<string>",
    "color_accent": "<string>",
    "color_accent_fg": "<string>",
    "color_canvas": "<string>",
    "color_muted": "<string>",
    "color_muted_fg": "<string>",
    "show_qr_code": True
}
headers = {
    "Authorization": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.put(url, json=payload, headers=headers)

print(response.text)
const options = {
  method: 'PUT',
  headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    default_expiration_hours: 2,
    require_terms_acceptance: true,
    show_custom_branding_only: true,
    require_otp_verification: true,
    allow_presigning_download: true,
    disable_guided_navigation: true,
    show_signature_frame: true,
    show_partial_watermark: true,
    email_local_part: '<string>',
    color_primary: '<string>',
    color_primary_fg: '<string>',
    color_background: '<string>',
    color_foreground: '<string>',
    color_card: '<string>',
    color_border: '<string>',
    color_accent: '<string>',
    color_accent_fg: '<string>',
    color_canvas: '<string>',
    color_muted: '<string>',
    color_muted_fg: '<string>',
    show_qr_code: true
  })
};

fetch('https://api.firma.dev/functions/v1/signing-request-api/company/settings', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.firma.dev/functions/v1/signing-request-api/company/settings",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PUT",
  CURLOPT_POSTFIELDS => json_encode([
    'default_expiration_hours' => 2,
    'require_terms_acceptance' => true,
    'show_custom_branding_only' => true,
    'require_otp_verification' => true,
    'allow_presigning_download' => true,
    'disable_guided_navigation' => true,
    'show_signature_frame' => true,
    'show_partial_watermark' => true,
    'email_local_part' => '<string>',
    'color_primary' => '<string>',
    'color_primary_fg' => '<string>',
    'color_background' => '<string>',
    'color_foreground' => '<string>',
    'color_card' => '<string>',
    'color_border' => '<string>',
    'color_accent' => '<string>',
    'color_accent_fg' => '<string>',
    'color_canvas' => '<string>',
    'color_muted' => '<string>',
    'color_muted_fg' => '<string>',
    'show_qr_code' => true
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: <api-key>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}
package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.firma.dev/functions/v1/signing-request-api/company/settings"

	payload := strings.NewReader("{\n  \"default_expiration_hours\": 2,\n  \"require_terms_acceptance\": true,\n  \"show_custom_branding_only\": true,\n  \"require_otp_verification\": true,\n  \"allow_presigning_download\": true,\n  \"disable_guided_navigation\": true,\n  \"show_signature_frame\": true,\n  \"show_partial_watermark\": true,\n  \"email_local_part\": \"<string>\",\n  \"color_primary\": \"<string>\",\n  \"color_primary_fg\": \"<string>\",\n  \"color_background\": \"<string>\",\n  \"color_foreground\": \"<string>\",\n  \"color_card\": \"<string>\",\n  \"color_border\": \"<string>\",\n  \"color_accent\": \"<string>\",\n  \"color_accent_fg\": \"<string>\",\n  \"color_canvas\": \"<string>\",\n  \"color_muted\": \"<string>\",\n  \"color_muted_fg\": \"<string>\",\n  \"show_qr_code\": true\n}")

	req, _ := http.NewRequest("PUT", url, payload)

	req.Header.Add("Authorization", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.put("https://api.firma.dev/functions/v1/signing-request-api/company/settings")
  .header("Authorization", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"default_expiration_hours\": 2,\n  \"require_terms_acceptance\": true,\n  \"show_custom_branding_only\": true,\n  \"require_otp_verification\": true,\n  \"allow_presigning_download\": true,\n  \"disable_guided_navigation\": true,\n  \"show_signature_frame\": true,\n  \"show_partial_watermark\": true,\n  \"email_local_part\": \"<string>\",\n  \"color_primary\": \"<string>\",\n  \"color_primary_fg\": \"<string>\",\n  \"color_background\": \"<string>\",\n  \"color_foreground\": \"<string>\",\n  \"color_card\": \"<string>\",\n  \"color_border\": \"<string>\",\n  \"color_accent\": \"<string>\",\n  \"color_accent_fg\": \"<string>\",\n  \"color_canvas\": \"<string>\",\n  \"color_muted\": \"<string>\",\n  \"color_muted_fg\": \"<string>\",\n  \"show_qr_code\": true\n}")
  .asString();
require 'uri'
require 'net/http'

url = URI("https://api.firma.dev/functions/v1/signing-request-api/company/settings")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Put.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"default_expiration_hours\": 2,\n  \"require_terms_acceptance\": true,\n  \"show_custom_branding_only\": true,\n  \"require_otp_verification\": true,\n  \"allow_presigning_download\": true,\n  \"disable_guided_navigation\": true,\n  \"show_signature_frame\": true,\n  \"show_partial_watermark\": true,\n  \"email_local_part\": \"<string>\",\n  \"color_primary\": \"<string>\",\n  \"color_primary_fg\": \"<string>\",\n  \"color_background\": \"<string>\",\n  \"color_foreground\": \"<string>\",\n  \"color_card\": \"<string>\",\n  \"color_border\": \"<string>\",\n  \"color_accent\": \"<string>\",\n  \"color_accent_fg\": \"<string>\",\n  \"color_canvas\": \"<string>\",\n  \"color_muted\": \"<string>\",\n  \"color_muted_fg\": \"<string>\",\n  \"show_qr_code\": true\n}"

response = http.request(request)
puts response.read_body
{
  "default_expiration_hours": 2,
  "require_terms_acceptance": true,
  "show_custom_branding_only": true,
  "require_otp_verification": true,
  "allow_presigning_download": true,
  "disable_guided_navigation": true,
  "show_signature_frame": true,
  "show_partial_watermark": true,
  "email_local_part": "<string>",
  "color_primary": "<string>",
  "color_primary_fg": "<string>",
  "color_background": "<string>",
  "color_foreground": "<string>",
  "color_card": "<string>",
  "color_border": "<string>",
  "color_accent": "<string>",
  "color_accent_fg": "<string>",
  "color_canvas": "<string>",
  "color_muted": "<string>",
  "color_muted_fg": "<string>",
  "show_qr_code": true
}
{
  "error": "Validation Error",
  "message": "Invalid input data",
  "details": {
    "name": "Name is required",
    "email": "Invalid email format"
  }
}
{
  "error": "Unauthorized",
  "message": "Invalid API key"
}
{
  "error": "Rate Limit Exceeded",
  "message": "Too many requests. Please wait before retrying.",
  "details": {
    "retry_after": 45
  }
}

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.

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.