CLclose
email_templates

Render an email template

Changed on

Render an email template for the given lead/contact using the current user context.

Accepts two forms of usage:

  • Single lead/contact:
    • lead_id and contact_id is supplied (both required)
  • Preview results from a search query
    • query (required) contains a search query
    • entry (optional, ranges from 0 to 99) specifies the index of the lead/contact that should be rendered.
    • mode (optional), which can have a value of:
      • lead (default), the first contact of the lead with the index given by entry will be rendered (excluding leads that have no email addresses).
      • contact, then entry refers to the index of the contact (excluding contacts that have no emails). Will return an empty dict if there are no more entries.
get/email_template/{id}/render/

Request

  • Base URL
    https://api.close.com/api/v1
  • URL
    https://api.close.com/api/v1/email_template/{id}/render/
  • Auth
    • HTTP basic
    • or OAuth 2
      Authorization code: https://app.close.com/oauth2/authorize/
      Token URL: https://api.close.com/oauth2/token/

Path parameters

idstring required

Query parameters

email_account_idstring
bulk_object_type'lead' | 'contact'
contact_idstring
contact_preference'lead' | 'contact' | 'all'
entryinteger
lead_idstring
limitinteger
querystring
results_limitinteger
s_querystring
senderstring email
direction'asc' | 'desc' required
fieldstring required
mode'lead' | 'contact'

Response

Successful response

Changes

  • 2ff98656cc2aRevision changes
    • info

      added the media type application/json for the response with the status

    • info

      added the media type application/json for the response with the status

    • info

      added the media type application/json for the response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status