Input schema (JSON)
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"email",
"agentName",
"document",
"idempotencyKey"
],
"properties": {
"email": {
"type": "string",
"format": "email",
"pattern": "^(?:[A-Za-z0-9_'+\\-]+\\.)*[A-Za-z0-9_'+\\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$"
},
"document": {
"type": "object",
"required": [
"version",
"template",
"industry",
"businessName",
"headline",
"introduction",
"about",
"services",
"phone",
"email",
"bookingUrl",
"hours",
"serviceArea",
"colour",
"font",
"title",
"description",
"logo",
"gallery",
"sections"
],
"properties": {
"font": {
"type": "string"
},
"logo": {
"anyOf": [
{
"type": "object",
"required": [
"assetId",
"alt"
],
"properties": {
"alt": {
"type": "string"
},
"assetId": {
"type": "string"
}
}
},
{
"type": "null"
}
]
},
"about": {
"type": "string"
},
"email": {
"type": "string"
},
"hours": {
"type": "string"
},
"pages": {
"type": "array",
"items": {
"type": "object",
"required": [
"id",
"title",
"slug",
"isHome",
"showInNav",
"status",
"seo",
"sections",
"content"
],
"properties": {
"id": {
"type": "string",
"pattern": "^[a-zA-Z0-9-]{1,64}$"
},
"seo": {
"type": "object",
"required": [
"title",
"description",
"noindex",
"image"
],
"properties": {
"image": {
"anyOf": [
{
"type": "object",
"required": [
"assetId",
"alt"
],
"properties": {
"alt": {
"type": "string"
},
"assetId": {
"type": "string"
}
}
},
{
"type": "null"
}
]
},
"title": {
"type": "string",
"maxLength": 160
},
"noindex": {
"type": "boolean"
},
"description": {
"type": "string",
"maxLength": 320
}
}
},
"slug": {
"type": "string",
"maxLength": 63
},
"title": {
"type": "string",
"maxLength": 120,
"minLength": 1
},
"isHome": {
"type": "boolean"
},
"layout": {},
"status": {
"enum": [
"published",
"draft"
],
"type": "string"
},
"content": {
"type": "object",
"required": [
"headline",
"introduction",
"about",
"services",
"gallery"
],
"properties": {
"about": {
"type": "string"
},
"gallery": {
"type": "array",
"items": {
"type": "object",
"required": [
"assetId",
"alt"
],
"properties": {
"alt": {
"type": "string"
},
"assetId": {
"type": "string"
}
}
}
},
"headline": {
"type": "string"
},
"services": {
"type": "array",
"items": {
"type": "string"
}
},
"introduction": {
"type": "string"
}
}
},
"sections": {
"type": "array",
"items": {
"type": "object",
"required": [
"id",
"visible"
],
"properties": {
"id": {
"type": "string"
},
"visible": {
"type": "boolean"
}
}
}
},
"showInNav": {
"type": "boolean"
},
"blockPageId": {
"type": "string"
}
}
},
"maxItems": 100,
"minItems": 1
},
"phone": {
"type": "string"
},
"title": {
"type": "string"
},
"colour": {
"type": "string"
},
"layout": {},
"gallery": {
"type": "array",
"items": {
"type": "object",
"required": [
"assetId",
"alt"
],
"properties": {
"alt": {
"type": "string"
},
"assetId": {
"type": "string"
}
}
}
},
"version": {
"type": "number",
"const": 1
},
"headline": {
"type": "string"
},
"industry": {
"type": "string"
},
"sections": {
"type": "array",
"items": {
"type": "object",
"required": [
"id",
"visible"
],
"properties": {
"id": {
"type": "string"
},
"visible": {
"type": "boolean"
}
}
}
},
"services": {
"type": "array",
"items": {
"type": "string"
}
},
"template": {
"type": "string"
},
"redirects": {
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {
"type": "string"
}
},
"bookingUrl": {
"type": "string"
},
"blockLayout": {},
"description": {
"type": "string"
},
"serviceArea": {
"type": "string"
},
"businessName": {
"type": "string"
},
"introduction": {
"type": "string"
}
},
"additionalProperties": false
},
"agentName": {
"type": "string",
"maxLength": 80,
"minLength": 1
},
"idempotencyKey": {
"type": "string",
"pattern": "^[A-Za-z0-9_-]{8,128}$",
"description": "Unique random key for this operation; reuse exactly when retrying"
}
}
}