API Documentation
  • Introduction
  • Settings
  • Sending Profiles
  • Templates
  • Landing Pages
  • Users & Groups
  • Campaigns
  • User Management
Powered by GitBook
On this page
  • Get Templates
  • Get Template
  • Create Template
  • Modify Template
  • Delete Template
  • Import Template

Templates

A "Template" is the content of the emails that are sent to targets. They can be imported from an existing email, or created from scratch.

Additionally, templates can contain tracking images so that gophish knows when the user opens the email.

Templates have the following structure:

{
  id            : int64
  name          : string
  subject       : string
  text          : string
  html          : string
  modified_date : string(datetime)
  attachments   : list(attachment)
}

Templates support sending attachments. Attachments have the following structure:

  content: string
  type   : string
  name   : string

Note: The content field in an attachment is expected to be base64 encoded.

Get Templates

GET https://localhost:3333/api/templates

Returns a list of templates.

Headers

Name
Type
Description

Authorization

string

A valid API key

[
  {
    "id" : 1,
    "name" : "Password Reset Template",
    "subject" : "{{.FirstName}}, please reset your password.",
    "text" : "Please reset your password here: {{.URL}}",
    "html" : "<html><head></head><body>Please reset your password <a href\"{{.URL}}\">here</a></body></html>",
    "modified_date" : "2016-11-21T18:30:11.1477736-06:00",
    "attachments" : [],
  }
]

Get Template

GET https://localhost:3333/api/templates/:id

Returns a template with the provided ID.Returns a 404: Not Found error if the specified template doesn't exist.

Path Parameters

Name
Type
Description

id

integer

The template ID

Headers

Name
Type
Description

Authorization

string

A valid API key

{
    "id" : 1,
    "name" : "Password Reset Template",
    "subject" : "{{.FirstName}}, please reset your password.",
    "text" : "Please reset your password here: {{.URL}}",
    "html" : "<html><head></head><body>Please reset your password <a href\"{{.URL}}\">here</a></body></html>",
    "modified_date" : "2016-11-21T18:30:11.1477736-06:00",
    "attachments" : [],
}
{
  "message": "Template not found",
  "success": false,
  "data": null
}

Create Template

POST https://localhost:3333/api/templates/

Creates a new template from the provided JSON request body.

Headers

Name
Type
Description

Authorization

string

A valid API key

Request Body

Name
Type
Description

Payload

object

The request body should be a JSON representation of a template. See the schema at the top of this page for the template format.

{
    "id" : 1,
    "name" : "Password Reset Template",
    "subject" : "{{.FirstName}}, please reset your password.",
    "text" : "Please reset your password here: {{.URL}}",
    "html" : "<html><head></head><body>Please reset your password <a href\"{{.URL}}\">here</a></body></html>",
    "modified_date" : "2016-11-21T18:30:11.1477736-06:00",
    "attachments" : [],
}
{
  "message": "Need to specify at least plaintext or HTML content",
  "success": false,
  "data": null
}

This method expects the template to be provided in JSON format. You must provide a template name and the text and/or html for the template.

Importing an Existing Email

What better way to make pixel-perfect emails than by importing an existing email you already have in your inbox?

To add tracking, make sure you specify a {{.Tracker}} in the html field. The UI adds this automatically, but it needs to be specified if you're using the API.

This method returns the JSON representation of the template that was created.

Modify Template

PUT https://localhost:3333/api/templates/:id

Modifies an existing template.

Path Parameters

Name
Type
Description

id

integer

The template ID to modify

Headers

Name
Type
Description

Authorization

string

A valid API key

Request Body

Name
Type
Description

Payload

object

The JSON representation of the template you wish to modify. The entire template must be provided, not just the fields you wish to update.

This method expects the template to be provided in JSON format. You must provide a full template, not just the fields you want to update.

This method returns the JSON representation of the template that was modified.

Delete Template

DELETE https://localhost:3333/api/templates/:id

Deletes a template by ID.

Path Parameters

Name
Type
Description

string

{
  "message": "Template deleted successfully!",
  "success": true,
  "data": null
}
{
  "message": "Template not found",
  "success": false,
  "data": null
}

Returns a 404 error if the specified template isn't found.

This method returns a status message indicating the template was deleted successfully.

Import Template

POST https://localhost:3333/api/import/email

Imports an email as a template.

Headers

Name
Type
Description

Authorization

string

A valid API key

Request Body

Name
Type
Description

convert_links

boolean

Whether or not to convert the links within the email to automatically.

content

string

The original email content in RFC 2045 format, including the original headers.

{
  "text": "Email text",
  "html": "Email HTML",
  "subject": "Email subject"
}

Gophish provides the ability to parse an existing email to be used as a template. This makes it easy to repurpose legitimate emails for your phishing assessments.

The request body for this endpoint is a JSON request in the form of:

{
    content:       string
    convert_links: boolean
}

By setting the convert_links attribute to true, Gophish will automatically change all the links in the email to {{.URL}}.

PreviousSending ProfilesNextLanding Pages

Last updated 5 years ago

Using the endpoint, you can take a raw email and parse it as a valid Gophish template.

This endpoint expects the raw email content in , including the original headers. Usually, this is found using the "Show Original" feature of email clients.

Note: This method doesn't fully import the email as a template. Instead, it parses the email, returning a response that can be used with the "" endpoint.

RFC 2045 format
Import Email
Create Template