Make a campaign’s email from a template
Copies the template’s latest document (or a starter’s, in the workspace’s default locale) into a new email of the campaign’s own (D104, D174), named after it, with no subject yet and everyone else getting the workspace’s default locale when the email has it, and saves the campaign with it. 409 `email_exists` when the campaign has one already: edit that one instead.
Copies the template’s latest document (or a starter’s, in the workspace’s default locale) into a new email of the campaign’s own (D104, D174), named after it, with no subject yet and everyone else getting the workspace’s default locale when the email has it, and saves the campaign with it. 409 email_exists when the campaign has one already: edit that one instead.
apiKey writeAuthorizationBearer <token>A workspace API key (pf_…), created under Developers → API keys.
Scope: write
id*string^(camp)_[0-9A-Za-z]{8}$idempotency-key?stringRun this write once: a retry with the same key gets the first answer (24 hours).
1 <= length <= 255application/json- body
templateId*string^(tmpl)_[0-9A-Za-z]{8}$Created
application/json- response
id*string^(tmpl|comp|brand|otype|seg|trait|camp|auto)_[0-9A-Za-z]{8}$kind*stringname*stringfolder*|The folder it’s in; null at the top level
status*string"draft""published""archived"draftVersionId*stringuuidpublishedVersionId*|uuidhasUnpublishedChanges*booleancreatedAt*stringdate-timeupdatedAt*stringdate-timearchivedAt*|date-timedraft*curl -X POST 'https://api.postforge.dev/v1/campaigns/string/email' \ -H 'Content-Type: application/json' \ -d '{ "templateId": "string"}'{ "id": "string", "kind": "string", "name": "string", "folder": { "id": "string", "name": "string" }, "status": "draft", "draftVersionId": "e7fc80a1-b65e-482e-8fcd-f6c647b4104b", "publishedVersionId": "9786f1b1-ef7e-4f6a-94c4-c8eb67e924eb", "hasUnpublishedChanges": true, "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z", "archivedAt": "2019-08-24T14:15:22Z", "draft": { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "definitionId": "string", "parentVersionId": "abf80970-9686-419e-bc00-5ddcccc33ba6", "origin": "edit", "schemaVersion": 0, "author": { "type": "user", "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "name": "string" }, "createdAt": "2019-08-24T14:15:22Z", "openedAt": "2019-08-24T14:15:22Z", "definition": { "audience": { "include": [ { "type": "list", "listId": "string" } ], "exclude": [ { "type": "list", "listId": "string" } ] }, "emailId": "string", "senderId": "6b2f63ba-164c-48c9-87b1-690cee2b3da3", "replyTo": "user@example.com", "smartSending": { "enabled": true, "hours": 1 }, "utm": { "enabled": true, "source": "string", "medium": "string", "campaign": "string", "content": "string" }, "linkParameters": [ { "name": "string", "value": { "kind": "fixed", "text": "string" } } ] } }}