Raw schema
{
"type": "object",
"properties": {
"campaign_name": {
"type": "string",
"minLength": 1,
"maxLength": 200,
"description": "Name of a LIVE API campaign (see aisensy_list_api_campaigns)."
},
"phone_number": {
"description": "Phone number with country code, e.g. 919876543210 (digits; a leading + is dropped).",
"type": "string"
},
"name": {
"type": "string",
"minLength": 1,
"maxLength": 200,
"description": "Recipient's name."
},
"template_params": {
"description": "Values for the template's {{1}}, {{2}}... in order; the count must match the template.",
"maxItems": 20,
"type": "array",
"items": {
"type": "string",
"maxLength": 1000
}
},
"media_url": {
"description": "Public https URL of the image/video/document for a media template.",
"type": "string",
"maxLength": 2000
},
"media_filename": {
"description": "File name shown for the media.",
"type": "string",
"maxLength": 200
},
"tags": {
"description": "Existing tags to put on the contact (unknown tags are ignored).",
"maxItems": 20,
"type": "array",
"items": {
"type": "string",
"minLength": 1,
"maxLength": 100
}
},
"attributes": {
"type": "object",
"propertyNames": {
"type": "string",
"minLength": 1,
"maxLength": 100
},
"additionalProperties": {
"type": "string",
"maxLength": 1000
},
"description": "Contact attributes as name โ text value. AiSensy ignores attribute names that do not exist in the project."
},
"source": {
"description": "Lead source label.",
"type": "string",
"maxLength": 200
},
"default_country_code": {
"description": "Country code to assume when phone_number has none, e.g. 91.",
"type": "string",
"pattern": "^\\d{1,4}$"
},
"confirm": {
"type": "boolean",
"const": true,
"description": "Must be true. Set it only after the user has seen and approved the recipient and the message in this conversation."
}
},
"required": [
"campaign_name",
"phone_number",
"name",
"confirm"
],
"$schema": "https://json-schema.org/draft/2020-12/schema"
}