Saltar al contenido principal
POST

Enviar proforma por email

Scope:sales:proforms.write
https://api.holded.com/api/v2/proformas/{proformaId}/send

Envía la factura proforma por email al contacto usando la plantilla configurada.

Parámetros

Parámetros de ruta

proformaIdstringobligatorio

ID de la factura proforma (ObjectId hexadecimal de 24 caracteres)

Cuerpo de la petición

object
emails[]string[]required

Lista de direcciones de email destinatarias

subjectstring | nulloptional

Asunto personalizado del email

messagestring | nulloptional

Cuerpo personalizado del email

mail_template_idstring | nulloptional

Identificador de la plantilla de email a usar

cc[]string[] | nulloptional

Lista de direcciones de email en copia (CC)

bcc[]string[] | nulloptional

Lista de direcciones de email en copia oculta (CCO)

Petición

python
import requests

url = "https://api.holded.com/api/v2/proformas/{proformaId}/send"
headers = {
    "Authorization": "Bearer YOUR_API_KEY",
    "Accept": "application/json",
}

payload = {
    "emails": [
        "string"
    ],
    "subject": "string",
    "message": "string",
    "mail_template_id": "string",
    "cc": [
        "string"
    ],
    "bcc": [
        "string"
    ]
}
response = requests.post(url, headers=headers, json=payload)
print(response.json())

Respuestas

Respuestas exitosas

200Proforma enviada

Respuestas de error

400Solicitud incorrectaapplication/json
401API key inválida o no proporcionadaapplication/json
403Permisos insuficientesapplication/json
404Proforma no encontradaapplication/json
429Límite de solicitudes excedidoapplication/json