{ "opencollection": "1.0.0", "info": { "name": "API Endpoints subpackage_activities subpackage_emailTemplates API", "version": "1.0.0" }, "items": [ { "info": { "name": "subpackage_emailTemplates", "type": "folder" }, "items": [ { "info": { "name": "List email templates", "type": "http" }, "http": { "method": "GET", "url": "https://api.close.com/api/v1/email_template/", "headers": [ { "name": "Authorization", "value": "" } ], "params": [ { "name": "_limit", "value": "", "type": "query", "description": "Number of results to return." }, { "name": "_skip", "value": "", "type": "query", "description": "Number of results to skip before returning, for pagination." }, { "name": "is_archived", "value": "", "type": "query" }, { "name": "is_shared", "value": "", "type": "query" } ] }, "docs": "List email templates" }, { "info": { "name": "Create an email template", "type": "http" }, "http": { "method": "POST", "url": "https://api.close.com/api/v1/email_template/", "headers": [ { "name": "Authorization", "value": "" } ], "params": [ { "name": "_fields", "value": "", "type": "query", "description": "Comma-separated list of fields to include in the response." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create an email template" }, { "info": { "name": "Fetch an email template", "type": "http" }, "http": { "method": "GET", "url": "https://api.close.com/api/v1/email_template/:id/", "headers": [ { "name": "Authorization", "value": "" } ], "params": [ { "name": "id", "value": "", "type": "path" }, { "name": "_fields", "value": "", "type": "query", "description": "Comma-separated list of fields to include in the response." }, { "name": "include_embedded", "value": "", "type": "query", "description": "Include embedded templates used by Workflows." } ] }, "docs": "Fetch an email template" }, { "info": { "name": "Update an email template", "type": "http" }, "http": { "method": "PUT", "url": "https://api.close.com/api/v1/email_template/:id/", "headers": [ { "name": "Authorization", "value": "" } ], "params": [ { "name": "id", "value": "", "type": "path" }, { "name": "_fields", "value": "", "type": "query", "description": "Comma-separated list of fields to include in the response." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update an email template" }, { "info": { "name": "Delete an email template", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.close.com/api/v1/email_template/:id/", "headers": [ { "name": "Authorization", "value": "" } ], "params": [ { "name": "id", "value": "", "type": "path" } ] }, "docs": "Delete an email template" }, { "info": { "name": "Render an email template", "type": "http" }, "http": { "method": "GET", "url": "https://api.close.com/api/v1/email_template/:id/render/", "headers": [ { "name": "Authorization", "value": "" } ], "params": [ { "name": "id", "value": "", "type": "path" }, { "name": "email_account_id", "value": "", "type": "query" }, { "name": "bulk_object_type", "value": "", "type": "query" }, { "name": "contact_id", "value": "", "type": "query" }, { "name": "contact_preference", "value": "", "type": "query" }, { "name": "entry", "value": "", "type": "query" }, { "name": "lead_id", "value": "", "type": "query" }, { "name": "limit", "value": "", "type": "query" }, { "name": "query", "value": "", "type": "query" }, { "name": "results_limit", "value": "", "type": "query" }, { "name": "s_query", "value": "", "type": "query" }, { "name": "sender", "value": "", "type": "query" }, { "name": "sort", "value": "", "type": "query" }, { "name": "mode", "value": "", "type": "query" } ] }, "docs": "Render an email template for the given lead/contact using the current user context.\n\nAccepts two forms of usage:\n\n- Single lead/contact:\n - `lead_id` and `contact_id` is supplied (both required)\n- Preview results from a search query\n - `query` (required) contains a search query\n - `entry` (optional, ranges from 0 to 99) specifies the index of the lead/contact that should be rendered.\n - `mode` (optional), which can have a value of:\n - `lead` (default), the first contact of the lead with " } ] } ], "bundled": true }