Lead Follow-up Email Templates

Get Email Templates

get

Query parameters

company_idintegerRequired

The ID of the company whose email templates will be retrieved

Responses

200

Successful retrieval of email templates.

application/json

get

/lead/email/templates

HTTPcURLJavaScriptPython

GET /lead/email/templates?company_id=1 HTTP/1.1
Host: api.taag.co
Accept: */*

200

Successful retrieval of email templates.

{
  "status": "success",
  "templates": [
    {
      "id": 1,
      "name": "text",
      "subject": "text",
      "body": "text",
      "cc": "text",
      "bcc": "text",
      "primary": true
    }
  ]
}

Create an Email Template

post

Body

application/json

company_idintegerOptional

The ID of the company associated with the email template

namestringRequired

The name of the email template

subjectstringRequired

The subject of the email template

bodystringRequired

The body content of the email template

ccstringOptional

Comma-separated list of CC email addresses (optional)

bccstringOptional

Comma-separated list of BCC email addresses (optional)

primarybooleanOptional

Whether this email template is the primary template (optional)

Default: false

Responses

200

Successful creation of the email template.

application/json

post

/lead/email/templates

HTTPcURLJavaScriptPython

POST /lead/email/templates HTTP/1.1
Host: api.taag.co
Content-Type: application/json
Accept: */*
Content-Length: 102

{
  "company_id": 1,
  "name": "text",
  "subject": "text",
  "body": "text",
  "cc": "text",
  "bcc": "text",
  "primary": false
}

200

Successful creation of the email template.

{
  "status": "success"
}

Update an Email Template

put

Body

application/json

company_idintegerOptional

The ID of the company associated with the email template

template_idintegerRequired

The ID of the email template to update

namestringOptional

The name of the email template

subjectstringOptional

The subject of the email template

bodystringOptional

The body content of the email template

ccstringOptional

Comma-separated list of CC email addresses (optional)

bccstringOptional

Comma-separated list of BCC email addresses (optional)

Responses

200

Successful update of the email template.

application/json

put

/lead/email/templates

HTTPcURLJavaScriptPython

PUT /lead/email/templates HTTP/1.1
Host: api.taag.co
Content-Type: application/json
Accept: */*
Content-Length: 102

{
  "company_id": 1,
  "template_id": 1,
  "name": "text",
  "subject": "text",
  "body": "text",
  "cc": "text",
  "bcc": "text"
}

200

Successful update of the email template.

{
  "status": "success"
}

Delete an Email Template

delete

Body

application/json

company_idintegerOptional

The ID of the company associated with the email template

template_idintegerRequired

The ID of the email template to delete

Responses

200

Successful deletion of the email template.

application/json

delete

/lead/email/templates

HTTPcURLJavaScriptPython

DELETE /lead/email/templates HTTP/1.1
Host: api.taag.co
Content-Type: application/json
Accept: */*
Content-Length: 32

{
  "company_id": 1,
  "template_id": 1
}

200

Successful deletion of the email template.

{
  "status": "success"
}

Get a Single Email Template

get

Query parameters

company_idintegerRequired

The ID of the company whose email template will be retrieved

Responses

200

Successful retrieval of the email template.

application/json

get

/lead/email/template

HTTPcURLJavaScriptPython

GET /lead/email/template?company_id=1 HTTP/1.1
Host: api.taag.co
Accept: */*

200

Successful retrieval of the email template.

{
  "status": "success",
  "template": {
    "id": 1,
    "name": "text",
    "subject": "text",
    "body": "text",
    "cc": "text",
    "bcc": "text",
    "primary": true
  }
}

Set Primary Email Template

put

Body

application/json

company_idintegerOptional

The ID of the company associated with the email template

template_idintegerRequired

The ID of the email template to set as primary

Responses

200

Successful setting of the primary email template.

application/json

put

/lead/email/templates/primary

HTTPcURLJavaScriptPython

PUT /lead/email/templates/primary HTTP/1.1
Host: api.taag.co
Content-Type: application/json
Accept: */*
Content-Length: 32

{
  "company_id": 1,
  "template_id": 1
}

200

Successful setting of the primary email template.

{
  "status": "success"
}