Page tree
Skip to end of metadata
Go to start of metadata

 

Get /mailshots

Provides the entire list of  mailshots

Returns the entire list of  mailshots.

A Mailshot is an email template specifically configured to be sent to a group of users for further keeping track of the statistics of email opening and links followed.

Request URL

https://{client_id}.salesseek.net/api/mailshots

Response Type

Response content type: JSON Array[mailshots]

ModelExample of Response

Array[mailshots]

Mailshot  {

bcc(Array[User]): list of SalesSeek Users to include in Blind Carbon Copy,

cc(Array[User]): list of SalesSeek Users to include in Carbon Copy,

content_file(Content_file): file to be sent as the body of the mailshot, is located on the Content > Library and could be any format,

content_file_id(string): id of the content file to be sent through the mailshot,

from(User): Info of the SalesSeek User who will be the sender of this mailshot

id(String): Id of the current mailshot,

last_sent(timestamp): Latest date this mailshot was sent, formatted as YYYY-MM-ddThh_mm_ss.msecs,

name(string): Mailshot name

owner(User): SalesSeek user who owns this mailshot,

owner_id(string): id of the SalesSeek user who owns this mailshot,

sent_history(Array[Mailshot_Sent]): History of all the times this mailshot was sent on the past, including statistics

subject(string): Subject for this email

to(Group): The group with all the recipients for this mailshot: SalesSeek suggests to configure one Static Group in case further validations over the specific individuals who received this email campaign

type(string): "mailshots"

}

Content_file(JSON): {

content(string): Entire file content, should be an HTML but may be plain text or any other file available from the Content > Library,

description(string): From the Content > Library, a brief description of this file,

ext(string): file extension (eg: .html),

has_thumb(string): complete URL path to the thumbnail file,

id (string): unique identifier for this file,

last_modified_by_name(string): name of the last SalesSeek User who modified it,

modified(timestamp): latest modified date, formatted as YYYY-MM-ddThh_mm_ss.msecs,

name(string): Alias which can be used as a unique identifier for the file,

owner(User): Reference to the user who owns this directory,

parent(Directory): Directory holding the current file,

parent_id(string): id of the parent directory for this file,

short_id(string): short identifier which can be alternatively use as an id for this file

}

Folder(JSON): {

description(string): Description of the current directory,

id(sting): unique id of this directory,

last_modified_by_name(string): Name of the SalesSeek user who latest modified the directory,

modified(timestamp): latest modified date, formatted as YYYY-MM-ddThh_mm_ss.msecs,

name(string): Directory name which may be used as an alias,

owner(User): Reference to the user who owns this directory,

short_id(string): short identifier which can be alternatively use as an id for this directory

}

User {

id (string): unique identifier for the User,

name (string): name to be shown,

type (string): "user"

email_address (string): unique email address identifying this user,

}

Mailshot_Sent(JSON) {

id(string): unique identifier for this send(shot) record

owner(User): information about the SalesSeek user who sent this mailshot at this shot,

owner_id(string): Unique ID of the SalesSeek who sent this mailshot at this shot,

sent(timestamp): sent date, formatted as YYYY-MM-ddThh_mm_ss.msecs,

stats(Mailshot_stats): summary with this mailshot provided by Mandril

}

 

Mailshot_Stats(JSON) {

 clicks(int): amount of times one of the links inside the mailshot was clicked by one recipient,

complaints(int): amount of times a recipient has complained about this sent,

hard_bounces(int): amount of times this mailshot was bounced by some incorrect criteria,

opens(int): amount of times the email of this mailshot was opened, regardless of the recipient,

rejects(int): amount of recipients who had rejected this email,

sent(int): amount recipients who this mailshot was sent to,

unique_clicks(int): amount of unique recipients clicking one of the embedded links embedded of this email,

unique_opens(int): amount of unique recipients opening this email

}


[
  0:{
    bcc: [
      0: {
        email_address: "helper@mycompany.net"
        id: "9e59ba"
        name: "John Davis"
        type: "users"
      }
    ]
    cc: []
    content_file: {
      content: "<!DOCTYPE html PUBLIC...</body></html>",
      description: ""
      ext: ".html"
      has_thumb: null
      id: "174e99cb"
      last_modified_by_name: "John Davis"
      modified: "2014-01-14T12:04:41.941322"
      name: "welcomev_email.html"
      owner: {
        id:913b7328cb,
        name:John Davis
      }
      parent: {
        description: "A Folder for automated mailshots"
        id: "12e572e46b"
        last_modified_by_name: "John Davis"
        modified: "2014-01-14T12:04:17.937656"
        name: "Automations"
      }
      parent_id: "47087669"
      short_id: "d38f7"
    }
    content_file_id: "d38f79cb"
    from: {
      email_address: "hello@mycompany.net"
      id: "fc190f6b94"
      name: "John Davis"
      type: "users"
    }
    id: "486f5a5430ec"
    last_sent: "2014-01-17T13:25:07.305488"
    name: "Welcome Mailshot"
    owner: {
      email_address: "john@mycompany.com"
      id: "4918328cb"
      is_admin: true
      name: "John Davis"
    }
    type: "users"
    owner_id: "3b7328cb"
    sent_history: [
      0: {
        id: "a6bdbfdd"
        owner: {
          email_address: "john@mycompany.com"
          id: "4328cb"
          is_admin: true
          name: "John Davis"
          preferences: {
            default_dashboard: "team"
          }
          type: "users"
        }
        owner_id: "4917328cb"
        sent: "2014-01-17T13:25:07.305488"
        stats: {
          clicks: 0
          complaints: 0
          hard_bounces: 0
          opens: 2
          rejects: 0
          sent: 2
          unique_clicks: 0
          unique_opens: 1
        }
      },
      1: {...}
    ]
    subject: "My Company Welcome Email"
    to: {
      comments: ""
      cost: 0
      cost_basis: "total"
      id: "a9f34523"
      name: "Welcome Mailshot"
      short_id: "a9f3f4523"
      type: "smart_groups"
    }
    type: "mailshots"
  },
  1: {...}
]

 

Parameters

ParameterIn / OutRequiredDescriptionParameter TypeData Type
Records-RowsOut-

Amount of records returned in this search

int
Records-StartOut-The index of the first row on the response (in case there are more results, paginated)int
Records-TotalOut-Total amount of records (even if are not in this search result)int
rowsInNThe maximum amount of element to be requestedint
startInNThe element number to start to retrieve the data (0 for the first position)int

 


 

 

POST  mailshot 

Creates a new  mailshot 

Creates a new  mailshot  and Returns the resulting  mailshot 

 

Request URL

https://{client_id}.salesseek.net/api/mailshot

Request Body
{
    bcc: [
      0: {
        email_address: "helper@mycompany.net"
        id: "9e59ba"
        name: "John Davis"
        type: "users"
      }
    ]
    cc: []
    content_file: {
      content: "<!DOCTYPE html PUBLIC...</body></html>",
      description: ""
      ext: ".html"
      has_thumb: null
      id: "174e99cb"
      last_modified_by_name: "John Davis"
      modified: "2014-01-14T12:04:41.941322"
      name: "welcomev_email.html"
      owner: {
        id:913b7328cb,
        name:John Davis
      }
      parent: {
        description: "A Folder for automated mailshots"
        id: "12e572e46b"
        last_modified_by_name: "John Davis"
        modified: "2014-01-14T12:04:17.937656"
        name: "Automations"
      }
      parent_id: "47087669"
      short_id: "d38f7"
    }
    content_file_id: "d38f79cb"
    from: {
      email_address: "hello@mycompany.net"
      id: "fc190f6b94"
      name: "John Davis"
      type: "users"
    }
    name: "Welcome Mailshot"
    subject: "My Company Welcome Email"
    to: {
      comments: ""
      cost: 0
      cost_basis: "total"
      id: "a9f34523"
      name: "Welcome Mailshot"
      short_id: "a9f3f4523"
      type: "smart_groups"
    }
    type: "mailshots"
}

 

Response Type

Response content type: JSON mailshot

ModelExample of Response

 

Mailshot  {

bcc(Array[User]): list of SalesSeek Users to include in Blind Carbon Copy,

cc(Array[User]): list of SalesSeek Users to include in Carbon Copy,

content_file(Content_file): file to be sent as the body of the mailshot, is located on the Content > Library and could be any format,

content_file_id(string): id of the content file to be sent through the mailshot,

from(User): Info of the SalesSeek User who will be the sender of this mailshot

id(String): Id of the current mailshot,

last_sent(timestamp): Latest date this mailshot was sent, formatted as YYYY-MM-ddThh_mm_ss.msecs,

name(string): Mailshot name

owner(User): SalesSeek user who owns this mailshot,

owner_id(string): id of the SalesSeek user who owns this mailshot,

sent_history(Array[Mailshot_Sent]): History of all the times this mailshot was sent on the past, including statistics

subject(string): Subject for this email

to(Group): The group with all the recipients for this mailshot: SalesSeek suggests to configure one Static Group in case further validations over the specific individuals who received this email campaign

type(string): "mailshots"

}

Content_file(JSON): {

content(string): Entire file content, should be an HTML but may be plain text or any other file available from the Content > Library,

description(string): From the Content > Library, a brief description of this file,

ext(string): file extension (eg: .html),

has_thumb(string): complete URL path to the thumbnail file,

id (string): unique identifier for this file,

last_modified_by_name(string): name of the last SalesSeek User who modified it,

modified(timestamp): latest modified date, formatted as YYYY-MM-ddThh_mm_ss.msecs,

name(string): Alias which can be used as a unique identifier for the file,

owner(User): Reference to the user who owns this directory,

parent(Directory): Directory holding the current file,

parent_id(string): id of the parent directory for this file,

short_id(string): short identifier which can be alternatively use as an id for this file

}

Folder(JSON): {

description(string): Description of the current directory,

id(sting): unique id of this directory,

last_modified_by_name(string): Name of the SalesSeek user who latest modified the directory,

modified(timestamp): latest modified date, formatted as YYYY-MM-ddThh_mm_ss.msecs,

name(string): Directory name which may be used as an alias,

owner(User): Reference to the user who owns this directory,

short_id(string): short identifier which can be alternatively use as an id for this directory

}

User {

id (string): unique identifier for the User,

name (string): name to be shown,

type (string): "user"

email_address (string): unique email address identifying this user,

}

Mailshot_Sent(JSON) {

id(string): unique identifier for this send(shot) record

owner(User): information about the SalesSeek user who sent this mailshot at this shot,

owner_id(string): Unique ID of the SalesSeek who sent this mailshot at this shot,

sent(timestamp): sent date, formatted as YYYY-MM-ddThh_mm_ss.msecs,

stats(Mailshot_stats): summary with this mailshot provided by Mandril

}

 

Mailshot_Stats(JSON) {

 clicks(int): amount of times one of the links inside the mailshot was clicked by one recipient,

complaints(int): amount of times a recipient has complained about this sent,

hard_bounces(int): amount of times this mailshot was bounced by some incorrect criteria,

opens(int): amount of times the email of this mailshot was opened, regardless of the recipient,

rejects(int): amount of recipients who had rejected this email,

sent(int): amount recipients who this mailshot was sent to,

unique_clicks(int): amount of unique recipients clicking one of the embedded links embedded of this email,

unique_opens(int): amount of unique recipients opening this email

}


 

{
    bcc: [
      0: {
        email_address: "helper@mycompany.net"
        id: "9e59ba"
        name: "John Davis"
        type: "users"
      }
    ]
    cc: []
    content_file: {
      content: "<!DOCTYPE html PUBLIC...</body></html>",
      description: ""
      ext: ".html"
      has_thumb: null
      id: "174e99cb"
      last_modified_by_name: "John Davis"
      modified: "2014-01-14T12:04:41.941322"
      name: "welcomev_email.html"
      owner: {
        id:913b7328cb,
        name:John Davis
      }
      parent: {
        description: "A Folder for automated mailshots"
        id: "12e572e46b"
        last_modified_by_name: "John Davis"
        modified: "2014-01-14T12:04:17.937656"
        name: "Automations"
      }
      parent_id: "47087669"
      short_id: "d38f7"
    }
    content_file_id: "d38f79cb"
    from: {
      email_address: "hello@mycompany.net"
      id: "fc190f6b94"
      name: "John Davis"
      type: "users"
    }
    id: "486f5a5430ec"
    last_sent: "2014-01-17T13:25:07.305488"
    name: "Welcome Mailshot"
    owner: {
      email_address: "john@mycompany.com"
      id: "4918328cb"
      is_admin: true
      name: "John Davis"
    }
    type: "users"
    owner_id: "3b7328cb"
    sent_history: [
      0: {
        id: "a6bdbfdd"
        owner: {
          email_address: "john@mycompany.com"
          id: "4328cb"
          is_admin: true
          name: "John Davis"
          preferences: {
            default_dashboard: "team"
          }
          type: "users"
        }
        owner_id: "4917328cb"
        sent: "2014-01-17T13:25:07.305488"
        stats: {
          clicks: 0
          complaints: 0
          hard_bounces: 0
          opens: 2
          rejects: 0
          sent: 2
          unique_clicks: 0
          unique_opens: 1
        }
      },
      1: {...}
    ]
    subject: "My Company Welcome Email"
    to: {
      comments: ""
      cost: 0
      cost_basis: "total"
      id: "a9f34523"
      name: "Welcome Mailshot"
      short_id: "a9f3f4523"
      type: "smart_groups"
    }
    type: "mailshots"
}

Parameters

ParameterIn / OutRequiredDescriptionParameter TypeData Type
mailshotInYThe  mailshot  to be createdJSON
mailshotOut-The mailshot created after the successful requestJSON

 


 

 

DELETE /mailshots

Deletes a list of mailshots by ID

Delete a list of mailshots by the ids in the request body

Request URL

https://{client_id}.salesseek.net/api/mailshots

Request Body
{
    id: "88440023",
    id: "68803335"
}

Response Type

Response content type: null

 

Parameters

ParameterIn / OutRequiredDescriptionParameter TypeData Type
 mailshots _idsInYThe list of mailshots ids to be deletedRequest Bodystring

 


 

Get /mailshots/{mailshot _id} 

Provides the mailshot matching mailshot _id

Returns the unique mailshot matching the mailshot _Id

Request URL

https://{client_id}.salesseek.net/api/mailshots/69d1fbe62

Response Type

Response content type: Mailshot

ModelExample of Response

 

Mailshot  {

bcc(Array[User]): list of SalesSeek Users to include in Blind Carbon Copy,

cc(Array[User]): list of SalesSeek Users to include in Carbon Copy,

content_file(Content_file): file to be sent as the body of the mailshot, is located on the Content > Library and could be any format,

content_file_id(string): id of the content file to be sent through the mailshot,

from(User): Info of the SalesSeek User who will be the sender of this mailshot

id(String): Id of the current mailshot,

last_sent(timestamp): Latest date this mailshot was sent, formatted as YYYY-MM-ddThh_mm_ss.msecs,

name(string): Mailshot name

owner(User): SalesSeek user who owns this mailshot,

owner_id(string): id of the SalesSeek user who owns this mailshot,

sent_history(Array[Mailshot_Sent]): History of all the times this mailshot was sent on the past, including statistics

subject(string): Subject for this email

to(Group): The group with all the recipients for this mailshot: SalesSeek suggests to configure one Static Group in case further validations over the specific individuals who received this email campaign

type(string): "mailshots"

}

Content_file(JSON): {

content(string): Entire file content, should be an HTML but may be plain text or any other file available from the Content > Library,

description(string): From the Content > Library, a brief description of this file,

ext(string): file extension (eg: .html),

has_thumb(string): complete URL path to the thumbnail file,

id (string): unique identifier for this file,

last_modified_by_name(string): name of the last SalesSeek User who modified it,

modified(timestamp): latest modified date, formatted as YYYY-MM-ddThh_mm_ss.msecs,

name(string): Alias which can be used as a unique identifier for the file,

owner(User): Reference to the user who owns this directory,

parent(Directory): Directory holding the current file,

parent_id(string): id of the parent directory for this file,

short_id(string): short identifier which can be alternatively use as an id for this file

}

Folder(JSON): {

description(string): Description of the current directory,

id(sting): unique id of this directory,

last_modified_by_name(string): Name of the SalesSeek user who latest modified the directory,

modified(timestamp): latest modified date, formatted as YYYY-MM-ddThh_mm_ss.msecs,

name(string): Directory name which may be used as an alias,

owner(User): Reference to the user who owns this directory,

short_id(string): short identifier which can be alternatively use as an id for this directory

}

User {

id (string): unique identifier for the User,

name (string): name to be shown,

type (string): "user"

email_address (string): unique email address identifying this user,

}

Mailshot_Sent(JSON) {

id(string): unique identifier for this send(shot) record

owner(User): information about the SalesSeek user who sent this mailshot at this shot,

owner_id(string): Unique ID of the SalesSeek who sent this mailshot at this shot,

sent(timestamp): sent date, formatted as YYYY-MM-ddThh_mm_ss.msecs,

stats(Mailshot_stats): summary with this mailshot provided by Mandril

}

 

Mailshot_Stats(JSON) {

 clicks(int): amount of times one of the links inside the mailshot was clicked by one recipient,

complaints(int): amount of times a recipient has complained about this sent,

hard_bounces(int): amount of times this mailshot was bounced by some incorrect criteria,

opens(int): amount of times the email of this mailshot was opened, regardless of the recipient,

rejects(int): amount of recipients who had rejected this email,

sent(int): amount recipients who this mailshot was sent to,

unique_clicks(int): amount of unique recipients clicking one of the embedded links embedded of this email,

unique_opens(int): amount of unique recipients opening this email

}


 

{
    bcc: [
      0: {
        email_address: "helper@mycompany.net"
        id: "9e59ba"
        name: "John Davis"
        type: "users"
      }
    ]
    cc: []
    content_file: {
      content: "<!DOCTYPE html PUBLIC...</body></html>",
      description: ""
      ext: ".html"
      has_thumb: null
      id: "174e99cb"
      last_modified_by_name: "John Davis"
      modified: "2014-01-14T12:04:41.941322"
      name: "welcomev_email.html"
      owner: {
        id:913b7328cb,
        name:John Davis
      }
      parent: {
        description: "A Folder for automated mailshots"
        id: "12e572e46b"
        last_modified_by_name: "John Davis"
        modified: "2014-01-14T12:04:17.937656"
        name: "Automations"
      }
      parent_id: "47087669"
      short_id: "d38f7"
    }
    content_file_id: "d38f79cb"
    from: {
      email_address: "hello@mycompany.net"
      id: "fc190f6b94"
      name: "John Davis"
      type: "users"
    }
    id: "486f5a5430ec"
    last_sent: "2014-01-17T13:25:07.305488"
    name: "Welcome Mailshot"
    owner: {
      email_address: "john@mycompany.com"
      id: "4918328cb"
      is_admin: true
      name: "John Davis"
    }
    type: "users"
    owner_id: "3b7328cb"
    sent_history: [
      0: {
        id: "a6bdbfdd"
        owner: {
          email_address: "john@mycompany.com"
          id: "4328cb"
          is_admin: true
          name: "John Davis"
          preferences: {
            default_dashboard: "team"
          }
          type: "users"
        }
        owner_id: "4917328cb"
        sent: "2014-01-17T13:25:07.305488"
        stats: {
          clicks: 0
          complaints: 0
          hard_bounces: 0
          opens: 2
          rejects: 0
          sent: 2
          unique_clicks: 0
          unique_opens: 1
        }
      },
      1: {...}
    ]
    subject: "My Company Welcome Email"
    to: {
      comments: ""
      cost: 0
      cost_basis: "total"
      id: "a9f34523"
      name: "Welcome Mailshot"
      short_id: "a9f3f4523"
      type: "smart_groups"
    }
    type: "mailshots"
}

 

Parameters

ParameterIn / OutRequiredDescriptionParameter TypeData Type
 mailshot  _idInYThe id of the requested mailshot string
 mailshot Out-The requested mailshot  JSON

 

 


 

 

PATCH /mailshot/{mailshot _id}

Updates a specific mailshot by ID

Updates a mailshot by {mailshot _id} and Returns the resulting mailshot.

The fields updated are just the ones passed on the request body

Request URL

https://{client_id}.salesseek.net/api/mailshots/a3451f5--640585a5d026

Request Body
{
    bcc: [
      0: {
        email_address: "helper@mycompany.net"
        id: "9e59ba"
        name: "John Davis"
        type: "users"
      }
    ]
    subject: "My Company Welcome Email"
}

 

Response Type

Response content type: JSON mailshot

ModelExample of Response

Mailshot  {

bcc(Array[User]): list of SalesSeek Users to include in Blind Carbon Copy,

cc(Array[User]): list of SalesSeek Users to include in Carbon Copy,

content_file(Content_file): file to be sent as the body of the mailshot, is located on the Content > Library and could be any format,

content_file_id(string): id of the content file to be sent through the mailshot,

from(User): Info of the SalesSeek User who will be the sender of this mailshot

id(String): Id of the current mailshot,

last_sent(timestamp): Latest date this mailshot was sent, formatted as YYYY-MM-ddThh_mm_ss.msecs,

name(string): Mailshot name

owner(User): SalesSeek user who owns this mailshot,

owner_id(string): id of the SalesSeek user who owns this mailshot,

sent_history(Array[Mailshot_Sent]): History of all the times this mailshot was sent on the past, including statistics

subject(string): Subject for this email

to(Group): The group with all the recipients for this mailshot: SalesSeek suggests to configure one Static Group in case further validations over the specific individuals who received this email campaign

type(string): "mailshots"

}

Content_file(JSON): {

content(string): Entire file content, should be an HTML but may be plain text or any other file available from the Content > Library,

description(string): From the Content > Library, a brief description of this file,

ext(string): file extension (eg: .html),

has_thumb(string): complete URL path to the thumbnail file,

id (string): unique identifier for this file,

last_modified_by_name(string): name of the last SalesSeek User who modified it,

modified(timestamp): latest modified date, formatted as YYYY-MM-ddThh_mm_ss.msecs,

name(string): Alias which can be used as a unique identifier for the file,

owner(User): Reference to the user who owns this directory,

parent(Directory): Directory holding the current file,

parent_id(string): id of the parent directory for this file,

short_id(string): short identifier which can be alternatively use as an id for this file

}

Folder(JSON): {

description(string): Description of the current directory,

id(sting): unique id of this directory,

last_modified_by_name(string): Name of the SalesSeek user who latest modified the directory,

modified(timestamp): latest modified date, formatted as YYYY-MM-ddThh_mm_ss.msecs,

name(string): Directory name which may be used as an alias,

owner(User): Reference to the user who owns this directory,

short_id(string): short identifier which can be alternatively use as an id for this directory

}

User {

id (string): unique identifier for the User,

name (string): name to be shown,

type (string): "user"

email_address (string): unique email address identifying this user,

}

Mailshot_Sent(JSON) {

id(string): unique identifier for this send(shot) record

owner(User): information about the SalesSeek user who sent this mailshot at this shot,

owner_id(string): Unique ID of the SalesSeek who sent this mailshot at this shot,

sent(timestamp): sent date, formatted as YYYY-MM-ddThh_mm_ss.msecs,

stats(Mailshot_stats): summary with this mailshot provided by Mandril

}

 

Mailshot_Stats(JSON) {

 clicks(int): amount of times one of the links inside the mailshot was clicked by one recipient,

complaints(int): amount of times a recipient has complained about this sent,

hard_bounces(int): amount of times this mailshot was bounced by some incorrect criteria,

opens(int): amount of times the email of this mailshot was opened, regardless of the recipient,

rejects(int): amount of recipients who had rejected this email,

sent(int): amount recipients who this mailshot was sent to,

unique_clicks(int): amount of unique recipients clicking one of the embedded links embedded of this email,

unique_opens(int): amount of unique recipients opening this email

}


 

{
    bcc: [
      0: {
        email_address: "helper@mycompany.net"
        id: "9e59ba"
        name: "John Davis"
        type: "users"
      }
    ]
    cc: []
    content_file: {
      content: "<!DOCTYPE html PUBLIC...</body></html>",
      description: ""
      ext: ".html"
      has_thumb: null
      id: "174e99cb"
      last_modified_by_name: "John Davis"
      modified: "2014-01-14T12:04:41.941322"
      name: "welcomev_email.html"
      owner: {
        id:913b7328cb,
        name:John Davis
      }
      parent: {
        description: "A Folder for automated mailshots"
        id: "12e572e46b"
        last_modified_by_name: "John Davis"
        modified: "2014-01-14T12:04:17.937656"
        name: "Automations"
      }
      parent_id: "47087669"
      short_id: "d38f7"
    }
    content_file_id: "d38f79cb"
    from: {
      email_address: "hello@mycompany.net"
      id: "fc190f6b94"
      name: "John Davis"
      type: "users"
    }
    id: "486f5a5430ec"
    last_sent: "2014-01-17T13:25:07.305488"
    name: "Welcome Mailshot"
    owner: {
      email_address: "john@mycompany.com"
      id: "4918328cb"
      is_admin: true
      name: "John Davis"
    }
    type: "users"
    owner_id: "3b7328cb"
    sent_history: [
      0: {
        id: "a6bdbfdd"
        owner: {
          email_address: "john@mycompany.com"
          id: "4328cb"
          is_admin: true
          name: "John Davis"
          preferences: {
            default_dashboard: "team"
          }
          type: "users"
        }
        owner_id: "4917328cb"
        sent: "2014-01-17T13:25:07.305488"
        stats: {
          clicks: 0
          complaints: 0
          hard_bounces: 0
          opens: 2
          rejects: 0
          sent: 2
          unique_clicks: 0
          unique_opens: 1
        }
      },
      1: {...}
    ]
    subject: "My Company Welcome Email"
    to: {
      comments: ""
      cost: 0
      cost_basis: "total"
      id: "a9f34523"
      name: "Welcome Mailshot"
      short_id: "a9f3f4523"
      type: "smart_groups"
    }
    type: "mailshots"
}

Parameters

ParameterIn / OutRequiredDescriptionParameter TypeData Type
 mailshot _idInYThe id of the mailshot to be updatedstring
 mailshot InYThe subset of the mailshot  fields to be updatedJSON
 mailshot OutThe mailshot after the successful updateJSON

 

 


 

DELETE /mailshot/{mailshot _id}

Deletes a specific mailshot by ID

Removes a specific mailshot by {mailshot _id}

Request URL

https://{client_id}.salesseek.net/api/mailshots/a3451f5  

Response Type

Response content type: null

 

Parameters

ParameterIn / OutRequiredDescriptionParameter TypeData Type
 mailshot _idInYThe id of  mailshot  to be deletedstring

 


 

Get /mailshot/{mailshot _id}?send=true

Send current mailshot

Sends the mailshot with {mailshot _id} following all its configuration, including the entire list of recipients.

SalesSeek suggests adding a previous confirmation, may be showing the destiny group (recipients) for validation.

Request URL

https://{client_id}.salesseek.net/api/mailshots/69d1f4ae62?send=true

Response Type

Response content type: JSON Array[Mailshot]

ModelExample of Response

Mailshot  {

bcc(Array[User]): list of SalesSeek Users to include in Blind Carbon Copy,

cc(Array[User]): list of SalesSeek Users to include in Carbon Copy,

content_file(Content_file): file to be sent as the body of the mailshot, is located on the Content > Library and could be any format,

content_file_id(string): id of the content file to be sent through the mailshot,

from(User): Info of the SalesSeek User who will be the sender of this mailshot

id(String): Id of the current mailshot,

last_sent(timestamp): Latest date this mailshot was sent, formatted as YYYY-MM-ddThh_mm_ss.msecs,

name(string): Mailshot name

owner(User): SalesSeek user who owns this mailshot,

owner_id(string): id of the SalesSeek user who owns this mailshot,

sent_history(Array[Mailshot_Sent]): History of all the times this mailshot was sent on the past, including statistics

subject(string): Subject for this email

to(Group): The group with all the recipients for this mailshot: SalesSeek suggests to configure one Static Group in case further validations over the specific individuals who received this email campaign

type(string): "mailshots"

}

Content_file(JSON): {

content(string): Entire file content, should be an HTML but may be plain text or any other file available from the Content > Library,

description(string): From the Content > Library, a brief description of this file,

ext(string): file extension (eg: .html),

has_thumb(string): complete URL path to the thumbnail file,

id (string): unique identifier for this file,

last_modified_by_name(string): name of the last SalesSeek User who modified it,

modified(timestamp): latest modified date, formatted as YYYY-MM-ddThh_mm_ss.msecs,

name(string): Alias which can be used as a unique identifier for the file,

owner(User): Reference to the user who owns this directory,

parent(Directory): Directory holding the current file,

parent_id(string): id of the parent directory for this file,

short_id(string): short identifier which can be alternatively use as an id for this file

}

Folder(JSON): {

description(string): Description of the current directory,

id(sting): unique id of this directory,

last_modified_by_name(string): Name of the SalesSeek user who latest modified the directory,

modified(timestamp): latest modified date, formatted as YYYY-MM-ddThh_mm_ss.msecs,

name(string): Directory name which may be used as an alias,

owner(User): Reference to the user who owns this directory,

short_id(string): short identifier which can be alternatively use as an id for this directory

}

User {

id (string): unique identifier for the User,

name (string): name to be shown,

type (string): "user"

email_address (string): unique email address identifying this user,

}

Mailshot_Sent(JSON) {

id(string): unique identifier for this send(shot) record

owner(User): information about the SalesSeek user who sent this mailshot at this shot,

owner_id(string): Unique ID of the SalesSeek who sent this mailshot at this shot,

sent(timestamp): sent date, formatted as YYYY-MM-ddThh_mm_ss.msecs,

stats(Mailshot_stats): summary with this mailshot provided by Mandril

}

 

Mailshot_Stats(JSON) {

 clicks(int): amount of times one of the links inside the mailshot was clicked by one recipient,

complaints(int): amount of times a recipient has complained about this sent,

hard_bounces(int): amount of times this mailshot was bounced by some incorrect criteria,

opens(int): amount of times the email of this mailshot was opened, regardless of the recipient,

rejects(int): amount of recipients who had rejected this email,

sent(int): amount recipients who this mailshot was sent to,

unique_clicks(int): amount of unique recipients clicking one of the embedded links embedded of this email,

unique_opens(int): amount of unique recipients opening this email

}


 

{
    bcc: [
      0: {
        email_address: "helper@mycompany.net"
        id: "9e59ba"
        name: "John Davis"
        type: "users"
      }
    ]
    cc: []
    content_file: {
      content: "<!DOCTYPE html PUBLIC...</body></html>",
      description: ""
      ext: ".html"
      has_thumb: null
      id: "174e99cb"
      last_modified_by_name: "John Davis"
      modified: "2014-01-14T12:04:41.941322"
      name: "welcomev_email.html"
      owner: {
        id:913b7328cb,
        name:John Davis
      }
      parent: {
        description: "A Folder for automated mailshots"
        id: "12e572e46b"
        last_modified_by_name: "John Davis"
        modified: "2014-01-14T12:04:17.937656"
        name: "Automations"
      }
      parent_id: "47087669"
      short_id: "d38f7"
    }
    content_file_id: "d38f79cb"
    from: {
      email_address: "hello@mycompany.net"
      id: "fc190f6b94"
      name: "John Davis"
      type: "users"
    }
    id: "486f5a5430ec"
    last_sent: "2014-01-17T13:25:07.305488"
    name: "Welcome Mailshot"
    owner: {
      email_address: "john@mycompany.com"
      id: "4918328cb"
      is_admin: true
      name: "John Davis"
    }
    type: "users"
    owner_id: "3b7328cb"
    sent_history: [
      0: {
        id: "a6bdbfdd"
        owner: {
          email_address: "john@mycompany.com"
          id: "4328cb"
          is_admin: true
          name: "John Davis"
          preferences: {
            default_dashboard: "team"
          }
          type: "users"
        }
        owner_id: "4917328cb"
        sent: "2014-01-17T13:25:07.305488"
        stats: {
          clicks: 0
          complaints: 0
          hard_bounces: 0
          opens: 2
          rejects: 0
          sent: 2
          unique_clicks: 0
          unique_opens: 1
        }
      },
      1: {...}
    ]
    subject: "My Company Welcome Email"
    to: {
      comments: ""
      cost: 0
      cost_basis: "total"
      id: "a9f34523"
      name: "Welcome Mailshot"
      short_id: "a9f3f4523"
      type: "smart_groups"
    }
    type: "mailshots"
}

 

Parameters

ParameterIn / OutRequiredDescriptionParameter TypeData Type
sendInYFor sending this mailshot this parameter should be sent with value = trueboolean
mailshot_idInYId of the mailshot to be sentint
mailshotOut-The mailshot recently created as the result from the successful requestJSON

 


 

Get /mailshot/{mailshot _id}?test=true

Test the delivery of the current Mailshot

Test the delivety of the mailshot with {mailshot _id} following all its configuration, but instead of the recipients list it is sent to the email of the SalesSeek user runing this task (session).

Request URL

https://{client_id}.salesseek.net/api/mailshots/69d1f4ae62?test=true

Response Type

Response content type: JSON Array[Mailshot]

ModelExample of Response

Mailshot  {

bcc(Array[User]): list of SalesSeek Users to include in Blind Carbon Copy,

cc(Array[User]): list of SalesSeek Users to include in Carbon Copy,

content_file(Content_file): file to be sent as the body of the mailshot, is located on the Content > Library and could be any format,

content_file_id(string): id of the content file to be sent through the mailshot,

from(User): Info of the SalesSeek User who will be the sender of this mailshot

id(String): Id of the current mailshot,

last_sent(timestamp): Latest date this mailshot was sent, formatted as YYYY-MM-ddThh_mm_ss.msecs,

name(string): Mailshot name

owner(User): SalesSeek user who owns this mailshot,

owner_id(string): id of the SalesSeek user who owns this mailshot,

sent_history(Array[Mailshot_Sent]): History of all the times this mailshot was sent on the past, including statistics

subject(string): Subject for this email

to(Group): The group with all the recipients for this mailshot: SalesSeek suggests to configure one Static Group in case further validations over the specific individuals who received this email campaign

type(string): "mailshots"

}

Content_file(JSON): {

content(string): Entire file content, should be an HTML but may be plain text or any other file available from the Content > Library,

description(string): From the Content > Library, a brief description of this file,

ext(string): file extension (eg: .html),

has_thumb(string): complete URL path to the thumbnail file,

id (string): unique identifier for this file,

last_modified_by_name(string): name of the last SalesSeek User who modified it,

modified(timestamp): latest modified date, formatted as YYYY-MM-ddThh_mm_ss.msecs,

name(string): Alias which can be used as a unique identifier for the file,

owner(User): Reference to the user who owns this directory,

parent(Directory): Directory holding the current file,

parent_id(string): id of the parent directory for this file,

short_id(string): short identifier which can be alternatively use as an id for this file

}

Folder(JSON): {

description(string): Description of the current directory,

id(sting): unique id of this directory,

last_modified_by_name(string): Name of the SalesSeek user who latest modified the directory,

modified(timestamp): latest modified date, formatted as YYYY-MM-ddThh_mm_ss.msecs,

name(string): Directory name which may be used as an alias,

owner(User): Reference to the user who owns this directory,

short_id(string): short identifier which can be alternatively use as an id for this directory

}

User {

id (string): unique identifier for the User,

name (string): name to be shown,

type (string): "user"

email_address (string): unique email address identifying this user,

}

Mailshot_Sent(JSON) {

id(string): unique identifier for this send(shot) record

owner(User): information about the SalesSeek user who sent this mailshot at this shot,

owner_id(string): Unique ID of the SalesSeek who sent this mailshot at this shot,

sent(timestamp): sent date, formatted as YYYY-MM-ddThh_mm_ss.msecs,

stats(Mailshot_stats): summary with this mailshot provided by Mandril

}

 

Mailshot_Stats(JSON) {

 clicks(int): amount of times one of the links inside the mailshot was clicked by one recipient,

complaints(int): amount of times a recipient has complained about this sent,

hard_bounces(int): amount of times this mailshot was bounced by some incorrect criteria,

opens(int): amount of times the email of this mailshot was opened, regardless of the recipient,

rejects(int): amount of recipients who had rejected this email,

sent(int): amount recipients who this mailshot was sent to,

unique_clicks(int): amount of unique recipients clicking one of the embedded links embedded of this email,

unique_opens(int): amount of unique recipients opening this email

}


 

{
    bcc: [
      0: {
        email_address: "helper@mycompany.net"
        id: "9e59ba"
        name: "John Davis"
        type: "users"
      }
    ]
    cc: []
    content_file: {
      content: "<!DOCTYPE html PUBLIC...</body></html>",
      description: ""
      ext: ".html"
      has_thumb: null
      id: "174e99cb"
      last_modified_by_name: "John Davis"
      modified: "2014-01-14T12:04:41.941322"
      name: "welcomev_email.html"
      owner: {
        id:913b7328cb,
        name:John Davis
      }
      parent: {
        description: "A Folder for automated mailshots"
        id: "12e572e46b"
        last_modified_by_name: "John Davis"
        modified: "2014-01-14T12:04:17.937656"
        name: "Automations"
      }
      parent_id: "47087669"
      short_id: "d38f7"
    }
    content_file_id: "d38f79cb"
    from: {
      email_address: "hello@mycompany.net"
      id: "fc190f6b94"
      name: "John Davis"
      type: "users"
    }
    id: "486f5a5430ec"
    last_sent: "2014-01-17T13:25:07.305488"
    name: "Welcome Mailshot"
    owner: {
      email_address: "john@mycompany.com"
      id: "4918328cb"
      is_admin: true
      name: "John Davis"
    }
    type: "users"
    owner_id: "3b7328cb"
    sent_history: [
      0: {
        id: "a6bdbfdd"
        owner: {
          email_address: "john@mycompany.com"
          id: "4328cb"
          is_admin: true
          name: "John Davis"
          preferences: {
            default_dashboard: "team"
          }
          type: "users"
        }
        owner_id: "4917328cb"
        sent: "2014-01-17T13:25:07.305488"
        stats: {
          clicks: 0
          complaints: 0
          hard_bounces: 0
          opens: 2
          rejects: 0
          sent: 2
          unique_clicks: 0
          unique_opens: 1
        }
      },
      1: {...}
    ]
    subject: "My Company Welcome Email"
    to: {
      comments: ""
      cost: 0
      cost_basis: "total"
      id: "a9f34523"
      name: "Welcome Mailshot"
      short_id: "a9f3f4523"
      type: "smart_groups"
    }
    type: "mailshots"
}

 

Parameters

ParameterIn / OutRequiredDescriptionParameter TypeData Type
sendInYFor sending this mailshot this parameter should be sent with value = trueboolean
mailshot_idInYId of the mailshot to be sentint
mailshotOut-The mailshot recently created as the result from the successful requestJSON
  • No labels