Skip to content
Documentation

Validate Email Content

GET
/api/v1/workspaces/{workspace_id}/emails/{id}/validate_email_content
curl --request GET \
  --url https://example.com/%7B%7Bapp_url%7D/api/v1/workspaces/1/emails/1/validate_email_content \
  --header 'Authorization: Bearer <token>'

Validates the email content.

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
workspace_id
required
integer

Workspace ID

id
required
integer

Email ID

Responses

Section titled “Responses”

200

Section titled “200”

Successful

Media typeapplication/json
object
valid
required
boolean
validation_errors
required
object
key
additional properties
object
key
additional properties
object
key
additional properties
object
key
additional properties
Array<string>
Examplegenerated
{
  "valid": true,
  "validation_errors": {
    "additionalProperty": {
      "additionalProperty": {
        "additionalProperty": {
          "additionalProperty": [
            "example"
          ]
        }
      }
    }
  }
}

401

Section titled “401”

Unauthorized

Media typeapplication/json
object
message
required
string
Example
{
  "message": "Record not found"
}

403

Section titled “403”

Forbidden

Media typeapplication/json
object
message
required
string
Example
{
  "message": "Record not found"
}

422

Section titled “422”

Unprocessable Entity

Media typeapplication/json
object
message
required
string
errors
required
object
key
additional properties
Array<string>
Example
{
  "errors": {
    "username": [
      "Username is required.",
      "Username must be unique."
    ],
    "email": [
      "Invalid email format."
    ]
  }
}