> ## Documentation Index > Fetch the complete documentation index at: https://docs.go.aiinsurance.io/llms.txt > Use this file to discover all available pages before exploring further. # Send Record Email > Sends one template version from this record, or from one of its packets with `packetId`, the way Send email does in the app. The email is stored on the record at once and its delivery is queued; the response returns before it is sent. Follow it on Get Record Email Conversation: the message's `delivery.status` goes from `queued` to `sent`, or to `failed` with a `reason`. Retry a failed send with Retry Record Email Delivery. Send an `Idempotency-Key` header to retry safely: the same key with the same request returns the first send and sends nothing new. Replies go to the template's Reply-To, or to the sending user when it has none. Answers `404` while email is not turned on for the company. **Required permission:** `email.send` and `.view` for the path's `{entityType}` (`event.view`, `exposure.view`, `quote.view` or `submission.view`). ## OpenAPI ````yaml /openapi/generated-external-api.yaml post /api/v1/companies/{companyId}/entities/{entityType}/{entityId}/emails openapi: 3.0.3 info: title: AI Insurance External API description: External API for AI Insurance platform version: 1.0.0 contact: email: support@aiinsurance.io servers: - url: https://go.aiinsurance.io description: Production security: - ApiKeyAuth: [] paths: /api/v1/companies/{companyId}/entities/{entityType}/{entityId}/emails: post: tags: - Record Emails summary: Send Record Email description: > Sends one template version from this record, or from one of its packets with `packetId`, the way Send email does in the app. The email is stored on the record at once and its delivery is queued; the response returns before it is sent. Follow it on Get Record Email Conversation: the message's `delivery.status` goes from `queued` to `sent`, or to `failed` with a `reason`. Retry a failed send with Retry Record Email Delivery. Send an `Idempotency-Key` header to retry safely: the same key with the same request returns the first send and sends nothing new. Replies go to the template's Reply-To, or to the sending user when it has none. Answers `404` while email is not turned on for the company. **Required permission:** `email.send` and `.view` for the path's `{entityType}` (`event.view`, `exposure.view`, `quote.view` or `submission.view`). operationId: sendRecordEmail parameters: - $ref: '#/components/parameters/companyId' - $ref: '#/components/parameters/crudEntityType' - $ref: '#/components/parameters/entityIdPath' - $ref: '#/components/parameters/idempotencyKey' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/SendEmailRequest' examples: fromRecord: summary: From the record value: templateId: 550e8400-e29b-41d4-a716-446655440401 to: - jill.ortiz@summit-brokers.example cc: [] fromPacket: summary: From a packet, with its PDF value: templateId: 550e8400-e29b-41d4-a716-446655440402 packetId: 550e8400-e29b-41d4-a716-446655440501 to: - jill.ortiz@summit-brokers.example cc: - underwriting@harborline.example attachPacket: true responses: '200': description: The email is stored and its delivery is queued content: application/json: schema: $ref: '#/components/schemas/EmailSendResult' examples: queued: summary: Queued value: deliveryId: 550e8400-e29b-41d4-a716-446655440601 messageId: 550e8400-e29b-41d4-a716-446655440602 threadId: 550e8400-e29b-41d4-a716-446655440603 '400': description: Bad Request - the send is incomplete or invalid content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' examples: needsRecipient: summary: No To address value: error: code: email-send-needs-recipient message: to is empty userMessages: - Add at least one To address. needsPacket: summary: The template needs a packet value: error: code: email-send-needs-packet message: template requires a packet userMessages: - This template is sent from a packet. Choose one. invalidIdempotencyKey: summary: >- The Idempotency-Key is not 1 to 255 printable ASCII characters value: error: code: INVALID_IDEMPOTENCY_KEY message: >- Idempotency-Key must be 1 to 255 printable ASCII characters. userMessages: - >- Idempotency-Key must be 1 to 255 printable ASCII characters. '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/Forbidden' '404': description: The record does not exist, or email is not turned on for the company content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' examples: recordNotFound: summary: Record not found value: error: code: NotFoundError message: Quote 550e8400-e29b-41d4-a716-446655440301 not found userMessages: - Quote 550e8400-e29b-41d4-a716-446655440301 not found '409': description: The packet cannot be attached content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' examples: packetFailed: summary: The packet failed to issue value: error: code: email-send-packet-failed message: >- packet 550e8400-e29b-41d4-a716-446655440501 failed to issue userMessages: - >- This packet failed to issue, so it cannot be attached. Retry issuing it first. '422': description: The Idempotency-Key was already used with a different request content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' examples: keyReused: summary: The key was used for a different send value: error: code: IDEMPOTENCY_KEY_REUSED message: >- Idempotency-Key was already used with a different request. userMessages: - >- Idempotency-Key was already used with a different request. '500': $ref: '#/components/responses/InternalServerError' security: - BearerAuth: [] - ApiKeyAuth: [] components: parameters: companyId: name: companyId in: path required: true schema: type: string format: uuid description: Company identifier crudEntityType: name: entityType in: path required: true schema: type: string enum: - event - exposure - quote - submission - person - organization description: > Field Model V1 entity type (lowercase kebab-case URL slug). One of the six CRUD entity types: `event`, `exposure`, `quote`, `submission`, `person`, `organization`. `policy` is NOT valid here — Policy has no generic CRUD (its writes go through the policy transaction endpoints), though it does have a read-only `/configuration` schema. entityIdPath: name: entityId in: path required: true schema: type: string format: uuid description: Entity identifier idempotencyKey: name: Idempotency-Key in: header required: false schema: type: string minLength: 1 maxLength: 255 pattern: ^[\x20-\x7E]{1,255}$ description: >- Optional key that makes a retry of this operation safe. Send a new value, 1 to 255 printable ASCII characters, for each intended operation, and send the same value with the same request when you retry it. A committed attempt reserves the key for 30 days from admission; retries do not extend that window. After 30 days the same key runs as a new request, even if its body differs. Within that window, a retry after the first request completed returns the original resource or run identity with the same status and response shape, without starting another operation. A failure before the intent commits stores nothing; after an external effect fails, a retry may resume that same committed intent. Keys belong to the credential, so another API key, even one the same user created, cannot replay them. Within 30 days, reusing a key with a different request returns `422 IDEMPOTENCY_KEY_REUSED`; an invalid key returns `400 INVALID_IDEMPOTENCY_KEY`. The key is compared exactly, so case and surrounding spaces count. schemas: SendEmailRequest: type: object required: - templateId - to - cc properties: templateId: type: string format: uuid description: >- The template version to send, from List Record Sendable Email Templates. Its record type must be the record's. packetId: type: string format: uuid description: >- A packet on this record to send from. Required by a template with `requiresPacket`. Its Packet URL smart tag becomes a working link to the packet. to: type: array minItems: 1 description: >- At least one address. Addresses are trimmed, lowercased and deduplicated. items: type: string format: email cc: type: array description: Addresses already in `to` are dropped. items: type: string format: email attachPacket: type: boolean default: false description: Attach the packet's issued PDF. Needs `packetId`. EmailSendResult: type: object required: - deliveryId - messageId - threadId properties: deliveryId: type: string format: uuid description: >- The send. Its status shows as `delivery` on the conversation's message. messageId: type: string format: uuid description: The stored email. threadId: type: string format: uuid description: >- The conversation the email starts. Read it with Get Record Email Conversation. ErrorResponse: type: object description: Standard error response for all external API endpoints required: - error properties: error: type: object required: - code - message properties: code: type: string description: Machine-readable error code example: VALIDATION_ERROR message: type: string description: Human-readable error message example: 'submissionId: Required field is missing' userMessages: type: array description: >- Clean, verbatim-displayable messages — one entry per failure, free of error-code tags, field paths, and internal noise. Suitable for showing to end users as-is. items: type: string example: - Exposures of type 'company' require an address details: type: array description: Additional details for validation errors (field-level errors) items: type: object properties: field: type: string description: The field that caused the error example: submissionId code: type: string description: Stable problem code for this individual validation failure example: BLANK_LIST_ELEMENT reason: type: string description: Stable reason the value violates its canonical contract example: blank-list-element expected: type: string description: The expected canonical value contract example: nonblank trimmed string message: type: string description: Description of the field error example: Required field is missing responses: Unauthorized: description: Unauthorized - Invalid or missing API key content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' examples: missingApiKey: summary: Missing API key value: error: code: AuthenticationError message: API key authentication required userMessages: - API key authentication required invalidApiKey: summary: >- Invalid API key (e.g. unknown key, or a Bearer token used instead of an API key) value: error: code: AuthenticationError message: Invalid API key userMessages: - Invalid API key Forbidden: description: Forbidden - Insufficient permissions content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' examples: insufficientPermissions: summary: Insufficient permissions value: error: code: AuthorizationError message: User is not authorized to perform the requested action userMessages: - User is not authorized to perform the requested action companyMismatch: summary: A valid API key naming another company in the URL value: error: code: AuthorizationError message: API key is not scoped to the requested company userMessages: - API key is not scoped to the requested company InternalServerError: description: Internal Server Error - Unexpected error occurred content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' examples: internalError: summary: Unexpected server error value: error: code: UncaughtActionError message: Uncaught error occurred in userMessages: - An unexpected error occurred. Please try again later. securitySchemes: ApiKeyAuth: type: apiKey in: header name: Authorization description: >- API key authentication. Send your raw API key as the `Authorization` header value with NO scheme prefix — `Authorization: YOUR-API-KEY`. Do NOT prefix it with `Bearer ` or `ApiKey `, and do not use an `X-API-Key` header; those are not accepted. BearerAuth: type: http scheme: bearer bearerFormat: JWT description: >- User-principal OAuth 2.0 Bearer authentication. Send a user-scoped Auth0 access token (audience = the app API audience) as `Authorization: Bearer `. The request resolves to the user's identity and is authorized by their Role on the `{companyId}` in the path — the same role-based permissions the web app enforces. This is the path the MCP connector uses to act on a user's behalf; endpoints that accept it list both `BearerAuth` and `ApiKeyAuth`. ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.