Skip to main content
POST
/
workspace
/
{workspace_id}
/
domains
Add workspace domain
curl --request POST \
  --url https://api.firma.dev/functions/v1/signing-request-api/workspace/{workspace_id}/domains \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "domain": "sales.acme.com"
}
'
{
  "domain": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "domain": "sales.acme.com",
    "verification_status": 0,
    "domain_status": 0,
    "is_primary": false,
    "verification_token": "firma-verify=abc123xyz",
    "date_created": "2024-01-15T10:30:00Z",
    "date_changed": "2024-01-15T10:30:00Z"
  },
  "verification_instructions": {
    "record_type": "TXT",
    "record_name": "_firma-verification.sales.acme.com",
    "record_value": "firma-verify=abc123xyz",
    "next_step": "Add this TXT record to your DNS, then call POST /workspace/{workspace_id}/domains/{id}/verify-ownership"
  }
}

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

Body

application/json
​
domain
string
required

Domain name to add (e.g., 'example.com'). Must be a valid domain format.

Example:

"sales.acme.com"

Response

Domain created successfully. Add the verification TXT record to your DNS.

​
domain
object

Email domain configuration for sending signing request emails

​
verification_instructions
object