Creates a project and associates it with the account API key used.

A project represents a site, a client, or some other logical grouping of email being sent. Statistics are collected on a per-project basis and project API keys are used to send email.

Request Fields

These are passed in as arguments at the top level of the request.

Key Type Description
uid string An identifier to refer to this project on subsequent API calls.
label string A name for this project.
group string
Optional
A grouping label used to organize one or more projects into logical groups.
open_tracking boolean
Optional
Set to true to engage open tracking by default for email sent through this project. This requires introducing an invisible tracking element in all sent emails.
click_tracking boolean
Optional
Set to true to engage open tracking by default for email sent through this project. This requires introducing an invisible tracking element in all sent emails.
unsubscribe_header boolean
Optional
Set to true to to add a List-Unsubscribe header on all email sent through this project.

Request Example

{
  "api_key" : "__ACCOUNT_API__KEY__",
  "arguments": {
    "uid": "example-project",
    "label": "Example Project",
    "group": "Examples",
    "click_tracking": true
  }
}