Skip to main content
PUT
/
workspace
/
{workspace_id}
/
signer-terms
/
{language}
Create or update workspace signer terms
curl --request PUT \
  --url https://api.firma.dev/functions/v1/signing-request-api/workspace/{workspace_id}/signer-terms/{language} \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "statement_text": "<string>",
  "terms_url": "<string>"
}
'
{
  "ok": true,
  "storedHtml": "<string>",
  "changed": true
}

Authorizations

​
Authorization
string
header
required

API key for authentication. Use your API key directly without any prefix (e.g., 'your-api-key'). Bearer prefix is optional but not required.

Path Parameters

​
workspace_id
string<uuid>
required

Workspace ID

​
language
enum<string>
required

Language code

Available options:
en,
es,
it,
pt,
fr,
de,
el,
ru,
pl

Body

application/json
​
statement_text
string
required

Signer consent statement as HTML. Sanitized before storage.

​
terms_url
string<uri> | null

Optional external terms link

Response

Workspace signer terms updated successfully

​
ok
boolean
​
storedHtml
string

The sanitized HTML actually stored

​
changed
boolean

Whether sanitization altered the submitted statement