{ "$schema": "https://json-schema.org/draft/2020-12/schema", "$id": "https://raw.githubusercontent.com/api-evangelist/activecampaign/main/json-schema/activecampaign-flow-execution-contact-read-detail-schema.json", "title": "FlowExecutionContactReadDetail", "x-generated": "2026-10-12", "x-method": "derived", "x-generator": "derive-json-schema.py", "x-source": "openapi/activecampaign-flows-api-openapi.yml#/components/schemas/FlowExecutionContactReadDetail", "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "contact": { "allOf": [ { "$ref": "#/$defs/ContactReadSimple" } ], "description": "The Contact that the Flow Execution Contact is for." }, "status": { "$ref": "#/$defs/FlowExecutionContactStatusEnum" }, "execution_steps": { "type": "array", "items": { "$ref": "#/$defs/FlowExecutionStepReadDetail" }, "description": "The Flow Execution Steps that the Flow Execution Contact has." }, "created_on": { "type": "string", "format": "date-time", "title": "Creado el" }, "flow_execution": { "type": [ "string", "null" ], "format": "uuid" }, "status_reason": { "type": [ "string", "null" ], "readOnly": true }, "flow": { "allOf": [ { "$ref": "#/$defs/FlowListRead" } ], "description": "Details for the Flow" }, "flow_version": { "allOf": [ { "$ref": "#/$defs/FlowVersionSimpleListRead" } ], "description": "Details for the Flow Version" }, "status_triggered_by": { "allOf": [ { "$ref": "#/$defs/SimpleUser" } ], "readOnly": true }, "status_last_change_on": { "type": [ "string", "null" ], "format": "date-time", "readOnly": true }, "inbox_contact_id": { "type": "string", "format": "uuid", "readOnly": true }, "is_test": { "type": "boolean" } }, "required": [ "contact", "execution_steps", "flow", "flow_version", "inbox_contact_id", "status_last_change_on", "status_reason", "status_triggered_by" ], "$defs": { "ActionRequestMethodEnum": { "enum": [ "GET", "POST", "PUT", "PATCH", "DELETE" ], "type": "string", "description": "* `GET` - Get\n* `POST` - Post\n* `PUT` - Put\n* `PATCH` - Patch\n* `DELETE` - Delete" }, "AnswerOptionsRenderEnum": { "enum": [ "BUTTONS", "LIST", "EMOJIS", "NUMBERS" ], "type": "string", "description": "* `BUTTONS` - Buttons\n* `LIST` - List\n* `EMOJIS` - Emojis\n* `NUMBERS` - Numbers" }, "AnswerPhoneDefaultCountryEnum": { "enum": [ "AF", "AX", "AL", "DZ", "AS", "AD", "AO", "AI", "AQ", "AG", "AR", "AM", "AW", "AU", "AT", "AZ", "BS", "BH", "BD", "BB", "BY", "BE", "BZ", "BJ", "BM", "BT", "BO", "BQ", "BA", "BW", "BV", "BR", "IO", "BN", "BG", "BF", "BI", "CV", "KH", "CM", "CA", "KY", "CF", "TD", "CL", "CN", "CX", "CC", "CO", "KM", "CG", "CD", "CK", "CR", "CI", "HR", "CU", "CW", "CY", "CZ", "DK", "DJ", "DM", "DO", "EC", "EG", "SV", "GQ", "ER", "EE", "SZ", "ET", "FK", "FO", "FJ", "FI", "FR", "GF", "PF", "TF", "GA", "GM", "GE", "DE", "GH", "GI", "GR", "GL", "GD", "GP", "GU", "GT", "GG", "GN", "GW", "GY", "HT", "HM", "VA", "HN", "HK", "HU", "IS", "IN", "ID", "IR", "IQ", "IE", "IM", "IL", "IT", "JM", "JP", "JE", "JO", "KZ", "KE", "KI", "KW", "KG", "LA", "LV", "LB", "LS", "LR", "LY", "LI", "LT", "LU", "MO", "MG", "MW", "MY", "MV", "ML", "MT", "MH", "MQ", "MR", "MU", "YT", "MX", "FM", "MD", "MC", "MN", "ME", "MS", "MA", "MZ", "MM", "NA", "NR", "NP", "NL", "NC", "NZ", "NI", "NE", "NG", "NU", "NF", "KP", "MK", "MP", "NO", "OM", "PK", "PW", "PS", "PA", "PG", "PY", "PE", "PH", "PN", "PL", "PT", "PR", "QA", "RE", "RO", "RU", "RW", "BL", "SH", "KN", "LC", "MF", "PM", "VC", "WS", "SM", "ST", "SA", "SN", "RS", "SC", "SL", "SG", "SX", "SK", "SI", "SB", "SO", "ZA", "GS", "KR", "SS", "ES", "LK", "SD", "SR", "SJ", "SE", "CH", "SY", "TW", "TJ", "TZ", "TH", "TL", "TG", "TK", "TO", "TT", "TN", "TR", "TM", "TC", "TV", "UG", "UA", "AE", "GB", "UM", "US", "UY", "UZ", "VU", "VE", "VN", "VG", "VI", "WF", "EH", "YE", "ZM", "ZW" ], "type": "string", "description": "* `AF` - Afghanistan\n* `AX` - Åland Islands\n* `AL` - Albania\n* `DZ` - Algeria\n* `AS` - American Samoa\n* `AD` - Andorra\n* `AO` - Angola\n* `AI` - Anguilla\n* `AQ` - Antarctica\n* `AG` - Antigua and Barbuda\n* `AR` - Argentina\n* `AM` - Armenia\n* `AW` - Aruba\n* `AU` - Australia\n* `AT` - Austria\n* `AZ` - Azerbaijan\n* `BS` - Bahamas\n* `BH` - Bahrain\n* `BD` - Bangladesh\n* `BB` - Barbados\n* `BY` - Belarus\n* `BE` - Belgium\n* `BZ` - Belize\n* `BJ` - Benin\n* `BM` - Bermuda\n* `BT` - Bhutan\n* `BO` - Bolivia\n* `BQ` - Bonaire, Sint Eustatius and Saba\n* `BA` - Bosnia and Herzegovina\n* `BW` - Botswana\n* `BV` - Bouvet Island\n* `BR` - Brazil\n* `IO` - British Indian Ocean Territory\n* `BN` - Brunei\n* `BG` - Bulgaria\n* `BF` - Burkina Faso\n* `BI` - Burundi\n* `CV` - Cabo Verde\n* `KH` - Cambodia\n* `CM` - Cameroon\n* `CA` - Canada\n* `KY` - Cayman Islands\n* `CF` - Central African Republic\n* `TD` - Chad\n* `CL` - Chile\n* `CN` - China\n* `CX` - Christmas Island\n* `CC` - Cocos (Keeling) Islands\n* `CO` - Colombia\n* `KM` - Comoros\n* `CG` - Congo\n* `CD` - Congo (the Democratic Republic of the)\n* `CK` - Cook Islands\n* `CR` - Costa Rica\n* `CI` - Côte d'Ivoire\n* `HR` - Croatia\n* `CU` - Cuba\n* `CW` - Curaçao\n* `CY` - Cyprus\n* `CZ` - Czechia\n* `DK` - Denmark\n* `DJ` - Djibouti\n* `DM` - Dominica\n* `DO` - Dominican Republic\n* `EC` - Ecuador\n* `EG` - Egypt\n* `SV` - El Salvador\n* `GQ` - Equatorial Guinea\n* `ER` - Eritrea\n* `EE` - Estonia\n* `SZ` - Eswatini\n* `ET` - Ethiopia\n* `FK` - Falkland Islands (Malvinas)\n* `FO` - Faroe Islands\n* `FJ` - Fiji\n* `FI` - Finland\n* `FR` - France\n* `GF` - French Guiana\n* `PF` - French Polynesia\n* `TF` - French Southern Territories\n* `GA` - Gabon\n* `GM` - Gambia\n* `GE` - Georgia\n* `DE` - Germany\n* `GH` - Ghana\n* `GI` - Gibraltar\n* `GR` - Greece\n* `GL` - Greenland\n* `GD` - Grenada\n* `GP` - Guadeloupe\n* `GU` - Guam\n* `GT` - Guatemala\n* `GG` - Guernsey\n* `GN` - Guinea\n* `GW` - Guinea-Bissau\n* `GY` - Guyana\n* `HT` - Haiti\n* `HM` - Heard Island and McDonald Islands\n* `VA` - Holy See\n* `HN` - Honduras\n* `HK` - Hong Kong\n* `HU` - Hungary\n* `IS` - Iceland\n* `IN` - India\n* `ID` - Indonesia\n* `IR` - Iran\n* `IQ` - Iraq\n* `IE` - Ireland\n* `IM` - Isle of Man\n* `IL` - Israel\n* `IT` - Italy\n* `JM` - Jamaica\n* `JP` - Japan\n* `JE` - Jersey\n* `JO` - Jordan\n* `KZ` - Kazakhstan\n* `KE` - Kenya\n* `KI` - Kiribati\n* `KW` - Kuwait\n* `KG` - Kyrgyzstan\n* `LA` - Laos\n* `LV` - Latvia\n* `LB` - Lebanon\n* `LS` - Lesotho\n* `LR` - Liberia\n* `LY` - Libya\n* `LI` - Liechtenstein\n* `LT` - Lithuania\n* `LU` - Luxembourg\n* `MO` - Macao\n* `MG` - Madagascar\n* `MW` - Malawi\n* `MY` - Malaysia\n* `MV` - Maldives\n* `ML` - Mali\n* `MT` - Malta\n* `MH` - Marshall Islands\n* `MQ` - Martinique\n* `MR` - Mauritania\n* `MU` - Mauritius\n* `YT` - Mayotte\n* `MX` - Mexico\n* `FM` - Micronesia\n* `MD` - Moldova\n* `MC` - Monaco\n* `MN` - Mongolia\n* `ME` - Montenegro\n* `MS` - Montserrat\n* `MA` - Morocco\n* `MZ` - Mozambique\n* `MM` - Myanmar\n* `NA` - Namibia\n* `NR` - Nauru\n* `NP` - Nepal\n* `NL` - Netherlands\n* `NC` - New Caledonia\n* `NZ` - New Zealand\n* `NI` - Nicaragua\n* `NE` - Niger\n* `NG` - Nigeria\n* `NU` - Niue\n* `NF` - Norfolk Island\n* `KP` - North Korea\n* `MK` - North Macedonia\n* `MP` - Northern Mariana Islands\n* `NO` - Norway\n* `OM` - Oman\n* `PK` - Pakistan\n* `PW` - Palau\n* `PS` - Palestine, State of\n* `PA` - Panama\n* `PG` - Papua New Guinea\n* `PY` - Paraguay\n* `PE` - Peru\n* `PH` - Philippines\n* `PN` - Pitcairn\n* `PL` - Poland\n* `PT` - Portugal\n* `PR` - Puerto Rico\n* `QA` - Qatar\n* `RE` - Réunion\n* `RO` - Romania\n* `RU` - Russia\n* `RW` - Rwanda\n* `BL` - Saint Barthélemy\n* `SH` - Saint Helena, Ascension and Tristan da Cunha\n* `KN` - Saint Kitts and Nevis\n* `LC` - Saint Lucia\n* `MF` - Saint Martin (French part)\n* `PM` - Saint Pierre and Miquelon\n* `VC` - Saint Vincent and the Grenadines\n* `WS` - Samoa\n* `SM` - San Marino\n* `ST` - Sao Tome and Principe\n* `SA` - Saudi Arabia\n* `SN` - Senegal\n* `RS` - Serbia\n* `SC` - Seychelles\n* `SL` - Sierra Leone\n* `SG` - Singapore\n* `SX` - Sint Maarten (Dutch part)\n* `SK` - Slovakia\n* `SI` - Slovenia\n* `SB` - Solomon Islands\n* `SO` - Somalia\n* `ZA` - South Africa\n* `GS` - South Georgia and the South Sandwich Islands\n* `KR` - South Korea\n* `SS` - South Sudan\n* `ES` - Spain\n* `LK` - Sri Lanka\n* `SD` - Sudan\n* `SR` - Suriname\n* `SJ` - Svalbard and Jan Mayen\n* `SE` - Sweden\n* `CH` - Switzerland\n* `SY` - Syria\n* `TW` - Taiwan\n* `TJ` - Tajikistan\n* `TZ` - Tanzania\n* `TH` - Thailand\n* `TL` - Timor-Leste\n* `TG` - Togo\n* `TK` - Tokelau\n* `TO` - Tonga\n* `TT` - Trinidad and Tobago\n* `TN` - Tunisia\n* `TR` - Türkiye\n* `TM` - Turkmenistan\n* `TC` - Turks and Caicos Islands\n* `TV` - Tuvalu\n* `UG` - Uganda\n* `UA` - Ukraine\n* `AE` - United Arab Emirates\n* `GB` - United Kingdom\n* `UM` - United States Minor Outlying Islands\n* `US` - United States of America\n* `UY` - Uruguay\n* `UZ` - Uzbekistan\n* `VU` - Vanuatu\n* `VE` - Venezuela\n* `VN` - Vietnam\n* `VG` - Virgin Islands (British)\n* `VI` - Virgin Islands (U.S.)\n* `WF` - Wallis and Futuna\n* `EH` - Western Sahara\n* `YE` - Yemen\n* `ZM` - Zambia\n* `ZW` - Zimbabwe" }, "AnswerTypeEnum": { "enum": [ "ANY", "FREE_TEXT", "SINGLE_OPTION", "NUMBER", "URL", "EMAIL", "FILE", "DOCUMENT", "VIDEO", "IMAGE", "PHONE", "DATE", "TIME", "DATETIME", "BOOL", "LOCATION" ], "type": "string", "description": "* `ANY` - Any\n* `FREE_TEXT` - Free Text\n* `SINGLE_OPTION` - Single Option\n* `NUMBER` - Number\n* `URL` - Url\n* `EMAIL` - Email\n* `FILE` - File\n* `DOCUMENT` - Document\n* `VIDEO` - Video\n* `IMAGE` - Image\n* `PHONE` - Phone\n* `DATE` - Date\n* `TIME` - Time\n* `DATETIME` - Datetime\n* `BOOL` - Bool\n* `LOCATION` - Location" }, "BlankEnum": { "enum": [ "" ] }, "BodyFileTypeEnum": { "enum": [ "URL", "UPLOAD" ], "type": "string", "description": "* `URL` - Url\n* `UPLOAD` - Upload" }, "CategoryEnum": { "enum": [ "ACCOUNT_UPDATE", "PAYMENT_UPDATE", "PERSONAL_FINANCE_UPDATE", "SHIPPING_UPDATE", "RESERVATION_UPDATE", "ISSUE_RESOLUTION", "APPOINTMENT_UPDATE", "TRANSPORTATION_UPDATE", "TICKET_UPDATE", "ALERT_UPDATE", "AUTO_REPLY", "TRANSACTIONAL", "MARKETING", "OTP", "AUTHENTICATION", "UTILITY" ], "type": "string", "description": "* `ACCOUNT_UPDATE` - Account Update\n* `PAYMENT_UPDATE` - Payment Update\n* `PERSONAL_FINANCE_UPDATE` - Personal Finance Update\n* `SHIPPING_UPDATE` - Shipping Update\n* `RESERVATION_UPDATE` - Reservation Update\n* `ISSUE_RESOLUTION` - Issue Resolution\n* `APPOINTMENT_UPDATE` - Appointment Update\n* `TRANSPORTATION_UPDATE` - Transportation Update\n* `TICKET_UPDATE` - Ticket Update\n* `ALERT_UPDATE` - Alert Update\n* `AUTO_REPLY` - Auto Reply\n* `TRANSACTIONAL` - Transactional\n* `MARKETING` - Marketing\n* `OTP` - Otp\n* `AUTHENTICATION` - Authentication\n* `UTILITY` - Utility" }, "ChannelProviderEnum": { "enum": [ "META_CLOUD_API", "TECH_PROVIDER_CLOUD_API", "D360_CLOUD_API", "360DIALOG" ], "type": "string", "description": "* `META_CLOUD_API` - Meta Cloud Api\n* `TECH_PROVIDER_CLOUD_API` - Tech Provider Cloud Api\n* `D360_CLOUD_API` - D360 Cloud Api\n* `360DIALOG` - Dialog360" }, "ChannelStatusEnum": { "enum": [ "NEW", "ACTIVE", "INACTIVE" ], "type": "string", "description": "* `NEW` - New\n* `ACTIVE` - Active\n* `INACTIVE` - Inactive" }, "ChannelTypeEnum": { "enum": [ "WHATSAPP", "EMAIL", "INSTAGRAM", "FB_MESSENGER", "TELEGRAM", "SMS", "VOICE" ], "type": "string", "description": "* `WHATSAPP` - Whatsapp\n* `EMAIL` - Email\n* `INSTAGRAM` - Instagram\n* `FB_MESSENGER` - Fb Messenger\n* `TELEGRAM` - Telegram\n* `SMS` - Sms\n* `VOICE` - Voice" }, "ComparisonEnum": { "enum": [ "exact", "!exact", "gte", "gt", "lte", "lt", "isnull", "!isnull", "icontains", "!icontains" ], "type": "string", "description": "* `exact` - Exact\n* `!exact` - Different\n* `gte` - Gte\n* `gt` - Gt\n* `lte` - Lte\n* `lt` - Lt\n* `isnull` - Is Null\n* `!isnull` - Not Null\n* `icontains` - Contains\n* `!icontains` - Not Contains" }, "ContactMessage": { "type": "object", "properties": { "addresses": { "type": "array", "items": { "type": "object", "additionalProperties": { "type": [ "string", "null" ] } } }, "emails": { "type": "array", "items": { "type": "object", "additionalProperties": { "type": [ "string", "null" ] } } }, "ims": { "type": "array", "items": { "type": "object", "additionalProperties": { "type": [ "string", "null" ] } } }, "urls": { "type": "array", "items": { "type": "string", "maxLength": 255 } }, "name": { "type": "object", "additionalProperties": { "type": [ "string", "null" ] } }, "phones": { "type": "array", "items": { "type": "object", "additionalProperties": { "type": [ "string", "null" ] } } }, "org": { "type": "object", "additionalProperties": { "type": [ "string", "null" ] } } } }, "ContactReadSimple": { "type": "object", "properties": { "first_name": { "type": [ "string", "null" ], "maxLength": 100 }, "last_name": { "type": [ "string", "null" ], "maxLength": 100 }, "email": { "type": [ "string", "null" ], "format": "email", "maxLength": 254 }, "meta": {}, "canonical_phone": { "type": [ "string", "null" ], "maxLength": 30 }, "is_deleted": { "type": "boolean" }, "phone": { "type": "string" }, "id": { "type": "string" }, "created_on": { "type": "string", "format": "date-time", "title": "Creado el" }, "last_updated_on": { "type": "string", "format": "date-time", "readOnly": true, "title": "Última actualización el" }, "source": { "type": "string", "maxLength": 255 }, "external_url": { "type": [ "string", "null" ], "format": "uri", "maxLength": 200 } }, "required": [ "id", "last_updated_on", "phone", "source" ] }, "FlowExecutionContactStatusEnum": { "enum": [ "READY", "RUNNING", "COMPLETED", "CANCELED", "EXPIRED", "FAILED" ], "type": "string", "description": "* `READY` - Ready\n* `RUNNING` - Running\n* `COMPLETED` - Completed\n* `CANCELED` - Canceled\n* `EXPIRED` - Expired\n* `FAILED` - Failed" }, "FlowExecutionStepReadDetail": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "step": { "allOf": [ { "$ref": "#/$defs/FlowStepEdit" } ], "readOnly": true }, "status_reason": { "type": [ "string", "null" ] }, "has_error": { "type": "boolean" }, "expire_on": { "type": [ "string", "null" ], "format": "date-time" }, "status": { "$ref": "#/$defs/FlowExecutionStepReadDetailStatusEnum" }, "validation_failed_attempts": { "type": "integer", "maximum": 32767, "minimum": 0 }, "execution_result": {}, "request_data": {}, "messages": { "type": "array", "items": { "$ref": "#/$defs/FlowExecutionStepWhatsAppMessage" } }, "created_on": { "type": "string", "format": "date-time", "title": "Creado el" }, "status_triggered_by": { "type": [ "integer", "null" ] }, "status_last_change_on": { "type": [ "string", "null" ], "format": "date-time" } }, "required": [ "messages", "step" ] }, "FlowExecutionStepReadDetailStatusEnum": { "enum": [ "WAITING_TO_START", "NOT_EXECUTED", "RUNNING", "COMPLETED", "CANCELED", "FAILED", "EXPIRED" ], "type": "string", "description": "* `WAITING_TO_START` - Waiting To Start\n* `NOT_EXECUTED` - Not Executed\n* `RUNNING` - Running\n* `COMPLETED` - Completed\n* `CANCELED` - Canceled\n* `FAILED` - Failed\n* `EXPIRED` - Expired" }, "FlowExecutionStepWhatsAppMessage": { "type": "object", "properties": { "message": { "$ref": "#/$defs/WhatsAppMessage" } }, "required": [ "message" ] }, "FlowListRead": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "readOnly": true }, "name": { "type": "string", "maxLength": 100 }, "created_by": { "allOf": [ { "$ref": "#/$defs/SimpleUser" } ], "readOnly": true }, "created_on": { "type": "string", "format": "date-time", "title": "Creado el" }, "is_active": { "type": "boolean" }, "status": { "$ref": "#/$defs/FlowStatusEnum" }, "is_legacy": { "type": "boolean" }, "channel": { "allOf": [ { "$ref": "#/$defs/SimpleChannel" } ], "readOnly": true }, "num_contacts": { "type": "integer", "maximum": 2147483647, "minimum": 0 }, "expired": { "type": "integer", "maximum": 2147483647, "minimum": 0 }, "running": { "type": "integer", "maximum": 2147483647, "minimum": 0 }, "completed": { "type": "integer", "maximum": 2147483647, "minimum": 0 }, "canceled": { "type": "integer", "maximum": 2147483647, "minimum": 0 }, "failed": { "type": "integer", "maximum": 2147483647, "minimum": 0 }, "needs_update": { "type": "boolean" }, "avg_completion_time": { "type": "string" }, "current_version": { "type": [ "string", "null" ], "format": "uuid" }, "is_template": { "type": "boolean" }, "trigger_type": { "$ref": "#/$defs/TriggerTypeEnum" }, "trigger_config": {}, "test_version": { "type": [ "string", "null" ], "format": "uuid" }, "upgrade_version": { "type": [ "string", "null" ], "format": "uuid" }, "legacy_version": { "type": [ "string", "null" ], "format": "uuid" } }, "required": [ "channel", "created_by", "id", "name", "trigger_type" ] }, "FlowStatusEnum": { "enum": [ "DRAFT", "PUBLISHED" ], "type": "string", "description": "* `DRAFT` - Draft\n* `PUBLISHED` - Published" }, "FlowStepContactUpdateCustomProperty": { "type": "object", "properties": { "key": { "type": "string" }, "value": { "type": "string" } }, "required": [ "key", "value" ] }, "FlowStepEdit": { "type": "object", "description": "This class is not useful other than for the OpenAPI Schema.", "properties": { "flow_version": { "type": "string", "format": "uuid" }, "name": { "type": "string", "maxLength": 100 }, "step_type": { "type": "string", "maxLength": 100 }, "next_step_default_idx": { "type": [ "integer", "null" ], "maximum": 32767, "minimum": 0 }, "id": { "type": "string", "format": "uuid" }, "next_step_default": { "type": "string", "format": "uuid" }, "next_step_alternate": { "type": "string", "format": "uuid" }, "answer_failed_next_step": { "type": [ "string", "null" ], "format": "uuid" }, "next_steps_for_options": { "type": "array", "items": { "type": "string", "format": "uuid" } }, "answer_type": { "oneOf": [ { "$ref": "#/$defs/AnswerTypeEnum" }, { "$ref": "#/$defs/BlankEnum" }, { "$ref": "#/$defs/NullEnum" } ] }, "body": { "type": [ "string", "null" ] }, "body_type": { "oneOf": [ { "$ref": "#/$defs/MessageTypeEnum" }, { "$ref": "#/$defs/BlankEnum" }, { "$ref": "#/$defs/NullEnum" } ] }, "body_file_url": { "type": [ "string", "null" ], "format": "uri", "maxLength": 2000 }, "body_file_type": { "oneOf": [ { "$ref": "#/$defs/BodyFileTypeEnum" }, { "$ref": "#/$defs/BlankEnum" }, { "$ref": "#/$defs/NullEnum" } ] }, "body_file": { "allOf": [ { "$ref": "#/$defs/UploadedAccountFile" } ], "readOnly": true }, "answer_validation_message": { "type": [ "string", "null" ] }, "answer_instructions": { "type": [ "string", "null" ] }, "answer_options": { "type": [ "array", "null" ], "items": { "type": "string", "maxLength": 255 } }, "answer_phone_default_country": { "oneOf": [ { "$ref": "#/$defs/AnswerPhoneDefaultCountryEnum" }, { "$ref": "#/$defs/BlankEnum" }, { "$ref": "#/$defs/NullEnum" } ] }, "next_step_alternate_idx": { "type": [ "integer", "null" ], "maximum": 32767, "minimum": 0 }, "conditions": { "type": "array", "items": { "$ref": "#/$defs/StepConditionalCondition" } }, "delay_type": { "type": [ "string", "null" ], "maxLength": 20 }, "delay_until": { "type": [ "string", "null" ], "format": "date-time" }, "action_request_method": { "oneOf": [ { "$ref": "#/$defs/ActionRequestMethodEnum" }, { "$ref": "#/$defs/BlankEnum" }, { "$ref": "#/$defs/NullEnum" } ] }, "action_request_url": { "type": [ "string", "null" ], "format": "uri", "maxLength": 2000 }, "action_request_headers": { "type": [ "object", "null" ], "additionalProperties": { "type": [ "string", "null" ] } }, "action_request_params": { "type": [ "object", "null" ], "additionalProperties": { "type": [ "string", "null" ] } }, "action_request_body": { "type": [ "string", "null" ] }, "action_test_response_data": { "type": [ "string", "null" ], "format": "uuid" }, "answer_allow_decimals": { "type": "boolean" }, "answer_range_min": { "type": [ "string", "null" ], "maxLength": 50 }, "answer_range_max": { "type": [ "string", "null" ], "maxLength": 50 }, "answer_has_range": { "type": "boolean" }, "assign_to_users": { "type": "array", "items": { "type": "integer" }, "readOnly": true }, "ordering_idx": { "type": "integer", "maximum": 32767, "minimum": 0 }, "has_options_from_variable": { "type": "boolean" }, "option_from_variable_value": { "type": [ "string", "null" ] }, "options_from_variable": { "type": [ "string", "null" ] }, "option_from_variable_title": { "type": [ "string", "null" ] }, "option_from_variable_description": { "type": [ "string", "null" ] }, "missing_options_message": { "type": [ "string", "null" ] }, "answer_options_render": { "$ref": "#/$defs/AnswerOptionsRenderEnum" }, "answer_options_render_list_button_title": { "type": [ "string", "null" ], "maxLength": 20 }, "answer_option_descriptions": { "type": [ "array", "null" ], "items": { "type": [ "string", "null" ] } }, "next_steps_for_options_idx": { "type": [ "array", "null" ], "items": { "type": [ "integer", "null" ], "maximum": 2147483647, "minimum": -2147483648 } }, "contact_tags": { "type": [ "array", "null" ], "items": { "type": "string", "maxLength": 255 } }, "conversation_tags": { "type": [ "array", "null" ], "items": { "type": "string", "maxLength": 255 } }, "append_tags": { "type": "boolean" }, "max_wait_time_amount": { "type": "integer", "maximum": 32767, "minimum": 0 }, "max_wait_time_unit": { "$ref": "#/$defs/MaxWaitTimeUnitEnum" }, "time_windows": { "type": "array", "items": { "$ref": "#/$defs/FlowStepTimeWindow" } }, "has_max_wait_time": { "type": "boolean" }, "set_time_window": { "type": "boolean" }, "assign_to_teams": { "type": "array", "items": { "type": "integer" }, "readOnly": true }, "time_window_type": { "oneOf": [ { "$ref": "#/$defs/TimeWindowTypeEnum" }, { "$ref": "#/$defs/BlankEnum" }, { "$ref": "#/$defs/NullEnum" } ] }, "has_max_answer_attempts": { "type": "boolean" }, "max_answer_attempts": { "type": "integer", "maximum": 32767, "minimum": 0 }, "answer_failed_next_step_idx": { "type": [ "integer", "null" ], "maximum": 32767, "minimum": 0 }, "whatsapp_template": { "type": "string", "format": "uuid", "readOnly": true }, "whatsapp_template_variables": { "readOnly": true }, "save_contact_answer": { "type": "boolean", "default": false }, "validate_answer_with_buttons": { "type": "boolean", "default": false }, "contact_custom_properties": { "type": "array", "items": { "$ref": "#/$defs/FlowStepContactUpdateCustomProperty" } }, "contact_first_name": { "type": "string" }, "contact_last_name": { "type": "string" }, "contact_email": { "type": "string" }, "contact_external_url": { "type": "string" }, "next_flow": { "type": "string" }, "paths": { "type": "array", "items": { "$ref": "#/$defs/StepConditionalMultilpePath" } }, "firstname": { "type": "string" }, "lastname": { "type": "string" }, "email": { "type": "string" }, "custom_properties": { "type": "array", "items": { "type": "string" } }, "next_action": { "$ref": "#/$defs/NextActionEnum" } }, "required": [ "assign_to_teams", "assign_to_users", "body_file", "conditions", "flow_version", "name", "next_steps_for_options", "step_type", "time_windows", "whatsapp_template", "whatsapp_template_variables" ] }, "FlowStepTimeWindow": { "type": "object", "properties": { "weekday": { "allOf": [ { "$ref": "#/$defs/WeekdayEnum" } ], "minimum": 0, "maximum": 32767 }, "is_available": { "type": "boolean" }, "start_at": { "type": [ "string", "null" ], "format": "time" }, "end_at": { "type": [ "string", "null" ], "format": "time" } }, "required": [ "weekday" ] }, "FlowVersionSimpleListRead": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "version_name": { "type": "string", "maxLength": 255 }, "version_description": { "type": [ "string", "null" ] }, "published_by": { "allOf": [ { "$ref": "#/$defs/SimpleUser" } ], "readOnly": true }, "created_on": { "type": "string", "format": "date-time", "title": "Creado el" }, "last_updated_on": { "type": "string", "format": "date-time", "readOnly": true, "title": "Última actualización el" }, "num_contacts": { "type": "integer", "maximum": 2147483647, "minimum": 0 }, "completed": { "type": "integer", "maximum": 2147483647, "minimum": 0 }, "expired": { "type": "integer", "maximum": 2147483647, "minimum": 0 }, "running": { "type": "integer", "maximum": 2147483647, "minimum": 0 }, "canceled": { "type": "integer", "maximum": 2147483647, "minimum": 0 }, "failed": { "type": "integer", "maximum": 2147483647, "minimum": 0 }, "avg_completion_time": { "type": "string" }, "is_current_version": { "type": "boolean", "readOnly": true } }, "required": [ "is_current_version", "last_updated_on", "published_by" ] }, "LanguageEnum": { "enum": [ "af", "sq", "ar", "az", "bn", "bg", "ca", "zh_CN", "zh_HK", "zh_TW", "hr", "cs", "da", "nl", "en", "en_GB", "en_US", "et", "fil", "fi", "fr", "ka", "de", "el", "gu", "ha", "he", "hi", "hu", "id", "ga", "it", "ja", "kn", "kk", "rw_RW", "ko", "ky_KG", "lo", "lv", "lt", "mk", "ms", "ml", "mr", "nb", "fa", "pl", "pt_BR", "pt_PT", "pa", "ro", "ru", "sr", "sk", "sl", "es", "es_AR", "es_ES", "es_MX", "sw", "sv", "ta", "te", "th", "tr", "uk", "ur", "uz", "vi", "zu" ], "type": "string", "description": "* `af` - Afrikaans\n* `sq` - Albanian\n* `ar` - Arabic\n* `az` - Azerbaijani\n* `bn` - Bengali\n* `bg` - Bulgarian\n* `ca` - Catalan\n* `zh_CN` - Chinese (CHN)\n* `zh_HK` - Chinese (HKG)\n* `zh_TW` - Chinese (TAI)\n* `hr` - Croatian\n* `cs` - Czech\n* `da` - Danish\n* `nl` - Dutch\n* `en` - English\n* `en_GB` - English (UK)\n* `en_US` - English (US)\n* `et` - Estonian\n* `fil` - Filipino\n* `fi` - Finnish\n* `fr` - French\n* `ka` - Georgian\n* `de` - German\n* `el` - Greek\n* `gu` - Gujarati\n* `ha` - Hausa\n* `he` - Hebrew\n* `hi` - Hindi\n* `hu` - Hungarian\n* `id` - Indonesian\n* `ga` - Irish\n* `it` - Italian\n* `ja` - Japanese\n* `kn` - Kannada\n* `kk` - Kazakh\n* `rw_RW` - Kinyarwanda\n* `ko` - Korean\n* `ky_KG` - Kyrgyz (Kyrgyzstan)\n* `lo` - Lao\n* `lv` - Latvian\n* `lt` - Lithuanian\n* `mk` - Macedonian\n* `ms` - Malay\n* `ml` - Malayalam\n* `mr` - Marathi\n* `nb` - Norwegian\n* `fa` - Persian\n* `pl` - Polish\n* `pt_BR` - Portuguese (BR)\n* `pt_PT` - Portuguese (POR)\n* `pa` - Punjabi\n* `ro` - Romanian\n* `ru` - Russian\n* `sr` - Serbian\n* `sk` - Slovak\n* `sl` - Slovenian\n* `es` - Spanish\n* `es_AR` - Spanish (ARG)\n* `es_ES` - Spanish (SPA)\n* `es_MX` - Spanish (MEX)\n* `sw` - Swahili\n* `sv` - Swedish\n* `ta` - Tamil\n* `te` - Telugu\n* `th` - Thai\n* `tr` - Turkish\n* `uk` - Ukrainian\n* `ur` - Urdu\n* `uz` - Uzbek\n* `vi` - Vietnamese\n* `zu` - Zulu" }, "LocationMessage": { "type": "object", "properties": { "address": { "type": "string", "maxLength": 500 }, "latitude": { "type": "number", "format": "double" }, "longitude": { "type": "number", "format": "double" }, "place_name": { "type": [ "string", "null" ], "maxLength": 500 }, "place_url": { "type": [ "string", "null" ], "format": "uri", "maxLength": 200 }, "map_screenshot_url": { "type": [ "string", "null" ], "format": "uri", "maxLength": 200 } }, "required": [ "address", "latitude", "longitude" ] }, "MaxWaitTimeUnitEnum": { "enum": [ "SECOND", "MINUTE", "HOUR", "DAY" ], "type": "string", "description": "* `SECOND` - Second\n* `MINUTE` - Minute\n* `HOUR` - Hour\n* `DAY` - Day" }, "MessageSourceEnum": { "enum": [ "INBOUND", "INBOX", "AUTO_RESPONSE", "API", "BROADCAST", "FLOW" ], "type": "string", "description": "* `INBOUND` - Inbound\n* `INBOX` - Inbox\n* `AUTO_RESPONSE` - Auto Response\n* `API` - Api\n* `BROADCAST` - Broadcast\n* `FLOW` - Flow" }, "MessageStatusEnum": { "enum": [ "new", "retry", "accepted", "sending", "sent", "receiving", "received", "delivered", "undelivered", "failed", "read", "deleted" ], "type": "string", "description": "* `new` - New\n* `retry` - Retry\n* `accepted` - Accepted\n* `sending` - Sending\n* `sent` - Sent\n* `receiving` - Receiving\n* `received` - Received\n* `delivered` - Delivered\n* `undelivered` - Undelivered\n* `failed` - Failed\n* `read` - Read\n* `deleted` - Deleted" }, "MessageTypeEnum": { "enum": [ "audio", "voice", "button", "document", "text", "image", "interactive", "order", "sticker", "system", "unknown", "video", "unsupported", "location", "contacts", "template", "reaction", "ephemeral", "request_welcome" ], "type": "string", "description": "* `audio` - Audio\n* `voice` - Voice\n* `button` - Button\n* `document` - Document\n* `text` - Text\n* `image` - Image\n* `interactive` - Interactive\n* `order` - Order\n* `sticker` - Sticker\n* `system` - System\n* `unknown` - Unknown\n* `video` - Video\n* `unsupported` - Unsupported\n* `location` - Location\n* `contacts` - Contacts\n* `template` - Template\n* `reaction` - Reaction\n* `ephemeral` - Ephemeral\n* `request_welcome` - Request Welcome" }, "NextActionEnum": { "enum": [ "ANY_RESPONSE", "BUTTON_RESPONSE", "CONTINUE" ], "type": "string", "description": "* `ANY_RESPONSE` - Any Response\n* `BUTTON_RESPONSE` - Button Response\n* `CONTINUE` - Continue" }, "NullEnum": { "enum": [ null ] }, "SimpleChannel": { "type": "object", "properties": { "id": { "type": "integer", "readOnly": true }, "channel_type": { "$ref": "#/$defs/ChannelTypeEnum" }, "name": { "type": "string", "maxLength": 100 }, "channel_id": { "type": "string", "maxLength": 100 }, "status": { "$ref": "#/$defs/ChannelStatusEnum" }, "created_on": { "type": "string", "format": "date-time", "title": "Creado el" }, "channel_provider": { "$ref": "#/$defs/ChannelProviderEnum" }, "is_sandbox": { "type": "boolean" } }, "required": [ "channel_id", "id" ] }, "SimpleUser": { "type": "object", "properties": { "first_name": { "type": "string", "maxLength": 150 }, "last_name": { "type": "string", "maxLength": 150 }, "email": { "type": "string", "format": "email", "maxLength": 254 }, "id": { "type": "integer", "readOnly": true }, "profile_image": { "type": [ "string", "null" ], "format": "uri" }, "role": { "type": [ "integer", "null" ] } }, "required": [ "email", "id" ] }, "StepConditionalCondition": { "type": "object", "properties": { "field": { "type": "string", "maxLength": 255 }, "comparison": { "$ref": "#/$defs/ComparisonEnum" }, "value": { "type": "string", "maxLength": 255 }, "id": { "type": "integer", "readOnly": true } }, "required": [ "comparison", "field", "id", "value" ] }, "StepConditionalMultilpePath": { "type": "object", "properties": { "conditions": { "type": "array", "items": { "$ref": "#/$defs/StepConditionalCondition" } } }, "required": [ "conditions" ] }, "TimeWindowTypeEnum": { "enum": [ "IN_WORKING_HOURS", "CUSTOM" ], "type": "string", "description": "* `IN_WORKING_HOURS` - In Working Hours\n* `CUSTOM` - Custom" }, "TriggerTypeEnum": { "enum": [ "INBOUND_ANY_MESSAGE", "INBOUND_SPECIFIC_MESSAGE", "OUTBOUND_CAMPAIGN_API", "OUTBOUND_CAMPAIGN_CSV", "OUTBOUND_CAMPAIGN_SEGMENT", "OUTBOUND_ANY", "META_C2WA", "INTEGRATIONS_HUBSPOT", "INTEGRATIONS_ZAPIER", "FROM_FLOW", "CSAT", "OTHER" ], "type": "string", "description": "* `INBOUND_ANY_MESSAGE` - Inbound Any Message\n* `INBOUND_SPECIFIC_MESSAGE` - Inbound Specific Message\n* `OUTBOUND_CAMPAIGN_API` - Outbound Campaign Api\n* `OUTBOUND_CAMPAIGN_CSV` - Outbound Campaign Csv\n* `OUTBOUND_CAMPAIGN_SEGMENT` - Outbound Campaign Segment\n* `OUTBOUND_ANY` - Outbound Any\n* `META_C2WA` - Meta C2Wa\n* `INTEGRATIONS_HUBSPOT` - Integrations Hubspot\n* `INTEGRATIONS_ZAPIER` - Integrations Zapier\n* `FROM_FLOW` - From Flow\n* `CSAT` - Csat\n* `OTHER` - Other" }, "UploadedAccountFile": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "readOnly": true }, "url": { "type": "string", "format": "uri", "readOnly": true }, "uploaded_file": { "type": "string", "format": "uri" }, "content_type": { "type": "string" }, "original_name": { "type": [ "string", "null" ], "maxLength": 255 } }, "required": [ "id", "uploaded_file", "url" ] }, "WeekdayEnum": { "enum": [ 0, 1, 2, 3, 4, 5, 6 ], "type": "integer", "description": "* `0` - Monday\n* `1` - Tuesday\n* `2` - Wednesday\n* `3` - Thursday\n* `4` - Friday\n* `5` - Saturday\n* `6` - Sunday" }, "WhatsAppMessage": { "type": "object", "properties": { "id": { "type": "string" }, "to_number": { "type": "string", "readOnly": true }, "from_number": { "type": "string", "readOnly": true }, "body": { "type": [ "string", "null" ] }, "direction": { "type": "string" }, "timestamp": { "type": "string", "format": "date-time", "readOnly": true }, "contact": { "type": "string" }, "status": { "allOf": [ { "$ref": "#/$defs/MessageStatusEnum" } ], "readOnly": true }, "queued_on": { "type": [ "string", "null" ], "format": "date-time", "readOnly": true }, "accepted_on": { "type": [ "string", "null" ], "format": "date-time", "readOnly": true }, "sent_on": { "type": [ "string", "null" ], "format": "date-time", "readOnly": true }, "delivered_on": { "type": [ "string", "null" ], "format": "date-time", "readOnly": true }, "read_on": { "type": [ "string", "null" ], "format": "date-time", "readOnly": true }, "failed_on": { "type": [ "string", "null" ], "format": "date-time", "readOnly": true }, "provider_id": { "type": [ "string", "null" ], "readOnly": true }, "provider_error_code": { "type": [ "string", "null" ], "readOnly": true }, "provider_error_message": { "type": [ "string", "null" ], "readOnly": true }, "sent_by": { "$ref": "#/$defs/SimpleUser" }, "is_deleted": { "type": "boolean", "readOnly": true }, "content": { "readOnly": true }, "whatsapp_template": { "$ref": "#/$defs/WhatsAppTemplateSimpleRead" }, "content_type": { "type": [ "string", "null" ], "readOnly": true }, "content_url": { "type": [ "string", "null" ], "format": "uri", "readOnly": true }, "msg_type": { "allOf": [ { "$ref": "#/$defs/MessageTypeEnum" } ], "readOnly": true }, "location": { "$ref": "#/$defs/LocationMessage" }, "failed_attempts": { "type": "integer", "readOnly": true }, "contacts": { "type": "array", "items": { "$ref": "#/$defs/ContactMessage" } }, "source": { "allOf": [ { "$ref": "#/$defs/MessageSourceEnum" } ], "readOnly": true }, "context_message": { "allOf": [ { "$ref": "#/$defs/WhatsAppMessageWithoutContext" } ], "readOnly": true } }, "required": [ "accepted_on", "contact", "contacts", "content", "content_type", "content_url", "context_message", "delivered_on", "direction", "failed_attempts", "failed_on", "from_number", "id", "is_deleted", "location", "msg_type", "provider_error_code", "provider_error_message", "provider_id", "queued_on", "read_on", "sent_by", "sent_on", "source", "status", "timestamp", "to_number", "whatsapp_template" ] }, "WhatsAppMessageWithoutContext": { "type": "object", "properties": { "id": { "type": "string" }, "to_number": { "type": "string", "readOnly": true }, "from_number": { "type": "string", "readOnly": true }, "body": { "type": [ "string", "null" ] }, "direction": { "type": "string" }, "timestamp": { "type": "string", "format": "date-time", "readOnly": true }, "contact": { "type": "string" }, "status": { "allOf": [ { "$ref": "#/$defs/MessageStatusEnum" } ], "readOnly": true }, "queued_on": { "type": [ "string", "null" ], "format": "date-time", "readOnly": true }, "accepted_on": { "type": [ "string", "null" ], "format": "date-time", "readOnly": true }, "sent_on": { "type": [ "string", "null" ], "format": "date-time", "readOnly": true }, "delivered_on": { "type": [ "string", "null" ], "format": "date-time", "readOnly": true }, "read_on": { "type": [ "string", "null" ], "format": "date-time", "readOnly": true }, "failed_on": { "type": [ "string", "null" ], "format": "date-time", "readOnly": true }, "provider_id": { "type": [ "string", "null" ], "readOnly": true }, "provider_error_code": { "type": [ "string", "null" ], "readOnly": true }, "provider_error_message": { "type": [ "string", "null" ], "readOnly": true }, "sent_by": { "$ref": "#/$defs/SimpleUser" }, "is_deleted": { "type": "boolean", "readOnly": true }, "content": { "readOnly": true }, "whatsapp_template": { "$ref": "#/$defs/WhatsAppTemplateSimpleRead" }, "content_type": { "type": [ "string", "null" ], "readOnly": true }, "content_url": { "type": [ "string", "null" ], "format": "uri", "readOnly": true }, "msg_type": { "allOf": [ { "$ref": "#/$defs/MessageTypeEnum" } ], "readOnly": true }, "location": { "$ref": "#/$defs/LocationMessage" }, "failed_attempts": { "type": "integer", "readOnly": true }, "contacts": { "type": "array", "items": { "$ref": "#/$defs/ContactMessage" } }, "source": { "allOf": [ { "$ref": "#/$defs/MessageSourceEnum" } ], "readOnly": true } }, "required": [ "accepted_on", "contact", "contacts", "content", "content_type", "content_url", "delivered_on", "direction", "failed_attempts", "failed_on", "from_number", "id", "is_deleted", "location", "msg_type", "provider_error_code", "provider_error_message", "provider_id", "queued_on", "read_on", "sent_by", "sent_on", "source", "status", "timestamp", "to_number", "whatsapp_template" ] }, "WhatsAppTemplateSimpleRead": { "type": "object", "properties": { "name": { "type": "string", "maxLength": 120 }, "language": { "$ref": "#/$defs/LanguageEnum" }, "components": {}, "id": { "type": "string", "format": "uuid", "readOnly": true, "description": "The UUID of the WhatsApp Template to be sent." }, "category": { "$ref": "#/$defs/CategoryEnum" }, "status": { "$ref": "#/$defs/WhatsAppTemplateStatusEnum" }, "rejected_reason": { "type": [ "string", "null" ] }, "is_deleted": { "type": "boolean" }, "channel": { "allOf": [ { "$ref": "#/$defs/SimpleChannel" } ], "description": "The ID of the WhatsApp Channel that the WhatsApp Template is for." }, "show_in_sandbox": { "type": "boolean" } }, "required": [ "category", "channel", "id", "language", "name" ] }, "WhatsAppTemplateStatusEnum": { "enum": [ "draft", "approved", "in_appeal", "pending", "rejected", "pending_deletion", "deleted", "disabled", "submitted" ], "type": "string", "description": "* `draft` - Draft\n* `approved` - Approved\n* `in_appeal` - In Appeal\n* `pending` - Pending\n* `rejected` - Rejected\n* `pending_deletion` - Pending Deletion\n* `deleted` - Deleted\n* `disabled` - Disabled\n* `submitted` - Submitted" } } }