Dry-run template submit validation

POST/v1/templates/validate-submit

Authorization

bearerAuthbearerAuthrequired

apiKeyAuthapiKeyAuthrequired

Request body

requiredapplication/json

body_textstringrequired

builder_jsonany

builder_versioninteger<int32>

buttonsTemplateButtonInput[] | null

Show properties

Array of TemplateButtonInput

examplestring

flow_actionstring

flow_idstring

navigate_screenstring

otp_typestring

package_namestring

phone_numberstring

signature_hashstring

textstringrequired

typestringrequired

urlstring

categorystringrequired

channel_idstring

editor_modestring

footer_textstring

header_formatstringrequired

header_handlestring

header_textstring

languagestringrequired

namestringrequired

variablesTemplateVariableInput[] | null

Show properties

Array of TemplateVariableInput

component_typestringrequired

display_namestringrequired

example_valuestringrequired

positioninteger<int32>required

source_keystring

source_typestringrequired

Responses

200OK

okbooleanrequired

400Bad Request

errorErrorBodyrequired

Show properties

codestringrequired

detailsErrorDetail[] | null

Show properties

Array of ErrorDetail

codestring

fieldstring

locationstring

messagestringrequired

request_idstring

401Unauthorized

errorErrorBodyrequired

Show properties

codestringrequired

detailsErrorDetail[] | null

Show properties

Array of ErrorDetail

codestring

fieldstring

locationstring

messagestringrequired

request_idstring

403Forbidden

errorErrorBodyrequired

Show properties

codestringrequired

detailsErrorDetail[] | null

Show properties

Array of ErrorDetail

codestring

fieldstring

locationstring

messagestringrequired

request_idstring

422Unprocessable Entity

errorErrorBodyrequired

Show properties

codestringrequired

detailsErrorDetail[] | null

Show properties

Array of ErrorDetail

codestring

fieldstring

locationstring

messagestringrequired

request_idstring

500Internal Server Error

errorErrorBodyrequired

Show properties

codestringrequired

detailsErrorDetail[] | null

Show properties

Array of ErrorDetail

codestring

fieldstring

locationstring

messagestringrequired

request_idstring

Request

curl -X POST "/v1/templates/validate-submit" \
  -H "Content-Type: application/json" \
  -d '{
  "body_text": "string",
  "builder_json": "string",
  "builder_version": 0,
  "buttons": [
    {
      "example": "string",
      "flow_action": "string",
      "flow_id": "string",
      "navigate_screen": "string",
      "otp_type": "string",
      "package_name": "string",
      "phone_number": "string",
      "signature_hash": "string",
      "text": "string",
      "type": "string",
      "url": "string"
    }
  ],
  "category": "string",
  "channel_id": "string",
  "editor_mode": "string",
  "footer_text": "string",
  "header_format": "string",
  "header_handle": "string",
  "header_text": "string",
  "language": "string",
  "name": "string",
  "variables": [
    {
      "component_type": "string",
      "display_name": "string",
      "example_value": "string",
      "position": 0,
      "source_key": "string",
      "source_type": "string"
    }
  ]
}'

const response = await fetch("/v1/templates/validate-submit", {
  method: "POST",
  headers: {
    "Content-Type": "application/json"
  },
  body: JSON.stringify({
  "body_text": "string",
  "builder_json": "string",
  "builder_version": 0,
  "buttons": [
    {
      "example": "string",
      "flow_action": "string",
      "flow_id": "string",
      "navigate_screen": "string",
      "otp_type": "string",
      "package_name": "string",
      "phone_number": "string",
      "signature_hash": "string",
      "text": "string",
      "type": "string",
      "url": "string"
    }
  ],
  "category": "string",
  "channel_id": "string",
  "editor_mode": "string",
  "footer_text": "string",
  "header_format": "string",
  "header_handle": "string",
  "header_text": "string",
  "language": "string",
  "name": "string",
  "variables": [
    {
      "component_type": "string",
      "display_name": "string",
      "example_value": "string",
      "position": 0,
      "source_key": "string",
      "source_type": "string"
    }
  ]
})
});

import requests

response = requests.post(
    "/v1/templates/validate-submit",
    headers={
        "Content-Type": "application/json"
    },
    json={
  "body_text": "string",
  "builder_json": "string",
  "builder_version": 0,
  "buttons": [
    {
      "example": "string",
      "flow_action": "string",
      "flow_id": "string",
      "navigate_screen": "string",
      "otp_type": "string",
      "package_name": "string",
      "phone_number": "string",
      "signature_hash": "string",
      "text": "string",
      "type": "string",
      "url": "string"
    }
  ],
  "category": "string",
  "channel_id": "string",
  "editor_mode": "string",
  "footer_text": "string",
  "header_format": "string",
  "header_handle": "string",
  "header_text": "string",
  "language": "string",
  "name": "string",
  "variables": [
    {
      "component_type": "string",
      "display_name": "string",
      "example_value": "string",
      "position": 0,
      "source_key": "string",
      "source_type": "string"
    }
  ]
},
)

Response

{
  "ok": true
}

{
  "error": {
    "code": "string",
    "details": [
      {
        "code": "string",
        "field": "string",
        "location": "string",
        "message": "string"
      }
    ],
    "message": "string",
    "request_id": "string"
  }
}

{
  "error": {
    "code": "string",
    "details": [
      {
        "code": "string",
        "field": "string",
        "location": "string",
        "message": "string"
      }
    ],
    "message": "string",
    "request_id": "string"
  }
}

{
  "error": {
    "code": "string",
    "details": [
      {
        "code": "string",
        "field": "string",
        "location": "string",
        "message": "string"
      }
    ],
    "message": "string",
    "request_id": "string"
  }
}

{
  "error": {
    "code": "string",
    "details": [
      {
        "code": "string",
        "field": "string",
        "location": "string",
        "message": "string"
      }
    ],
    "message": "string",
    "request_id": "string"
  }
}

{
  "error": {
    "code": "string",
    "details": [
      {
        "code": "string",
        "field": "string",
        "location": "string",
        "message": "string"
      }
    ],
    "message": "string",
    "request_id": "string"
  }
}