Bulk Send Emails

curl --request POST \
  --url http://api.stuut.ai/v1/emails/bulk/send \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "emails": [
    "<string>"
  ]
}
'

{
  "data": [
    {
      "object": "<string>",
      "thread_id": "<string>",
      "id": "<string>",
      "attachments": [
        {
          "file_type": "audio",
          "mime_type": "<string>",
          "name": "<string>",
          "object": "<string>",
          "organization_id": "<string>",
          "id": "<string>",
          "content_id": "<string>",
          "created_at": "2023-11-07T05:31:56Z",
          "disposition": "<string>",
          "is_verified": true,
          "modified_at": "2023-11-07T05:31:56Z",
          "presigned_url": "<string>",
          "presigned_url_expires_at": "2023-11-07T05:31:56Z",
          "purpose": "<string>",
          "remote_id": "<string>",
          "size": 123,
          "src": "<unknown>",
          "user_id": "<string>"
        }
      ],
      "author": {
        "email": "<string>",
        "family_name": "<string>",
        "given_name": "<string>",
        "object": "<string>",
        "organization_id": "<string>",
        "id": "<string>",
        "created_at": "2023-11-07T05:31:56Z",
        "dashboard_settings": {
          "thread_emails_sort_order": "asc"
        },
        "default_email_sender_id": "<string>",
        "invited_by_user_id": "<string>",
        "is_access_approved": true,
        "is_org_admin": true,
        "modified_at": "2023-11-07T05:31:56Z",
        "name": "<string>",
        "onboarding_required": true,
        "profile_picture": "<string>",
        "selected": true
      },
      "author_id": "<string>",
      "bcc": [
        "<string>"
      ],
      "body": "<string>",
      "bounced_addresses": [
        "<string>"
      ],
      "bulk_email_request_id": "<string>",
      "cc": [
        "<string>"
      ],
      "created_at": "2023-11-07T05:31:56Z",
      "custom_headers": "<unknown>",
      "direction": "inbound",
      "email_reason": "<string>",
      "email_sender": {
        "email": "<string>",
        "object": "<string>",
        "reply_to": "<string>",
        "user_id": "<string>",
        "id": "<string>",
        "created_at": "2023-11-07T05:31:56Z",
        "expired_at": "2023-11-07T05:31:56Z",
        "is_nylas_connection": true,
        "is_nylas_grant_expired": true,
        "is_shared": true,
        "modified_at": "2023-11-07T05:31:56Z",
        "name": "<string>",
        "provider": "<string>",
        "reply_to_name": "<string>",
        "signature_html": "<string>"
      },
      "email_sender_id": "<string>",
      "error_message": "<string>",
      "from_email": "<string>",
      "generated_body": "<string>",
      "is_automated": true,
      "is_generated": true,
      "is_originated_in_stuut": true,
      "is_unread": true,
      "modified_at": "2023-11-07T05:31:56Z",
      "parent_email_id": "<string>",
      "participants": [
        "[email protected]"
      ],
      "remote_id": "<string>",
      "remote_links": [
        {
          "email_id": "<string>",
          "email_sender_id": "<string>",
          "object": "<string>",
          "remote_id": "<string>",
          "remote_thread_id": "<string>",
          "created_at": "2023-11-07T05:31:56Z",
          "modified_at": "2023-11-07T05:31:56Z"
        }
      ],
      "reply_to": [
        "<string>"
      ],
      "send_separately": true,
      "sent_at": "2023-11-07T05:31:56Z",
      "sent_by_id": "<string>",
      "snippet": "<string>",
      "status": "draft",
      "subject": "<string>",
      "to": [
        "<string>"
      ]
    }
  ],
  "current_page": 0,
  "total_records": 0,
  "next_page": null
}

POST

emails

bulk

send

Bulk Send Emails

curl --request POST \
  --url http://api.stuut.ai/v1/emails/bulk/send \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "emails": [
    "<string>"
  ]
}
'

{
  "data": [
    {
      "object": "<string>",
      "thread_id": "<string>",
      "id": "<string>",
      "attachments": [
        {
          "file_type": "audio",
          "mime_type": "<string>",
          "name": "<string>",
          "object": "<string>",
          "organization_id": "<string>",
          "id": "<string>",
          "content_id": "<string>",
          "created_at": "2023-11-07T05:31:56Z",
          "disposition": "<string>",
          "is_verified": true,
          "modified_at": "2023-11-07T05:31:56Z",
          "presigned_url": "<string>",
          "presigned_url_expires_at": "2023-11-07T05:31:56Z",
          "purpose": "<string>",
          "remote_id": "<string>",
          "size": 123,
          "src": "<unknown>",
          "user_id": "<string>"
        }
      ],
      "author": {
        "email": "<string>",
        "family_name": "<string>",
        "given_name": "<string>",
        "object": "<string>",
        "organization_id": "<string>",
        "id": "<string>",
        "created_at": "2023-11-07T05:31:56Z",
        "dashboard_settings": {
          "thread_emails_sort_order": "asc"
        },
        "default_email_sender_id": "<string>",
        "invited_by_user_id": "<string>",
        "is_access_approved": true,
        "is_org_admin": true,
        "modified_at": "2023-11-07T05:31:56Z",
        "name": "<string>",
        "onboarding_required": true,
        "profile_picture": "<string>",
        "selected": true
      },
      "author_id": "<string>",
      "bcc": [
        "<string>"
      ],
      "body": "<string>",
      "bounced_addresses": [
        "<string>"
      ],
      "bulk_email_request_id": "<string>",
      "cc": [
        "<string>"
      ],
      "created_at": "2023-11-07T05:31:56Z",
      "custom_headers": "<unknown>",
      "direction": "inbound",
      "email_reason": "<string>",
      "email_sender": {
        "email": "<string>",
        "object": "<string>",
        "reply_to": "<string>",
        "user_id": "<string>",
        "id": "<string>",
        "created_at": "2023-11-07T05:31:56Z",
        "expired_at": "2023-11-07T05:31:56Z",
        "is_nylas_connection": true,
        "is_nylas_grant_expired": true,
        "is_shared": true,
        "modified_at": "2023-11-07T05:31:56Z",
        "name": "<string>",
        "provider": "<string>",
        "reply_to_name": "<string>",
        "signature_html": "<string>"
      },
      "email_sender_id": "<string>",
      "error_message": "<string>",
      "from_email": "<string>",
      "generated_body": "<string>",
      "is_automated": true,
      "is_generated": true,
      "is_originated_in_stuut": true,
      "is_unread": true,
      "modified_at": "2023-11-07T05:31:56Z",
      "parent_email_id": "<string>",
      "participants": [
        "[email protected]"
      ],
      "remote_id": "<string>",
      "remote_links": [
        {
          "email_id": "<string>",
          "email_sender_id": "<string>",
          "object": "<string>",
          "remote_id": "<string>",
          "remote_thread_id": "<string>",
          "created_at": "2023-11-07T05:31:56Z",
          "modified_at": "2023-11-07T05:31:56Z"
        }
      ],
      "reply_to": [
        "<string>"
      ],
      "send_separately": true,
      "sent_at": "2023-11-07T05:31:56Z",
      "sent_by_id": "<string>",
      "snippet": "<string>",
      "status": "draft",
      "subject": "<string>",
      "to": [
        "<string>"
      ]
    }
  ],
  "current_page": 0,
  "total_records": 0,
  "next_page": null
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

emails

string[]

required

Minimum array length: 1

The Email identifier, (e.g. eml_abc123).

Response

Successful response

data

object[]

Show child attributes

data.object

string

required

data.thread_id

string

required

Maximum string length: 32

data.id

string

Maximum string length: 32

data.attachments

object[]

Show child attributes

data.attachments.file_type

enum<string>

required

Available options:

audio,

document,

gif,

image,

video

Maximum string length: 8

data.attachments.mime_type

string

required

data.attachments.name

string

required

data.attachments.object

string

required

data.attachments.organization_id

string

required

Maximum string length: 32

data.attachments.id

string

Maximum string length: 32

data.attachments.content_id

string | null

data.attachments.created_at

string<date-time>

data.attachments.disposition

string

data.attachments.is_verified

boolean

data.attachments.modified_at

string<date-time> | null

data.attachments.presigned_url

string | null

data.attachments.presigned_url_expires_at

string<date-time> | null

data.attachments.purpose

string | null

The use case for this attachment

data.attachments.remote_id

string | null

The address' third party API ID.

data.attachments.size

integer | null

data.attachments.src

any

data.attachments.user_id

string | null

Maximum string length: 32

data.author

object

Show child attributes

data.author.email

string

required

Maximum string length: 255

data.author.family_name

string

required

data.author.given_name

string

required

data.author.object

string

required

data.author.organization_id

string

required

Maximum string length: 32

data.author.id

string

Maximum string length: 32

data.author.created_at

string<date-time>

data.author.dashboard_settings

object

Show child attributes

data.author.dashboard_settings.thread_emails_sort_order

string

default:asc

data.author.default_email_sender_id

string | null

Maximum string length: 32

data.author.invited_by_user_id

string | null

Maximum string length: 32

data.author.is_access_approved

boolean

data.author.is_org_admin

boolean

data.author.modified_at

string<date-time> | null

data.author.name

string

data.author.onboarding_required

boolean

data.author.profile_picture

string

data.author.selected

boolean

data.author_id

string | null

Maximum string length: 32

data.bcc

string[]

data.body

string | null

The HTML body of the email.

data.bounced_addresses

string[]

List of email addresses that bounced for this email

data.bulk_email_request_id

string | null

Maximum string length: 32

data.cc

string[]

data.created_at

string<date-time>

data.custom_headers

any | null

Custom email headers

data.direction

enum<string>

The request direction of the email. Either inbound or outbound

Available options:

inbound,

outbound

Maximum string length: 8

data.email_reason

string | null

The reason the email was sent.

data.email_sender

object

Show child attributes

data.email_sender.email

string

required

The account's email.

Maximum string length: 255

data.email_sender.object

string

required

data.email_sender.reply_to

string

required

This account's default reply-to

Maximum string length: 255

data.email_sender.user_id

string

required

Maximum string length: 32

data.email_sender.id

string

Maximum string length: 32

data.email_sender.created_at

string<date-time>

data.email_sender.expired_at

string<date-time> | null

The time the email sender grant expired.

data.email_sender.is_nylas_connection

boolean

data.email_sender.is_nylas_grant_expired

boolean

Whether the Nylas grant for this email sender has expired

data.email_sender.is_shared

boolean

Whether this email sender should be shared with the entire organization

data.email_sender.modified_at

string<date-time> | null

data.email_sender.name

string | null

Email owner's name.

data.email_sender.provider

string | null

data.email_sender.reply_to_name

string | null

This account's default reply-to

data.email_sender.signature_html

string | null

Email signature html.

data.email_sender_id

string | null

Maximum string length: 32

data.error_message

string | null

The error message if the email failed to send.

data.from_email

string

data.generated_body

string | null

Saves LLM-generated body of the email. Diffed against email body when email is sent to get user changes.

data.is_automated

boolean

Whether the email was automatically sent by a workflow or an AI agent.

data.is_generated

boolean

Whether the email was automatically generated by a workflow or an AI agent.

data.is_originated_in_stuut

boolean

Whether the email originated (was sent through) Stuut.

data.is_unread

boolean

data.modified_at

string<date-time> | null

data.parent_email_id

string | null

Maximum string length: 32

data.participants

string<email>[]

data.remote_id

string | null

The Nylas ID of the email

data.remote_links

object[]

Show child attributes

data.remote_links.email_id

string

required

Maximum string length: 32

data.remote_links.email_sender_id

string

required

Maximum string length: 32

data.remote_links.object

string

required

data.remote_links.remote_id

string

required

The ID of the email in a remote system, e.g. Nylas

data.remote_links.remote_thread_id

string

required

The ID of the email thread in a remote system, e.g. Nylas

data.remote_links.created_at

string<date-time>

data.remote_links.modified_at

string<date-time> | null

data.reply_to

string[]

data.send_separately

boolean

data.sent_at

string<date-time> | null

When the email was sent.

data.sent_by_id

string | null

Maximum string length: 32

data.snippet

string | null

data.status

enum<string>

Available options:

draft,

pending,

sending,

sent,

error

Maximum string length: 7

data.subject

string | null

data.to

string[]

current_page

integer

default:0

The current page.

total_records

integer

default:0

Total number of records.

next_page

integer | null

The next page, if one exists.

Bulk Delete Emails Retrieve An Email

⌘I

Analytics

Bank Accounts

Bank Statements

Bank Transactions

Call Agent Scenarios

Call Agents

Calls

Contact Suggestions

Email Senders

Email Template Folders

Email Templates

Email Threads

Emails

Files

Invoices

Notes

Organizations

Outreach Workflows

Partners

Partner Contacts

Payments

Phone Numbers

Profile

Remittances

Tags

Tasks

User Invites

Users

Bulk Send Emails

Authorizations

Body

Response