Skip to main content
PATCH
/
company
Partially update company information
curl --request PATCH \
  --url https://api.firma.dev/functions/v1/signing-request-api/company \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "company_name": "Acme Corporation Ltd",
  "website": "https://www.acme.com"
}
'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "company_name": "<string>",
  "account_owner": "<string>",
  "account_owner_email": "jsmith@example.com",
  "website": "<string>",
  "icon_url": "<string>",
  "credits": 1,
  "date_created": "2023-11-07T05:31:56Z",
  "date_changed": "2023-11-07T05:31:56Z"
}

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

Company name

Maximum string length: 255
​
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>

Company website URL

​
icon_url
string<uri>

URL to company icon/logo

Response

Company updated successfully

​
id
string<uuid>

Unique identifier for the company

​
company_name
string

Company name

Maximum string length: 255
​
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

URL to company icon/logo

​
credits
integer

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

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

Company account creation timestamp

​
date_changed
string<date-time>

Company account last update timestamp