Emails

Create an email

Creates a one-off email to a prospect on behalf of a workspace user (ownerId), and optionally sends it immediately.

Nooks creates a manual_email task for the prospect with a draft email attached, writes the given content to the draft, and, when send: true, submits it through the owner's connected mailbox, applying the workspace's deliverability safeguards (unsubscribe checks, pre-bounce validation, tracking, send spacing). With send: false (the default) the email is left as a draft the owner can review and send from Nooks.

Recipients default to the prospect's primary email; pass recipients to override them (required when the prospect has no primary email). The sender defaults to the owner's default mailbox alias; pass from to use another of the owner's aliases.

Not transactional: the draft is created before the send. If a send: true request returns 422 for a send-time rejection, the draft email and its manual_email task already exist in the owner's Nooks task list. Fix and resend from Nooks rather than retrying this endpoint, which would create a second draft.

post/emails

Request

  • Base URL: https://partner-api.nooks.in/v1
  • URL: https://partner-api.nooks.in/v1/emails
  • Auth: one of:
    • HTTP bearer
    • OAuth 2 (authorization code, authorization URL https://oauth.nooks.in/oauth/authorize, token URL https://oauth.nooks.in/oauth/token, scopes: emails:write)

Request body

Example request

{
  "data": {
    "prospectId": "770e8400-e29b-41d4-a716-446655440003",
    "ownerId": "KKLvN5wQoghWFwUvC75CZ12QM7I3",
    "subject": "Quick question",
    "bodyHtml": "<p>Hi Jane, ...</p>",
    "from": "rep@company.com",
    "recipients": [
      "jane@acme.com"
    ],
    "cc": [
      "manager@acme.com"
    ],
    "bcc": [
      "crm-bcc@company.com"
    ]
  }
}

Response

Email created; when send: true it has also been submitted for sending (status is in_progress/sent; a rate-limited send is queued and retried automatically). Unsent drafts return status: draft. The type field is null until the email actually sends (drafts and queued sends), then reflects the sending provider (gmail/outlook).

idstring uuid required

Unique identifier for the email

typestring nullable

Integration type of the email (e.g. gmail, outlook). Null until the email is actually sent. An unsent draft or a queued send has no type yet.

statusstring nullable

Current status of the email

fromstring nullable

Sender email address

tostring nullable

Recipient email address

recipientsstring[] nullable

List of recipient email addresses

subjectstring nullable

Email subject line

bodyTextstring nullable

The plain-text body of the email.

bodyHtmlstring nullable

The HTML body of the email.

datestring date-time nullable

Date of the email

deliveredAtstring date-time nullable

When the email was delivered

openedAtstring date-time nullable

When the email was first opened

clickedAtstring date-time nullable

When a link in the email was first clicked

bouncedAtstring date-time nullable

When the email bounced

repliedAtstring date-time nullable

When a reply was received

openCountinteger nullable

Number of times the email was opened

clickCountinteger nullable

Number of times links were clicked

createdAtstring date-time required

When the email record was created

updatedAtstring date-time required

When the email record was last updated

Example response

{
  "prospect": {
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "_href": "/v1/sequences/550e8400-e29b-41d4-a716-446655440000"
  },
  "task": {
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "_href": "/v1/sequences/550e8400-e29b-41d4-a716-446655440000"
  },
  "sequence": {
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "_href": "/v1/sequences/550e8400-e29b-41d4-a716-446655440000"
  },
  "sequenceStep": {
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "_href": "/v1/sequences/550e8400-e29b-41d4-a716-446655440000"
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.