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

# Spam check email node

> Runs the sequence builder spam check on the stored subject and body of an email action node and returns the spam potential with a per-metric breakdown. Ratings (good, ok, bad) use the same thresholds as the builder. One result is returned per variant; variants with an empty subject and body are skipped. Read-only, the node is never modified.



## OpenAPI

````yaml https://multichannel-api.salesforge.ai/public/multichannel/swagger/doc.json get /multichannel/workspaces/{workspaceID}/sequences/{sequenceID}/nodes/{nodeID}/spam-check
openapi: 3.1.0
info:
  description: Multichannel public endpoints consumed through salesforge-api public docs.
  title: Multichannel Public API
  version: '1.0'
servers:
  - url: https://multichannel-api.salesforge.ai/public
security:
  - ApiKeyAuth: []
  - ApiKeyAuth: []
  - ApiKeyAuth: []
  - ApiKeyAuth: []
  - ApiKeyAuth: []
  - ApiKeyAuth: []
  - ApiKeyAuth: []
  - ApiKeyAuth: []
  - ApiKeyAuth: []
  - ApiKeyAuth: []
  - ApiKeyAuth: []
  - ApiKeyAuth: []
  - ApiKeyAuth: []
  - ApiKeyAuth: []
  - ApiKeyAuth: []
  - ApiKeyAuth: []
  - ApiKeyAuth: []
  - ApiKeyAuth: []
  - ApiKeyAuth: []
  - ApiKeyAuth: []
  - ApiKeyAuth: []
  - ApiKeyAuth: []
  - ApiKeyAuth: []
  - ApiKeyAuth: []
  - ApiKeyAuth: []
  - ApiKeyAuth: []
  - ApiKeyAuth: []
  - ApiKeyAuth: []
  - ApiKeyAuth: []
  - ApiKeyAuth: []
  - ApiKeyAuth: []
  - ApiKeyAuth: []
  - ApiKeyAuth: []
  - ApiKeyAuth: []
  - ApiKeyAuth: []
  - ApiKeyAuth: []
  - ApiKeyAuth: []
  - ApiKeyAuth: []
  - ApiKeyAuth: []
  - ApiKeyAuth: []
  - ApiKeyAuth: []
  - ApiKeyAuth: []
  - ApiKeyAuth: []
  - ApiKeyAuth: []
  - ApiKeyAuth: []
  - ApiKeyAuth: []
  - ApiKeyAuth: []
  - ApiKeyAuth: []
  - ApiKeyAuth: []
  - ApiKeyAuth: []
  - ApiKeyAuth: []
  - ApiKeyAuth: []
externalDocs:
  description: ''
  url: ''
paths:
  /multichannel/workspaces/{workspaceID}/sequences/{sequenceID}/nodes/{nodeID}/spam-check:
    get:
      tags:
        - multichannel
      summary: Spam check email node
      description: >-
        Runs the sequence builder spam check on the stored subject and body of
        an email action node and returns the spam potential with a per-metric
        breakdown. Ratings (good, ok, bad) use the same thresholds as the
        builder. One result is returned per variant; variants with an empty
        subject and body are skipped. Read-only, the node is never modified.
      parameters:
        - description: Workspace ID
          in: path
          name: workspaceID
          required: true
          schema:
            type: string
        - description: Sequence ID
          in: path
          name: sequenceID
          required: true
          schema:
            type: integer
        - description: Node ID
          in: path
          name: nodeID
          required: true
          schema:
            type: integer
        - description: Only check this variant of the node
          in: query
          name: variantId
          schema:
            type: integer
        - description: Spam word dictionary, defaults to american_english
          in: query
          name: language
          schema:
            enum:
              - american_english
              - british_english
              - spanish
              - french
              - german
              - italian
              - polish
              - russian
              - finnish
              - ukrainian
            type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/responses.NodeSpamCheckResponse'
          description: OK
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/responses.ErrorResponse'
          description: Bad Request
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/responses.ErrorResponse'
          description: Unauthorized
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/responses.ErrorResponse'
          description: Forbidden
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/responses.ErrorResponse'
          description: Workspace, sequence, node or variant not found
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/responses.ErrorResponse'
          description: >-
            Node is not an email action node, or the email node has an empty
            subject and body
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/responses.ErrorResponse'
          description: Internal Server Error
      security:
        - ApiKeyAuth: []
components:
  schemas:
    responses.NodeSpamCheckResponse:
      properties:
        language:
          example: american_english
          type: string
        nodeId:
          example: 1234
          type: integer
        variants:
          items:
            $ref: '#/components/schemas/responses.NodeVariantSpamCheckResponse'
          type: array
          uniqueItems: false
      type: object
    responses.ErrorResponse:
      properties:
        data:
          description: >-
            Optional error context. Its shape depends on the message and
            endpoint.
        message:
          description: >-
            Human-readable error text or, for documented cases, a stable
            machine-readable code that clients can branch on.
          example: Invalid request body
          type: string
      type: object
    responses.NodeVariantSpamCheckResponse:
      properties:
        isEnabled:
          example: true
          type: boolean
        metrics:
          $ref: '#/components/schemas/responses.SpamCheckMetricsResponse'
        name:
          example: Variant A
          type: string
        recommendations:
          example:
            - Avoid spam words
            - We recommend using plain text
          items:
            type: string
          type: array
          uniqueItems: false
        spamPotential:
          $ref: '#/components/schemas/responses.SpamPotentialResponse'
        variantId:
          example: 5678
          type: integer
      type: object
    responses.SpamCheckMetricsResponse:
      properties:
        emojis:
          $ref: '#/components/schemas/responses.SpamCheckMetricResponse'
        images:
          $ref: '#/components/schemas/responses.SpamCheckMetricResponse'
        links:
          $ref: '#/components/schemas/responses.SpamCheckMetricResponse'
        spamWords:
          $ref: '#/components/schemas/responses.SpamWordsMetricResponse'
        spintaxVariables:
          $ref: '#/components/schemas/responses.SpamCheckMetricResponse'
        wordCount:
          $ref: '#/components/schemas/responses.SpamCheckMetricResponse'
      type: object
    responses.SpamPotentialResponse:
      properties:
        interpretation:
          example: High spam potential
          type: string
        rating:
          $ref: '#/components/schemas/responses.SpamCheckRating'
        score:
          example: 80
          type: integer
      type: object
    responses.SpamCheckMetricResponse:
      properties:
        approximate:
          description: >-
            Approximate is true when the value is an estimate (word count with
            spintax or variables).
          example: false
          type: boolean
        rating:
          $ref: '#/components/schemas/responses.SpamCheckRating'
        unit:
          description: >-
            Unit is set when the value is not a plain count (for example
            "percent").
          example: percent
          type: string
        value:
          example: 2
          type: integer
      type: object
    responses.SpamWordsMetricResponse:
      properties:
        rating:
          $ref: '#/components/schemas/responses.SpamCheckRating'
        value:
          example: 2
          type: integer
        words:
          items:
            $ref: '#/components/schemas/responses.DetectedSpamWordResponse'
          type: array
          uniqueItems: false
      type: object
    responses.SpamCheckRating:
      enum:
        - good
        - ok
        - bad
        - good
        - ok
        - bad
        - good
        - ok
        - bad
        - good
        - ok
        - bad
      example: ok
      type: string
      x-enum-varnames:
        - SpamCheckRatingGood
        - SpamCheckRatingOK
        - SpamCheckRatingBad
    responses.DetectedSpamWordResponse:
      properties:
        score:
          example: 15
          type: integer
        seenCount:
          example: 1
          type: integer
        severity:
          enum:
            - yellow
            - orange
            - red
          example: yellow
          type: string
        word:
          example: free
          type: string
      type: object
  securitySchemes:
    ApiKeyAuth:
      in: header
      name: Authorization
      type: apiKey

````

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