Saltar al contenido principal
POST
/
workspace
/
{workspace_id}
/
domains
/
{id}
/
set-primary
@firma-dev/sdk
import { FirmaClient } from "@firma-dev/sdk";

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

const response = await firma.emailDomains.setWorkspacePrimaryDomain({
    workspace_id: "workspace_id",
    id: "id"
});
console.log(response);
curl --request POST \
--url https://api.firma.dev/functions/v1/signing-request-api/workspace/{workspace_id}/domains/{id}/set-primary \
--header 'Authorization: <api-key>'
import requests

url = "https://api.firma.dev/functions/v1/signing-request-api/workspace/{workspace_id}/domains/{id}/set-primary"

headers = {"Authorization": "<api-key>"}

response = requests.post(url, headers=headers)

print(response.text)
const options = {method: 'POST', headers: {Authorization: '<api-key>'}};

fetch('https://api.firma.dev/functions/v1/signing-request-api/workspace/{workspace_id}/domains/{id}/set-primary', 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/workspace/{workspace_id}/domains/{id}/set-primary",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_HTTPHEADER => [
"Authorization: <api-key>"
],
]);

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

curl_close($curl);

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

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

func main() {

url := "https://api.firma.dev/functions/v1/signing-request-api/workspace/{workspace_id}/domains/{id}/set-primary"

req, _ := http.NewRequest("POST", url, nil)

req.Header.Add("Authorization", "<api-key>")

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

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

fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.post("https://api.firma.dev/functions/v1/signing-request-api/workspace/{workspace_id}/domains/{id}/set-primary")
.header("Authorization", "<api-key>")
.asString();
require 'uri'
require 'net/http'

url = URI("https://api.firma.dev/functions/v1/signing-request-api/workspace/{workspace_id}/domains/{id}/set-primary")

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = '<api-key>'

response = http.request(request)
puts response.read_body
{
  "message": "Primary domain updated",
  "domain": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "domain": "sales.acme.com",
    "verification_status": 2,
    "domain_status": 1,
    "is_primary": true
  }
}
{
"error": "Domain not verified",
"message": "Only fully verified domains can be set as primary"
}
{
"error": "Unauthorized",
"message": "Invalid API key"
}
{
"error": "Not Found",
"message": "The requested resource was not found"
}
{
"error": "Rate Limit Exceeded",
"message": "Too many requests. Please wait before retrying.",
"details": {
"retry_after": 45
}
}

Autorizaciones

Authorization
string
header
requerido

Clave API para autenticación. Usa tu clave API directamente sin ningún prefijo (por ejemplo, 'your-api-key'). El prefijo Bearer es opcional pero no obligatorio.

Parámetros de ruta

workspace_id
string<uuid>
requerido

ID del Espacio de Trabajo

id
string<uuid>
requerido

ID del dominio

Respuesta

Dominio principal actualizado correctamente

Confirmación de actualización del dominio principal

message
string
requerido
domain
object
requerido

Configuración de dominio de correo para enviar correos de Solicitud de Firma