> ## Documentation Index
> Fetch the complete documentation index at: https://docs.salescaptain.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Send email

> Sends an email to an email address from the email connected to the conversation profile you choose.

- If no contact exists for `to_email`, a contact is created.
- If the contact has no conversation on the chosen conversation profile yet, one is created.
- The email is sent through the profile's connected mailbox (Gmail / Outlook) or SalesCaptain's mail
  delivery, and is threaded into the conversation like any inbox email.

`message_body` may contain HTML; plain-text line breaks are converted to `<br/>`.
The conversation profile must have an email address configured (see `/v1/list-conversation-profiles/{company_id}`).
Subject to the company's hourly and per-minute email limits.
`account_id` is resolved from the authenticated user's account that matches `company_id`.




## OpenAPI

````yaml POST /v1/send-email/{company_id}
openapi: 3.0.3
info:
  title: SalesCaptain API Documentation Service
  description: >
    API Documentation Service for SalesCaptain platform.

    This service provides endpoints for managing and retrieving company
    information for API documentation purposes.
  version: 0.1.0
  contact:
    name: SalesCaptain API Team
    email: support@salescaptain.com
  license:
    name: Proprietary
    url: https://salescaptain.com/license
servers:
  - url: https://api.salescaptain.com
    description: Production server
security:
  - BearerAuth: []
tags:
  - name: Health
    description: Service health and status endpoints
  - name: Companies
    description: Company management and retrieval operations
  - name: Accounts
    description: Account management and retrieval operations
  - name: Conversation Profiles
    description: Conversation profile management for communication channels
  - name: Conversations
    description: Conversation management and retrieval operations
  - name: Contacts
    description: Contact management and retrieval operations
  - name: Tags
    description: Tag listing, creation, deletion, and contact assignment operations
  - name: Custom Fields
    description: Custom field definition management
  - name: Templates
    description: SMS template retrieval operations
  - name: Analytics
    description: Call analytics and reporting operations
  - name: Stages
    description: >
      Conversation stages (inbox folders). List the stages, read a
      conversation's stage and move a conversation

      to another stage. Stage moves made in the app or through the API fire the
      `conversation.stage_change` webhook.
  - name: Webhooks
    description: >
      **Webhook Subscriptions** send an HTTP request to your URL when an event
      happens in SalesCaptain.

      Subscriptions are created in the SalesCaptain app: pick the events you
      want, your URL and the HTTP

      method (default `POST`). Each request body is the event payload as JSON,
      with the

      event name in `action`.


      | Event | When it fires | Payload schema |

      |---|---|---|

      | `contact.create` | A contact is created | `WebhookContactEvent` |

      | `contact.update` | A contact is updated | `WebhookContactEvent` |

      | `contact.delete` | A contact is deleted | `WebhookContactEvent` |

      | `message.sms` | An SMS is sent or received | `WebhookMessageEvent` |

      | `message.email` | An email is sent or received | `WebhookMessageEvent` |

      | `message.webchat` | A web chat message is sent or received |
      `WebhookMessageEvent` |

      | `message.fb` | A Facebook message is sent or received |
      `WebhookMessageEvent` |

      | `message.ig` | An Instagram message is sent or received |
      `WebhookMessageEvent` |

      | `campaign.opt_out` | A contact opts out of a campaign message |
      `WebhookWorkflowEvent` |

      | `campaign.replied` | A contact replies to a campaign message |
      `WebhookWorkflowEvent` |

      | `automation.opt_out` | A contact opts out of an automation message |
      `WebhookWorkflowEvent` |

      | `automation.replied` | A contact replies to an automation message |
      `WebhookWorkflowEvent` |

      | `conversation.stage_change` | A conversation is moved to a different
      stage | `WebhookStageChangeEvent` |


      Example `message.sms` request body:


      ```json

      {
        "action": "message.sms",
        "direction": "inbound",
        "timestamp": "7/14/2026, 8:43 AM",
        "channel": "sms",
        "body": "Yes, Friday works for me",
        "media": null,
        "from": "+14155551234",
        "to": "+14155559876"
      }

      ```


      Respond with any 2xx status. Failed deliveries are not retried.
externalDocs:
  description: SalesCaptain API Documentation
  url: https://docs.salescaptain.com
paths:
  /v1/send-email/{company_id}:
    post:
      tags:
        - Conversations
      summary: Send an email to an address
      description: >
        Sends an email to an email address from the email connected to the
        conversation profile you choose.


        - If no contact exists for `to_email`, a contact is created.

        - If the contact has no conversation on the chosen conversation profile
        yet, one is created.

        - The email is sent through the profile's connected mailbox (Gmail /
        Outlook) or SalesCaptain's mail
          delivery, and is threaded into the conversation like any inbox email.

        `message_body` may contain HTML; plain-text line breaks are converted to
        `<br/>`.

        The conversation profile must have an email address configured (see
        `/v1/list-conversation-profiles/{company_id}`).

        Subject to the company's hourly and per-minute email limits.

        `account_id` is resolved from the authenticated user's account that
        matches `company_id`.
      operationId: sendEmail
      parameters:
        - name: company_id
          in: path
          required: true
          description: Unique identifier for the company
          schema:
            type: string
            format: uuid
            example: a1b2c3d4-e5f6-7890-abcd-ef1234567890
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
                - to_email
                - conversation_profile_id
                - subject
                - message_body
              properties:
                to_email:
                  type: string
                  format: email
                  description: Recipient email address
                  example: john.smith@example.com
                conversation_profile_id:
                  type: string
                  format: uuid
                  description: >-
                    The conversation profile whose email address the email is
                    sent from
                  example: c3d4e5f6-a7b8-9012-cdef-123456789012
                subject:
                  type: string
                  maxLength: 255
                  example: Your appointment is confirmed
                message_body:
                  type: string
                  description: Email body (HTML or plain text)
                  example: >-
                    Hi John,<br/>Your appointment is confirmed for Friday at 10
                    AM.<br/>Thanks!
                contact_name:
                  type: string
                  maxLength: 100
                  description: >-
                    Optional name used when a new contact is created. If the
                    contact already exists, its first name is updated to this
                    value.
                  example: John Smith
      responses:
        '200':
          description: Email sent successfully
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                    example: Email sent successfully!
                  data:
                    $ref: '#/components/schemas/OutboundEmailResult'
              example:
                message: Email sent successfully!
                data:
                  contact_id: e5f6a7b8-c9d0-1234-ef12-345678901234
                  conversation_id: b2c3d4e5-f6a7-8901-bcde-f12345678901
                  conversation_profile_id: c3d4e5f6-a7b8-9012-cdef-123456789012
                  from_email: support@acme.com
                  to_email: john.smith@example.com
                  message: {}
        '400':
          description: Invalid request or the email could not be sent
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              examples:
                invalid_email:
                  summary: Invalid email address
                  value:
                    status: failure
                    error: to_email is required and must be a valid email address
                missing_subject:
                  summary: Missing subject
                  value:
                    status: failure
                    error: subject is required
                no_profile_email:
                  summary: Profile has no email configured
                  value:
                    status: failure
                    error: >-
                      This conversation profile has no email address to send
                      from
        '401':
          $ref: '#/components/responses/UnauthorizedError'
        '403':
          $ref: '#/components/responses/ForbiddenError'
        '429':
          $ref: '#/components/responses/RateLimitError'
        '500':
          $ref: '#/components/responses/InternalServerError'
      security:
        - BearerAuth: []
components:
  schemas:
    OutboundEmailResult:
      type: object
      description: Result of sending an email to an address
      properties:
        contact_id:
          type: string
          format: uuid
          description: Contact the email was sent to (created if it did not exist)
        conversation_id:
          type: string
          format: uuid
          description: Conversation the email was posted in (created if it did not exist)
        conversation_profile_id:
          type: string
          format: uuid
        from_email:
          type: string
          format: email
          example: support@acme.com
        to_email:
          type: string
          format: email
          example: john.smith@example.com
        message:
          type: object
          description: The sent email message as recorded in the conversation
          additionalProperties: true
    Error:
      type: object
      description: Error response object
      properties:
        error:
          type: string
          description: Error message
          example: Invalid request parameters
        code:
          type: string
          description: Error code for programmatic handling
          example: INVALID_PARAMS
        timestamp:
          type: string
          format: date-time
          description: Timestamp when the error occurred
          example: '2023-12-01T10:30:00Z'
        path:
          type: string
          description: API endpoint path where the error occurred
          example: /v1/fetch-companies
      required:
        - error
  responses:
    UnauthorizedError:
      description: Authentication token is missing or invalid
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error: Unauthorized access
            code: UNAUTHORIZED
            timestamp: '2023-12-01T10:30:00Z'
            path: /v1/fetch-companies
    ForbiddenError:
      description: Access forbidden - valid token but insufficient permissions
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error: Forbidden access
            code: FORBIDDEN
            timestamp: '2023-12-01T10:30:00Z'
            path: /v1/fetch-companies
    RateLimitError:
      description: Rate limit exceeded
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error: Too many requests, please try again later
            code: RATE_LIMIT_EXCEEDED
            timestamp: '2023-12-01T10:30:00Z'
            path: /v1/fetch-companies
      headers:
        X-RateLimit-Limit:
          description: Request limit per time window
          schema:
            type: integer
            example: 30
        X-RateLimit-Remaining:
          description: Remaining requests in current window
          schema:
            type: integer
            example: 0
        X-RateLimit-Reset:
          description: Time when the rate limit resets
          schema:
            type: integer
            example: 1701425400
    InternalServerError:
      description: Internal server error
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error: Problem encountered while fetching companies!
            code: INTERNAL_ERROR
            timestamp: '2023-12-01T10:30:00Z'
            path: /v1/fetch-companies
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: >
        Authentication token required for accessing protected endpoints.

        The token should be obtained from the main SalesCaptain authentication
        service.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.