Create a one-off request draft from a template

posthttps://api.expiryedge.com/v1/createCollectionRequestDraft
editor or admin60/minJede Methode
Anfrage
curl -X POST 'https://api.expiryedge.com/v1/createCollectionRequestDraft' \
  -H "Authorization: Bearer $EXPIRYEDGE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "templateId": "tpl_W9onboard"
}'
Antwort
{
  "message": "Request draft created",
  "template": {
    "id": "tpl_D7draft",
    "organization_id": "org_northwind",
    "name": "New client onboarding - Northwind Dental",
    "description": "Documents we need before the first engagement.",
    "pages": [
      {
        "id": "p_company",
        "title": "Company details",
        "order": 0,
        "description_html": "<p>Tell us about your practice.</p>",
        "sections": [
          {
            "id": "s_basics",
            "title": "Basics",
            "order": 0,
            "description_html": "",
            "fields": [
              {
                "id": "fld_company_name",
                "type": "short_text",
                "label": "Legal company name",
                "required": true,
                "help_text": ""
              },
              {
                "id": "fld_entity",
                "type": "dropdown",
                "label": "Entity type",
                "required": true,
                "help_text": "",
                "options": [
                  "LLC",
                  "Corporation",
                  "Sole proprietor"
                ]
              },
              {
                "id": "fld_insurance",
                "type": "file_upload",
                "label": "Liability insurance certificate",
                "required": true,
                "help_text": "PDF or image, current policy year.",
                "allowed_types": [
                  "pdf",
                  "jpg",
                  "png"
                ],
                "max_size_bytes": 26214400,
                "reference_file": {
                  "storage_path": "organizations/org_northwind/collection-templates/tpl_W9onboard/fields/fld_insurance/reference-1b2c-sample.pdf",
                  "original_filename": "sample-certificate.pdf",
                  "content_type": "application/pdf",
                  "size_bytes": 120331
                }
              }
            ]
          }
        ]
      }
    ],
    "intro_email": {
      "body_html": "<p>Hi, please upload the documents below by Friday.</p>"
    },
    "schema_version": 2,
    "status": "request_draft",
    "created_by": "u_71bXq",
    "created_by_name": "Priya Shah",
    "created_at": "2026-09-27T14:05:00.000Z",
    "updated_at": "2026-09-27T14:05:00.000Z"
  }
}

Copies a template into a request_draft template you can edit for a single send (does not count against the template limit; reference files are not copied). Sending it with createCollectionRequests marks it request_sent. The handler does not check the HTTP method.

Body-Parameter

application/json
  • templateIdstringerforderlich

Rückgabe

201
Draft created.
  • messagestringerforderlich
  • templateobjecterforderlich
    A Document Collection template (form definition).

Fehler

400
The request is missing required fields or contains invalid values.
401
Missing, expired or invalid bearer token.
403
Your role does not allow this, or the record belongs to another organization ({"error": "Access denied"}).
404
The record does not exist or is not in your organization.
429
Too many requests for this endpoint from your IP. Wait Retry-After seconds.