Skip to main content
PUT
/
company
Update company information
curl --request PUT \
  --url https://api.firma.dev/functions/v1/signing-request-api/company \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "Acme Corporation Ltd",
  "account_owner": "Jane Smith",
  "account_owner_email": "jane@acme.com",
  "website": "https://www.acme.com"
}
'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "name": "<string>",
  "language": "en",
  "account_owner": "<string>",
  "account_owner_email": "jsmith@example.com",
  "website": "<string>",
  "icon_url": "https://ielmshcswdhuacyjlpiy.supabase.co/functions/v1/logo/company/3feb35a8-5aaf-4603-8b50-acd807176b38",
  "credits": 1,
  "created_date": "2023-11-07T05:31:56Z",
  "updated_date": "2023-11-07T05:31:56Z",
  "color_primary": "#2563eb",
  "color_primary_fg": "#ffffff",
  "color_background": "#0f172a",
  "color_foreground": "#ffffff",
  "color_card": "#22222a",
  "color_border": "#3b3b3b",
  "disable_guided_navigation": true,
  "email_local_part": "signatures"
}

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.

Body

application/json
​
name
string
required

Company name

Maximum string length: 255
​
account_owner
string
required

Name of the account owner

Maximum string length: 255
​
account_owner_email
string<email>
required

Email address of the account owner

​
website
string<uri>
required

Company website URL

​
language
enum<string>

Default language for the company

Available options:
en,
es,
it,
pt,
fr,
de,
el,
ru,
pl
​
color_primary
string | null

Primary color override (#rrggbb hex). Null to use Firma defaults.

​
color_primary_fg
string | null

Primary foreground color override. Null to use Firma defaults.

​
color_background
string | null

Background color override. Null to use Firma defaults.

​
color_foreground
string | null

Foreground/text color override. Null to use Firma defaults.

​
color_card
string | null

Card background color override. Null to use Firma defaults.

​
color_border
string | null

Border color override. Null to use Firma defaults.

​
disable_guided_navigation
boolean

Disable automatic scrolling to the next required field during signing.

Response

Company updated successfully

​
id
string<uuid>

Unique identifier for the company

​
name
string

Company name

Maximum string length: 255
​
language
enum<string>
default:en

Default language for the company

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

Name of the account owner

Maximum string length: 255
​
account_owner_email
string<email>

Email address of the account owner

​
website
string<uri> | null

Company website URL

​
icon_url
string<uri> | null

Publicly accessible URL to the company logo image. Returns null if no logo is set.

Example:

"https://ielmshcswdhuacyjlpiy.supabase.co/functions/v1/logo/company/3feb35a8-5aaf-4603-8b50-acd807176b38"

​
credits
integer
read-only

Available credits for the company (read-only, managed internally)

Required range: x >= 0
​
created_date
string<date-time>

Company account creation timestamp

​
updated_date
string<date-time>

Company account last update timestamp

​
color_primary
string | null

Primary color override (#rrggbb hex). Null uses Firma defaults.

Example:

"#2563eb"

​
color_primary_fg
string | null

Primary foreground color override. Null uses Firma defaults.

Example:

"#ffffff"

​
color_background
string | null

Background color override. Null uses Firma defaults.

Example:

"#0f172a"

​
color_foreground
string | null

Foreground/text color override. Null uses Firma defaults.

Example:

"#ffffff"

​
color_card
string | null

Card background color override. Null uses Firma defaults.

Example:

"#22222a"

​
color_border
string | null

Border color override. Null uses Firma defaults.

Example:

"#3b3b3b"

​
disable_guided_navigation
boolean

Disable automatic scrolling to the next required field during signing.

​
email_local_part
string
default:support

The local-part (before the @) of the sender email address used when sending from a custom domain. Only applies when a verified custom domain is configured. Default: 'support'.

Required string length: 1 - 64
Pattern: ^[a-z0-9]([a-z0-9._-]*[a-z0-9])?$
Example:

"signatures"