{"openapi":"3.0.3","info":{"title":"WhatsApp API","version":"1.0.0","description":"All of the below API endpoints require API key authentication, get your token at https://app.hilos.io/dev/api-keys.\n\nTo use this token, send with every request an `Authorization: Token <your token>` header.\n\nProduction API server is located at api.hilos.io using HTTPS.\n\nNo versioning info is required for now."},"paths":{"/channel/whatsapp/channels/whatsapp/template":{"get":{"operationId":"List WhatsApp Templates","description":"Lists WhatsApp Templates. You can search with the `name` and `status` fields using the `?seach=my-template-name` query parameter.","summary":"List WhatsApp Templates","parameters":[{"in":"query","name":"category","schema":{"type":"string","enum":["ACCOUNT_UPDATE","ALERT_UPDATE","APPOINTMENT_UPDATE","AUTHENTICATION","AUTO_REPLY","ISSUE_RESOLUTION","MARKETING","OTP","PAYMENT_UPDATE","PERSONAL_FINANCE_UPDATE","RESERVATION_UPDATE","SHIPPING_UPDATE","TICKET_UPDATE","TRANSACTIONAL","TRANSPORTATION_UPDATE","UTILITY"]},"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"},{"in":"query","name":"category__in","schema":{"type":"array","items":{"type":"string"}},"description":"Multiple values may be separated by commas.","explode":false,"style":"form"},{"in":"query","name":"channel","schema":{"type":"integer"}},{"in":"query","name":"channel__in","schema":{"type":"array","items":{"type":"integer"}},"description":"Multiple values may be separated by commas.","explode":false,"style":"form"},{"name":"ordering","required":false,"in":"query","description":"Which field to use when ordering the results.","schema":{"type":"string"}},{"name":"page","required":false,"in":"query","description":"A page number within the paginated result set.","schema":{"type":"integer"}},{"name":"page_size","required":false,"in":"query","description":"Number of results to return per page.","schema":{"type":"integer"}},{"name":"search","required":false,"in":"query","description":"A search term.","schema":{"type":"string"}},{"in":"query","name":"status","schema":{"type":"string","enum":["approved","deleted","disabled","draft","in_appeal","pending","pending_deletion","rejected","submitted"]},"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"},{"in":"query","name":"status__in","schema":{"type":"array","items":{"type":"string"}},"description":"Multiple values may be separated by commas.","explode":false,"style":"form"}],"tags":["Templates"],"security":[{"tokenAuth":[]}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaginatedWhatsAppTemplateSimpleReadList"}}},"description":""}}}},"/channel/whatsapp/channels/whatsapp/template/{id}":{"get":{"operationId":"Get WhatsApp Template","description":"Gets a WhatsApp Template by Id.","summary":"Get WhatsApp Template","parameters":[{"in":"path","name":"id","schema":{"type":"string","format":"uuid"},"required":true}],"tags":["Templates"],"security":[{"tokenAuth":[]}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WhatsAppTemplateRead"}}},"description":""}}},"put":{"operationId":"channels_whatsapp_template_update","description":"Update a WhatsApp Template by Id.","summary":"Update WhatsApp Template","parameters":[{"in":"path","name":"id","schema":{"type":"string","format":"uuid"},"required":true}],"tags":["Templates"],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WhatsAppTemplateRead"}},"application/x-www-form-urlencoded":{"schema":{"$ref":"#/components/schemas/WhatsAppTemplateRead"}},"multipart/form-data":{"schema":{"$ref":"#/components/schemas/WhatsAppTemplateRead"}}},"required":true},"security":[{"tokenAuth":[]}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WhatsAppTemplateRead"}}},"description":""}}},"delete":{"operationId":"Delete WhatsApp Template","description":"Deletes a WhatsApp Template by Id.","summary":"Delete WhatsApp Template","parameters":[{"in":"path","name":"id","schema":{"type":"string","format":"uuid"},"required":true}],"tags":["Templates"],"security":[{"tokenAuth":[]}],"responses":{"204":{"description":"No response body"}}}},"/channel/whatsapp/channels/whatsapp/template/{id}/send":{"post":{"operationId":"Send a WhatsApp Template Message","description":"Send a single WhatsApp message: select a template to use and call our endpoint with the recipient phone number and the variables the template needs. That's it!","summary":"Send a WhatsApp Template","parameters":[{"in":"path","name":"id","schema":{"type":"string","format":"uuid"},"description":"Template Id","required":true,"examples":{"TheTemplateIdThatWeWantToSend":{"value":"a3ff7ee5-0c11-49e2-a0d6-7e316626f7b1","summary":"The Template Id that we want to send"}}}],"tags":["Templates"],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WhatsAppTemplateSend"}},"application/x-www-form-urlencoded":{"schema":{"$ref":"#/components/schemas/WhatsAppTemplateSend"}},"multipart/form-data":{"schema":{"$ref":"#/components/schemas/WhatsAppTemplateSend"}}},"required":true},"security":[{"tokenAuth":[]}],"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WhatsAppTemplateSendPublicResponse"},"examples":{"WhatsAppTemplateSendPublicResponse":{"value":{"id":"a513da3a-8b73-42aa-a938-0eb1e0141533","conversation":"ee49ab6c-dfd8-4cb6-a512-5880f4385622"},"description":"Returns the Message Id and its Conversation Id."}}}},"description":""}}}},"/channel/whatsapp/flow-execution":{"get":{"operationId":"List Flow Execution","description":"Lists Flow Executions. ","summary":"List Flow Executions","parameters":[{"in":"query","name":"flow","schema":{"type":"string","format":"uuid"},"description":"A Flow Id to filter the Flow Executions and only get those from that Flow.","examples":{"OnlyReturnTheFlowExecutionsOfThisFlow":{"value":"a3ff7ee5-0c11-49e2-a0d6-7e316626f7b1","summary":"Only return the Flow Executions of this Flow"}}},{"in":"query","name":"flow_version","schema":{"type":"string","format":"uuid"}},{"name":"page","required":false,"in":"query","description":"A page number within the paginated result set.","schema":{"type":"integer"}},{"in":"query","name":"search","schema":{"type":"string"},"description":"You can search with the `status`, `created_by__email` fields.","examples":{"CreatedByEmail":{"value":"erik@hilos.io","summary":"created by email"},"With`PROCESSING`Status":{"value":"Processing","summary":"with `PROCESSING` status"},"With`READY`Status":{"value":"Ready","summary":"with `READY` status"},"With`AWAITINGCONFIRMATION`Status":{"value":"Awaiting Confirmation","summary":"with `AWAITING_CONFIRMATION` status"},"With`CONFIRMED`Status":{"value":"Confirmed","summary":"with `CONFIRMED` status"},"With`STARTING`Status":{"value":"Starting","summary":"with `STARTING` status"},"With`RUNNING`Status":{"value":"Running","summary":"with `RUNNING` status"},"With`COMPLETED`Status":{"value":"Completed","summary":"with `COMPLETED` status"},"With`CANCELED`Status":{"value":"Canceled","summary":"with `CANCELED` status"}}}],"tags":["Flows"],"security":[{"tokenAuth":[]}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaginatedFlowExecutionListList"}}},"description":""}}}},"/channel/whatsapp/flow-execution-contact":{"get":{"operationId":"List Flow Execution Contact","description":"Lists Flow Execution Contacts.","summary":"List Flow Execution Contacts","parameters":[{"in":"query","name":"contact","schema":{"type":"string","format":"uuid"},"description":"A Contact Id to filter the Flow Execution Contacts and only get those from that Contact.","examples":{"OnlyReturnTheFlowExecutionsContactOfThisContact":{"value":"a3ff7ee5-0c11-49e2-a0d6-7e316626f7b1","summary":"Only return the Flow Executions Contact of this Contact"}}},{"in":"query","name":"execution_steps__step_id","schema":{"type":"string","format":"uuid"}},{"in":"query","name":"flow","schema":{"type":"string","format":"uuid"},"description":"A Flow Id to filter the Flow Execution Contacts and only get those from that Flow.","examples":{"OnlyReturnTheFlowExecutionsContactOfThisFlow":{"value":"a3ff7ee5-0c11-49e2-a0d6-7e316626f7b1","summary":"Only return the Flow Executions Contact of this flow"}}},{"in":"query","name":"flow_execution","schema":{"type":"string","format":"uuid"},"description":"A Flow Execution Id to filter the Flow Execution Contacts and only get those from that Flow Execution.","examples":{"OnlyReturnTheFlowExecutionsContactOfThisFlowExecution":{"value":"a3ff7ee5-0c11-49e2-a0d6-7e316626f7b1","summary":"Only return the Flow Executions Contact of this Flow Execution"}}},{"in":"query","name":"flow_version","schema":{"type":"string","format":"uuid"}},{"in":"query","name":"id","schema":{"type":"string","format":"uuid"}},{"in":"query","name":"is_active","schema":{"type":"boolean"},"description":"A boolean param to filter between active/in progress Flow Execution Contacs.\n\n If the parameter is omitted it will respond with Flow Execution Contacts with any `status`.","examples":{"OnlyReturnTheFlowExecutionsContactThatAreWithStatus`READY`Or`RUNNING`.":{"value":["true","any-truthy-value",1],"summary":"Only return the Flow Executions Contact that are with status `READY` or `RUNNING`."},"OnlyReturnTheFlowExecutionsContactThatAreWithStatus`CANCELED`Or`COMPLETED`.":{"value":["false",0],"summary":"Only return the Flow Executions Contact that are with status `CANCELED` or `COMPLETED`."}}},{"name":"page","required":false,"in":"query","description":"A page number within the paginated result set.","schema":{"type":"integer"}},{"name":"page_size","required":false,"in":"query","description":"Number of results to return per page.","schema":{"type":"integer"}},{"in":"query","name":"search","schema":{"type":"string"},"description":"You can search with the `contact__phone`, `contact__first_name`, `contact__last_name`, `contact__email` fields.","examples":{"ByContactEmail":{"value":"erik@hilos.io","summary":"by contact email"},"ByContactPhone":{"value":"+525512345678","summary":"by contact phone"},"ByContactLastName":{"value":"Smith","summary":"by contact last_name"},"ByContactFirstName":{"value":"Jonh","summary":"by contact first_name"}}}],"tags":["Flows"],"security":[{"tokenAuth":[]}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaginatedFlowExecutionContactListSimpleList"}}},"description":""}}}},"/channel/whatsapp/flow-execution-contact/{id}":{"get":{"operationId":"Get Flow Execution Contact","description":"Get Flow Execution Contact by Id.","summary":"Get Flow Execution Contact by Id","parameters":[{"in":"path","name":"id","schema":{"type":"string","format":"uuid"},"description":"A Flow Execution Contact Id to Retrive.","required":true,"examples":{"QueryById":{"value":"a3ff7ee5-0c11-49e2-a0d6-7e316626f7b1","summary":"Query by Id"}}}],"tags":["Flows"],"security":[{"tokenAuth":[]}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FlowExecutionContactReadDetail"}}},"description":""}}}},"/channel/whatsapp/flow-execution/{id}":{"get":{"operationId":"Get Flow Execution","description":"Get Flow Execution by Id.","summary":"Get Flow Execution","parameters":[{"in":"path","name":"id","schema":{"type":"string","format":"uuid"},"description":"A Flow Execution Id to retrive.","required":true,"examples":{"QueryById":{"value":"a3ff7ee5-0c11-49e2-a0d6-7e316626f7b1","summary":"Query by Id"}}}],"tags":["Flows"],"security":[{"tokenAuth":[]}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FlowExecutionReadDetail"}}},"description":""}}}},"/channel/whatsapp/flow/{id}/run":{"post":{"operationId":"Create a Flow Execution","description":"Create a Flow Execution of a Flow.","summary":"Create a Flow Execution","parameters":[{"in":"path","name":"id","schema":{"type":"string","format":"uuid"},"description":"A Flow Id to create a Flow Execution.","required":true,"examples":{"CreateByFlowId":{"value":"a3ff7ee5-0c11-49e2-a0d6-7e316626f7b1","summary":"Create by Flow Id"}}}],"tags":["Flows"],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FlowExecutionCreateRequest"}},"application/x-www-form-urlencoded":{"schema":{"$ref":"#/components/schemas/FlowExecutionCreateRequest"}},"multipart/form-data":{"schema":{"$ref":"#/components/schemas/FlowExecutionCreateRequest"}}},"required":true},"security":[{"tokenAuth":[]}],"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FlowExecutionEdit"}}},"description":""}}}},"/channel/whatsapp/inbox/conversation":{"get":{"operationId":"List Conversations","description":"Lists Conversations. ","summary":"List Conversations","parameters":[{"in":"query","name":"contact","schema":{"type":"string","format":"uuid"},"description":"A Contact Id to filter the Conversations and only get those from that Contact.","examples":{"OnlyReturnTheConversationsOfThisContact":{"value":"a3ff7ee5-0c11-49e2-a0d6-7e316626f7b1","summary":"Only return the Conversations of this Contact"}}},{"name":"page","required":false,"in":"query","description":"A page number within the paginated result set.","schema":{"type":"integer"}},{"name":"page_size","required":false,"in":"query","description":"Number of results to return per page.","schema":{"type":"integer"}},{"name":"search","required":false,"in":"query","description":"A search term.","schema":{"type":"string"}}],"tags":["Conversations"],"security":[{"tokenAuth":[]}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaginatedConversationReadSimpleList"}}},"description":""}}}},"/channel/whatsapp/inbox/conversation/{id}/update":{"put":{"operationId":"Update a Conversation","description":"Update a Conversation","summary":"Update a conversation","parameters":[{"in":"path","name":"id","schema":{"type":"string","format":"uuid"},"required":true}],"tags":["Conversations"],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConversationEdit"}},"application/x-www-form-urlencoded":{"schema":{"$ref":"#/components/schemas/ConversationEdit"}},"multipart/form-data":{"schema":{"$ref":"#/components/schemas/ConversationEdit"}}},"required":true},"security":[{"tokenAuth":[]}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConversationEdit"}}},"description":""}}},"patch":{"operationId":"Partially update a Conversation","description":"Partially update a Conversation","summary":"Partially Update a Conversation","parameters":[{"in":"path","name":"id","schema":{"type":"string","format":"uuid"},"required":true}],"tags":["Conversations"],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PatchedConversationEdit"}},"application/x-www-form-urlencoded":{"schema":{"$ref":"#/components/schemas/PatchedConversationEdit"}},"multipart/form-data":{"schema":{"$ref":"#/components/schemas/PatchedConversationEdit"}}}},"security":[{"tokenAuth":[]}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConversationEdit"}}},"description":""}}}}},"components":{"schemas":{"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"},"ContactDetailRead":{"type":"object","properties":{"first_name":{"type":"string","nullable":true,"maxLength":100},"last_name":{"type":"string","nullable":true,"maxLength":100},"email":{"type":"string","format":"email","nullable":true,"maxLength":254},"meta":{},"external_url":{"type":"string","format":"uri","nullable":true,"maxLength":200},"canonical_phone":{"type":"string","nullable":true,"maxLength":30},"is_deleted":{"type":"boolean"},"created_by":{"type":"integer","readOnly":true,"description":"User ID of the user who created the contact"},"phone":{"type":"string","description":"Phone number of the contact"},"id":{"type":"string","description":"UUID representing the contact ID"},"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},"notes":{"type":"array","items":{"$ref":"#/components/schemas/ContactNoteRead"},"readOnly":true,"description":"Notes associated with the contact"},"tags":{"type":"array","items":{"$ref":"#/components/schemas/ContactTag"},"description":"Tags associated with the contact"},"default_assignees":{"type":"array","items":{"$ref":"#/components/schemas/UserSimple"},"description":"ID of the default assignees for the contact"},"contact_import":{"type":"string","format":"uuid","nullable":true},"inbox_contacts":{"type":"array","items":{"$ref":"#/components/schemas/InboxContactURL"},"description":"URL of the inbox conversation associated with the contact"},"default_channel":{"type":"integer","nullable":true},"default_conversation_url":{"type":"string","format":"uri","readOnly":true,"description":"URL of the default inbox conversation for this contact"}},"required":["created_by","default_assignees","default_conversation_url","id","inbox_contacts","last_updated_on","notes","phone","source","tags"]},"ContactDetailReadPublic":{"type":"object","properties":{"first_name":{"type":"string","nullable":true,"maxLength":100},"last_name":{"type":"string","nullable":true,"maxLength":100},"email":{"type":"string","format":"email","nullable":true,"maxLength":254},"meta":{},"external_url":{"type":"string","format":"uri","nullable":true,"maxLength":200},"canonical_phone":{"type":"string","nullable":true,"maxLength":30},"created_by":{"type":"integer","readOnly":true,"description":"User ID of the user who created the contact"},"phone":{"type":"string","description":"Phone number of the contact"},"id":{"type":"string","description":"UUID representing the contact ID"},"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},"tags":{"type":"array","items":{"$ref":"#/components/schemas/ContactTag"},"description":"Tags associated with the contact"},"default_assignees":{"type":"array","items":{"$ref":"#/components/schemas/UserSimple"},"description":"ID of the default assignees for the contact"},"inbox_contacts":{"type":"array","items":{"$ref":"#/components/schemas/InboxContactURL"},"description":"URL of the inbox conversation associated with the contact"},"default_conversation_url":{"type":"string","format":"uri","readOnly":true,"description":"URL of the default inbox conversation for this contact"}},"required":["created_by","default_assignees","default_conversation_url","id","inbox_contacts","last_updated_on","phone","source","tags"]},"ContactListReadPublic":{"type":"object","properties":{"first_name":{"type":"string","nullable":true,"maxLength":100},"last_name":{"type":"string","nullable":true,"maxLength":100},"email":{"type":"string","format":"email","nullable":true,"maxLength":254},"meta":{},"external_url":{"type":"string","format":"uri","nullable":true,"maxLength":200},"canonical_phone":{"type":"string","nullable":true,"maxLength":30},"created_by":{"type":"integer","readOnly":true,"description":"User ID of the user who created the contact"},"phone":{"type":"string","description":"Phone number of the contact"},"created_on":{"type":"string","format":"date-time","readOnly":true,"title":"Creado el"},"last_updated_on":{"type":"string","format":"date-time","readOnly":true,"title":"Última actualización el"},"source":{"type":"string","maxLength":255},"tags":{"type":"array","items":{"$ref":"#/components/schemas/ContactTag"},"description":"Tags associated with the contact"},"id":{"type":"string","readOnly":true,"title":"Contact ID","description":"UUID representing the contact ID"}},"required":["created_by","created_on","id","last_updated_on","phone","source","tags"]},"ContactMessage":{"type":"object","properties":{"addresses":{"type":"array","items":{"type":"object","additionalProperties":{"type":"string","nullable":true}}},"emails":{"type":"array","items":{"type":"object","additionalProperties":{"type":"string","nullable":true}}},"ims":{"type":"array","items":{"type":"object","additionalProperties":{"type":"string","nullable":true}}},"urls":{"type":"array","items":{"type":"string","maxLength":255}},"name":{"type":"object","additionalProperties":{"type":"string","nullable":true}},"phones":{"type":"array","items":{"type":"object","additionalProperties":{"type":"string","nullable":true}}},"org":{"type":"object","additionalProperties":{"type":"string","nullable":true}}}},"ContactNote":{"type":"object","properties":{"id":{"type":"integer","readOnly":true},"notes":{"type":"string"},"contact":{"type":"string","format":"uuid","readOnly":true},"created_on":{"type":"string","format":"date-time","readOnly":true,"title":"Creado el"},"created_by":{"$ref":"#/components/schemas/SimpleUser"}},"required":["contact","created_on","id","notes"]},"ContactNoteRead":{"type":"object","properties":{"id":{"type":"integer","readOnly":true},"notes":{"type":"string"},"contact":{"type":"string","format":"uuid","readOnly":true},"created_on":{"type":"string","format":"date-time","readOnly":true,"title":"Creado el"},"created_by":{"$ref":"#/components/schemas/SimpleUser"}},"required":["contact","created_on","id","notes"]},"ContactReadSimple":{"type":"object","properties":{"first_name":{"type":"string","nullable":true,"maxLength":100},"last_name":{"type":"string","nullable":true,"maxLength":100},"email":{"type":"string","format":"email","nullable":true,"maxLength":254},"meta":{},"canonical_phone":{"type":"string","nullable":true,"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","format":"uri","nullable":true,"maxLength":200}},"required":["id","last_updated_on","phone","source"]},"ContactTag":{"type":"object","properties":{"id":{"type":"integer","readOnly":true},"name":{"type":"string","maxLength":100}},"required":["id","name"]},"ConversationEdit":{"type":"object","properties":{"id":{"type":"string","description":"The UUID of the Conversation."},"contact":{"type":"string","format":"uuid"},"status":{"$ref":"#/components/schemas/ConversationStatusEnum"},"assigned":{"type":"array","items":{"$ref":"#/components/schemas/UserBasicEdit"},"description":"The Users assigned to the Conversation."},"tags":{"type":"array","items":{"$ref":"#/components/schemas/ConversationTag"},"description":"The Tags assigned to the Conversation."},"created_on":{"type":"string","format":"date-time","readOnly":true,"title":"Creado el"},"source":{"allOf":[{"$ref":"#/components/schemas/ConversationSourceEnum"}],"readOnly":true},"assigned_team":{"type":"integer","description":"The ID of the Team assigned to the Conversation."},"channel":{"type":"integer","nullable":true}},"required":["assigned","contact","created_on","id","source"]},"ConversationReadSimple":{"type":"object","properties":{"id":{"type":"string","description":"The UUID of the Conversation."},"contact":{"type":"string","format":"uuid"},"status":{"allOf":[{"$ref":"#/components/schemas/ConversationStatusEnum"}],"readOnly":true},"first_message":{"allOf":[{"$ref":"#/components/schemas/WhatsAppMessageSimple"}],"description":"The first Message of the Conversation."},"assigned":{"type":"array","items":{"$ref":"#/components/schemas/UserSimple"},"description":"The Users assigned to the Conversation."},"tags":{"type":"array","items":{"$ref":"#/components/schemas/ConversationTag"},"description":"The Tags assigned to the Conversation."},"created_on":{"type":"string","format":"date-time","readOnly":true,"title":"Creado el"},"source":{"allOf":[{"$ref":"#/components/schemas/ConversationSourceEnum"}],"readOnly":true},"assigned_team":{"type":"integer","description":"The ID of the Team assigned to the Conversation."},"channel":{"type":"integer","nullable":true}},"required":["assigned","contact","created_on","first_message","id","source","status"]},"ConversationSourceEnum":{"enum":["INBOX","AUTO_RESPONSE","API","BROADCAST","FLOW","UNKNOWN"],"type":"string","description":"* `INBOX` - Inbox\n* `AUTO_RESPONSE` - Auto Response\n* `API` - Api\n* `BROADCAST` - Broadcast\n* `FLOW` - Flow\n* `UNKNOWN` - Unknown"},"ConversationStatusEnum":{"enum":["CREATED","FLOW","NEW","IN_PROGRESS","RESOLVED","CLOSED"],"type":"string","description":"* `CREATED` - Created\n* `FLOW` - Flow\n* `NEW` - New\n* `IN_PROGRESS` - In Progress\n* `RESOLVED` - Resolved\n* `CLOSED` - Closed"},"ConversationTag":{"type":"object","properties":{"id":{"type":"integer","readOnly":true},"name":{"type":"string","maxLength":100}},"required":["id","name"]},"CreateWhatsAppMessage":{"type":"object","properties":{"body":{"type":"string","nullable":true},"content_url":{"type":"string","format":"uri","nullable":true,"maxLength":2000},"content_type":{"type":"string","nullable":true,"maxLength":100},"msg_type":{"$ref":"#/components/schemas/MessageTypeEnum"},"content_media":{"type":"string","format":"uuid","nullable":true},"is_deleted":{"type":"boolean"},"id":{"type":"string","format":"uuid"},"context_message":{"type":"string","format":"uuid","nullable":true}}},"FlowExecutionContactFilterEdit":{"type":"object","properties":{"field":{"type":"string"},"comparison":{"$ref":"#/components/schemas/ComparisonEnum"},"value":{"type":"string"},"id":{"type":"string","format":"uuid"}},"required":["comparison","field","value"]},"FlowExecutionContactListSimple":{"type":"object","properties":{"id":{"type":"string","format":"uuid","readOnly":true},"contact":{"allOf":[{"$ref":"#/components/schemas/ContactReadSimple"}],"description":"The Contact that the Flow Execution Contact is for."},"status":{"$ref":"#/components/schemas/FlowExecutionContactStatusEnum"},"created_on":{"type":"string","format":"date-time","title":"Creado el"},"status_reason":{"type":"string","readOnly":true,"nullable":true},"is_test":{"type":"boolean"},"flow_version":{"type":"string","format":"uuid","nullable":true},"flow":{"type":"string","format":"uuid","nullable":true},"flow_name":{"type":"string","readOnly":true,"description":"The name of the Flow that the Flow Execution Contact is for."}},"required":["contact","flow_name","id","status_reason"]},"FlowExecutionContactReadDetail":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"contact":{"allOf":[{"$ref":"#/components/schemas/ContactReadSimple"}],"description":"The Contact that the Flow Execution Contact is for."},"status":{"$ref":"#/components/schemas/FlowExecutionContactStatusEnum"},"execution_steps":{"type":"array","items":{"$ref":"#/components/schemas/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","format":"uuid","nullable":true},"status_reason":{"type":"string","readOnly":true,"nullable":true},"flow":{"allOf":[{"$ref":"#/components/schemas/FlowListRead"}],"description":"Details for the Flow"},"flow_version":{"allOf":[{"$ref":"#/components/schemas/FlowVersionSimpleListRead"}],"description":"Details for the Flow Version"},"status_triggered_by":{"allOf":[{"$ref":"#/components/schemas/SimpleUser"}],"readOnly":true},"status_last_change_on":{"type":"string","format":"date-time","readOnly":true,"nullable":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"]},"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"},"FlowExecutionCreateRequest":{"type":"object","properties":{"execute_for":{"$ref":"#/components/schemas/FlowExecutionCreateRequestExecuteForEnum"},"has_priority":{"type":"boolean","default":false,"description":"Specify as True if you want this execution to                 close any other running flows or conversations."},"contact_list":{"type":"array","items":{"$ref":"#/components/schemas/PatchedContactEdit"}}},"required":["contact_list","execute_for"]},"FlowExecutionCreateRequestExecuteForEnum":{"enum":["LIST"],"type":"string","description":"* `LIST` - LIST"},"FlowExecutionEdit":{"type":"object","properties":{"status":{"type":"string","readOnly":true,"description":"The status of the Flow Execution."},"execute_for":{"$ref":"#/components/schemas/FlowExecutionExecuteForEnum"},"id":{"type":"string","format":"uuid"},"has_priority":{"type":"boolean"},"flow_execution_variables":{},"start_on":{"type":"string","format":"date-time","nullable":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},"created_on":{"type":"string","format":"date-time","title":"Creado el"},"avg_completion_time":{"type":"string"},"status_reason":{"type":"string","readOnly":true,"nullable":true},"status_triggered_by":{"type":"integer","readOnly":true,"nullable":true},"status_last_change_on":{"type":"string","format":"date-time","readOnly":true,"nullable":true},"contact_filters":{"type":"array","items":{"$ref":"#/components/schemas/FlowExecutionContactFilterEdit"},"description":"The filters to use to get the Contacts that the Flow Execution will run for."},"contact_list":{"type":"array","items":{"$ref":"#/components/schemas/PatchedContactEdit"},"description":"The list of Contacts that the Flow Execution will run for."},"source":{"$ref":"#/components/schemas/FlowExecutionEditSourceEnum"},"is_hidden":{"type":"boolean"}},"required":["execute_for","status","status_last_change_on","status_reason","status_triggered_by"]},"FlowExecutionEditSourceEnum":{"enum":["HUBSPOT","API","FRONTEND"],"type":"string","description":"* `HUBSPOT` - Hubspot\n* `API` - Api\n* `FRONTEND` - Frontend"},"FlowExecutionExecuteForEnum":{"enum":["FILTERS","LIST","ALL"],"type":"string","description":"* `FILTERS` - Filters\n* `LIST` - List\n* `ALL` - All"},"FlowExecutionList":{"type":"object","properties":{"status":{"$ref":"#/components/schemas/FlowExecutionStatusEnum"},"execute_for":{"$ref":"#/components/schemas/FlowExecutionExecuteForEnum"},"id":{"type":"string","format":"uuid"},"has_priority":{"type":"boolean"},"flow_execution_variables":{},"start_on":{"type":"string","format":"date-time","nullable":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},"created_on":{"type":"string","format":"date-time","title":"Creado el"},"avg_completion_time":{"type":"string"},"status_reason":{"type":"string","nullable":true},"status_triggered_by":{"type":"integer","nullable":true},"status_last_change_on":{"type":"string","format":"date-time","nullable":true},"created_by":{"allOf":[{"$ref":"#/components/schemas/SimpleUser"}],"description":"The User that created the Flow Execution."},"flow_version":{"type":"string","format":"uuid"}},"required":["created_by","execute_for","flow_version"]},"FlowExecutionReadDetail":{"type":"object","properties":{"status":{"allOf":[{"$ref":"#/components/schemas/FlowExecutionStatusEnum"}],"readOnly":true,"description":"The status of the Flow Execution.\n\n* `PROCESSING` - Processing\n* `READY` - Ready\n* `AWAITING_CONFIRMATION` - Awaiting Confirmation\n* `CONFIRMED` - Confirmed\n* `STARTING` - Starting\n* `RUNNING` - Running\n* `COMPLETED` - Completed\n* `CANCELED` - Canceled"},"execute_for":{"$ref":"#/components/schemas/FlowExecutionExecuteForEnum"},"id":{"type":"string","format":"uuid"},"has_priority":{"type":"boolean"},"flow_execution_variables":{},"start_on":{"type":"string","format":"date-time","nullable":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},"created_on":{"type":"string","format":"date-time","title":"Creado el"},"avg_completion_time":{"type":"string"},"status_reason":{"type":"string","readOnly":true,"nullable":true},"status_triggered_by":{"allOf":[{"$ref":"#/components/schemas/SimpleUser"}],"readOnly":true},"status_last_change_on":{"type":"string","format":"date-time","readOnly":true,"nullable":true},"created_by":{"allOf":[{"$ref":"#/components/schemas/SimpleUser"}],"description":"The User that created the Flow Execution."},"contact_filters":{"type":"array","items":{"$ref":"#/components/schemas/FlowExecutionContactFilterEdit"},"description":"The filters to use to get the Contacts that the Flow Execution will run for. This field isn't required if executing the flow for a Contact List"},"contact_import":{"type":"string","format":"uuid","nullable":true},"flow":{"allOf":[{"$ref":"#/components/schemas/FlowSimpleRead"}],"description":"The Flow that the Flow Execution is running."},"flow_version":{"allOf":[{"$ref":"#/components/schemas/FlowVersionSimpleRead"}],"description":"The Flow Version that the Flow Execution is running."},"last_run_on":{"type":"string","format":"date-time","readOnly":true,"description":"The last time that the Flow Execution was run."}},"required":["created_by","execute_for","flow","flow_version","last_run_on","status","status_last_change_on","status_reason","status_triggered_by"]},"FlowExecutionStatusEnum":{"enum":["PROCESSING","READY","AWAITING_CONFIRMATION","CONFIRMED","STARTING","RUNNING","COMPLETED","CANCELED"],"type":"string","description":"* `PROCESSING` - Processing\n* `READY` - Ready\n* `AWAITING_CONFIRMATION` - Awaiting Confirmation\n* `CONFIRMED` - Confirmed\n* `STARTING` - Starting\n* `RUNNING` - Running\n* `COMPLETED` - Completed\n* `CANCELED` - Canceled"},"FlowExecutionStepReadDetail":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"step":{"allOf":[{"$ref":"#/components/schemas/FlowStepEdit"}],"readOnly":true},"status_reason":{"type":"string","nullable":true},"has_error":{"type":"boolean"},"expire_on":{"type":"string","format":"date-time","nullable":true},"status":{"$ref":"#/components/schemas/FlowExecutionStepReadDetailStatusEnum"},"validation_failed_attempts":{"type":"integer","maximum":32767,"minimum":0},"execution_result":{"nullable":true},"request_data":{"nullable":true},"messages":{"type":"array","items":{"$ref":"#/components/schemas/FlowExecutionStepWhatsAppMessage"}},"created_on":{"type":"string","format":"date-time","title":"Creado el"},"status_triggered_by":{"type":"integer","nullable":true},"status_last_change_on":{"type":"string","format":"date-time","nullable":true}},"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":"#/components/schemas/WhatsAppMessage"}},"required":["message"]},"FlowListRead":{"type":"object","properties":{"id":{"type":"string","format":"uuid","readOnly":true},"name":{"type":"string","maxLength":100},"created_by":{"allOf":[{"$ref":"#/components/schemas/SimpleUser"}],"readOnly":true},"created_on":{"type":"string","format":"date-time","title":"Creado el"},"is_active":{"type":"boolean"},"status":{"$ref":"#/components/schemas/FlowStatusEnum"},"is_legacy":{"type":"boolean"},"channel":{"allOf":[{"$ref":"#/components/schemas/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","format":"uuid","nullable":true},"is_template":{"type":"boolean"},"trigger_type":{"$ref":"#/components/schemas/TriggerTypeEnum"},"trigger_config":{},"test_version":{"type":"string","format":"uuid","nullable":true},"upgrade_version":{"type":"string","format":"uuid","nullable":true},"legacy_version":{"type":"string","format":"uuid","nullable":true}},"required":["channel","created_by","id","name","trigger_type"]},"FlowSimpleRead":{"type":"object","properties":{"id":{"type":"string","readOnly":true},"name":{"type":"string","maxLength":100},"created_by":{"allOf":[{"$ref":"#/components/schemas/SimpleUser"}],"readOnly":true},"created_on":{"type":"string","format":"date-time","title":"Creado el"},"is_active":{"type":"boolean"},"status":{"$ref":"#/components/schemas/FlowStatusEnum"},"is_legacy":{"type":"boolean"},"channel":{"allOf":[{"$ref":"#/components/schemas/SimpleChannel"}],"readOnly":true},"flow_execution_variables":{"type":"array","items":{"type":"string","maxLength":255},"nullable":true},"trigger_type":{"$ref":"#/components/schemas/TriggerTypeEnum"},"trigger_config":{}},"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","maximum":32767,"minimum":0,"nullable":true},"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","format":"uuid","nullable":true},"next_steps_for_options":{"type":"array","items":{"type":"string","format":"uuid"}},"answer_type":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/AnswerTypeEnum"},{"$ref":"#/components/schemas/BlankEnum"},{"$ref":"#/components/schemas/NullEnum"}]},"body":{"type":"string","nullable":true},"body_type":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/MessageTypeEnum"},{"$ref":"#/components/schemas/BlankEnum"},{"$ref":"#/components/schemas/NullEnum"}]},"body_file_url":{"type":"string","format":"uri","nullable":true,"maxLength":2000},"body_file_type":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/BodyFileTypeEnum"},{"$ref":"#/components/schemas/BlankEnum"},{"$ref":"#/components/schemas/NullEnum"}]},"body_file":{"allOf":[{"$ref":"#/components/schemas/UploadedAccountFile"}],"readOnly":true},"answer_validation_message":{"type":"string","nullable":true},"answer_instructions":{"type":"string","nullable":true},"answer_options":{"type":"array","items":{"type":"string","maxLength":255},"nullable":true},"answer_phone_default_country":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/AnswerPhoneDefaultCountryEnum"},{"$ref":"#/components/schemas/BlankEnum"},{"$ref":"#/components/schemas/NullEnum"}]},"next_step_alternate_idx":{"type":"integer","maximum":32767,"minimum":0,"nullable":true},"conditions":{"type":"array","items":{"$ref":"#/components/schemas/StepConditionalCondition"}},"delay_type":{"type":"string","nullable":true,"maxLength":20},"delay_until":{"type":"string","format":"date-time","nullable":true},"action_request_method":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/ActionRequestMethodEnum"},{"$ref":"#/components/schemas/BlankEnum"},{"$ref":"#/components/schemas/NullEnum"}]},"action_request_url":{"type":"string","format":"uri","nullable":true,"maxLength":2000},"action_request_headers":{"type":"object","additionalProperties":{"type":"string","nullable":true},"nullable":true},"action_request_params":{"type":"object","additionalProperties":{"type":"string","nullable":true},"nullable":true},"action_request_body":{"type":"string","nullable":true},"action_test_response_data":{"type":"string","format":"uuid","nullable":true},"answer_allow_decimals":{"type":"boolean"},"answer_range_min":{"type":"string","nullable":true,"maxLength":50},"answer_range_max":{"type":"string","nullable":true,"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","nullable":true},"options_from_variable":{"type":"string","nullable":true},"option_from_variable_title":{"type":"string","nullable":true},"option_from_variable_description":{"type":"string","nullable":true},"missing_options_message":{"type":"string","nullable":true},"answer_options_render":{"$ref":"#/components/schemas/AnswerOptionsRenderEnum"},"answer_options_render_list_button_title":{"type":"string","nullable":true,"maxLength":20},"answer_option_descriptions":{"type":"array","items":{"type":"string","nullable":true},"nullable":true},"next_steps_for_options_idx":{"type":"array","items":{"type":"integer","maximum":2147483647,"minimum":-2147483648,"nullable":true},"nullable":true},"contact_tags":{"type":"array","items":{"type":"string","maxLength":255},"nullable":true},"conversation_tags":{"type":"array","items":{"type":"string","maxLength":255},"nullable":true},"append_tags":{"type":"boolean"},"max_wait_time_amount":{"type":"integer","maximum":32767,"minimum":0},"max_wait_time_unit":{"$ref":"#/components/schemas/MaxWaitTimeUnitEnum"},"time_windows":{"type":"array","items":{"$ref":"#/components/schemas/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":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/TimeWindowTypeEnum"},{"$ref":"#/components/schemas/BlankEnum"},{"$ref":"#/components/schemas/NullEnum"}]},"has_max_answer_attempts":{"type":"boolean"},"max_answer_attempts":{"type":"integer","maximum":32767,"minimum":0},"answer_failed_next_step_idx":{"type":"integer","maximum":32767,"minimum":0,"nullable":true},"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":"#/components/schemas/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":"#/components/schemas/StepConditionalMultilpePath"}},"firstname":{"type":"string"},"lastname":{"type":"string"},"email":{"type":"string"},"custom_properties":{"type":"array","items":{"type":"string"}},"next_action":{"$ref":"#/components/schemas/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":"#/components/schemas/WeekdayEnum"}],"minimum":0,"maximum":32767},"is_available":{"type":"boolean"},"start_at":{"type":"string","format":"time","nullable":true},"end_at":{"type":"string","format":"time","nullable":true}},"required":["weekday"]},"FlowVersionSimpleListRead":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"version_name":{"type":"string","maxLength":255},"version_description":{"type":"string","nullable":true},"published_by":{"allOf":[{"$ref":"#/components/schemas/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"]},"FlowVersionSimpleRead":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"flow":{"$ref":"#/components/schemas/FlowSimpleRead"},"is_current_version":{"type":"boolean","readOnly":true},"version_name":{"type":"string","maxLength":255},"version_description":{"type":"string","nullable":true},"published_by":{"allOf":[{"$ref":"#/components/schemas/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"}},"required":["flow","is_current_version","last_updated_on","published_by"]},"InboxContactURL":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"url":{"type":"string","format":"uri","readOnly":true},"channel":{"type":"integer"}},"required":["channel","url"]},"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","nullable":true,"maxLength":500},"place_url":{"type":"string","format":"uri","nullable":true,"maxLength":200},"map_screenshot_url":{"type":"string","format":"uri","nullable":true,"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]},"PaginatedContactListReadPublicList":{"type":"object","required":["count","results"],"properties":{"count":{"type":"integer","example":123},"next":{"type":"string","nullable":true,"format":"uri","example":"http://api.example.org/accounts/?page=4"},"previous":{"type":"string","nullable":true,"format":"uri","example":"http://api.example.org/accounts/?page=2"},"results":{"type":"array","items":{"$ref":"#/components/schemas/ContactListReadPublic"}}}},"PaginatedConversationReadSimpleList":{"type":"object","required":["count","results"],"properties":{"count":{"type":"integer","example":123},"next":{"type":"string","nullable":true,"format":"uri","example":"http://api.example.org/accounts/?page=4"},"previous":{"type":"string","nullable":true,"format":"uri","example":"http://api.example.org/accounts/?page=2"},"results":{"type":"array","items":{"$ref":"#/components/schemas/ConversationReadSimple"}}}},"PaginatedFlowExecutionContactListSimpleList":{"type":"object","required":["count","results"],"properties":{"count":{"type":"integer","example":123},"next":{"type":"string","nullable":true,"format":"uri","example":"http://api.example.org/accounts/?page=4"},"previous":{"type":"string","nullable":true,"format":"uri","example":"http://api.example.org/accounts/?page=2"},"results":{"type":"array","items":{"$ref":"#/components/schemas/FlowExecutionContactListSimple"}}}},"PaginatedFlowExecutionListList":{"type":"object","required":["count","results"],"properties":{"count":{"type":"integer","example":123},"next":{"type":"string","nullable":true,"format":"uri","example":"http://api.example.org/accounts/?page=4"},"previous":{"type":"string","nullable":true,"format":"uri","example":"http://api.example.org/accounts/?page=2"},"results":{"type":"array","items":{"$ref":"#/components/schemas/FlowExecutionList"}}}},"PaginatedWhatsAppTemplateSimpleReadList":{"type":"object","required":["count","results"],"properties":{"count":{"type":"integer","example":123},"next":{"type":"string","nullable":true,"format":"uri","example":"http://api.example.org/accounts/?page=4"},"previous":{"type":"string","nullable":true,"format":"uri","example":"http://api.example.org/accounts/?page=2"},"results":{"type":"array","items":{"$ref":"#/components/schemas/WhatsAppTemplateSimpleRead"}}}},"PatchedContactEdit":{"type":"object","properties":{"phone":{"type":"string","maxLength":30},"first_name":{"type":"string","nullable":true,"maxLength":100},"last_name":{"type":"string","nullable":true,"maxLength":100},"email":{"type":"string","format":"email","nullable":true,"maxLength":254},"meta":{},"external_url":{"type":"string","format":"uri","nullable":true,"maxLength":200},"is_deleted":{"type":"boolean"},"id":{"type":"string","format":"uuid"},"source":{"type":"string","default":"website"},"notes":{"type":"array","items":{"$ref":"#/components/schemas/ContactNote"},"readOnly":true},"created_on":{"type":"string","format":"date-time","title":"Creado el"},"tags":{"type":"array","items":{"$ref":"#/components/schemas/ContactTag"}},"external_id":{"type":"string","nullable":true},"native_id":{"type":"string","nullable":true},"default_assignees":{"type":"array","items":{"type":"integer"}},"contact_import":{"type":"string","format":"uuid","nullable":true},"default_channel":{"type":"integer","nullable":true},"wa_id":{"type":"string","nullable":true},"overwrite_tags":{"type":"boolean","default":false,"description":"If true, the `tags` will be overwritten with the new value. If false, the new value will be merged with the existing value. Default is false."},"overwrite_default_assignees":{"type":"boolean","default":false,"description":"If true, the `default_assignees` will be overwritten with the new value. If false, the new value will be merged with the existing value. Default is false."},"overwrite_meta":{"type":"boolean","default":false,"description":"If true, the `meta` field will be overwritten with the new value. If false, the new value will be merged with the existing value. Default is false."}}},"PatchedContactEditPublic":{"type":"object","properties":{"phone":{"type":"string","maxLength":30},"first_name":{"type":"string","nullable":true,"maxLength":100},"last_name":{"type":"string","nullable":true,"maxLength":100},"email":{"type":"string","format":"email","nullable":true,"maxLength":254},"meta":{},"external_url":{"type":"string","format":"uri","nullable":true,"maxLength":200},"id":{"type":"string","format":"uuid"},"source":{"type":"string","default":"website"},"created_on":{"type":"string","format":"date-time","title":"Creado el"},"tags":{"type":"array","items":{"$ref":"#/components/schemas/ContactTag"}},"default_assignees":{"type":"array","items":{"type":"integer"}},"overwrite_tags":{"type":"boolean","default":false,"description":"If true, the `tags` will be overwritten with the new value. If false, the new value will be merged with the existing value. Default is false."},"overwrite_default_assignees":{"type":"boolean","default":false,"description":"If true, the `default_assignees` will be overwritten with the new value. If false, the new value will be merged with the existing value. Default is false."},"overwrite_meta":{"type":"boolean","default":false,"description":"If true, the `meta` field will be overwritten with the new value. If false, the new value will be merged with the existing value. Default is false."}}},"PatchedConversationEdit":{"type":"object","properties":{"id":{"type":"string","description":"The UUID of the Conversation."},"contact":{"type":"string","format":"uuid"},"status":{"$ref":"#/components/schemas/ConversationStatusEnum"},"assigned":{"type":"array","items":{"$ref":"#/components/schemas/UserBasicEdit"},"description":"The Users assigned to the Conversation."},"tags":{"type":"array","items":{"$ref":"#/components/schemas/ConversationTag"},"description":"The Tags assigned to the Conversation."},"created_on":{"type":"string","format":"date-time","readOnly":true,"title":"Creado el"},"source":{"allOf":[{"$ref":"#/components/schemas/ConversationSourceEnum"}],"readOnly":true},"assigned_team":{"type":"integer","description":"The ID of the Team assigned to the Conversation."},"channel":{"type":"integer","nullable":true}}},"PatchedWhatsAppTemplateRead":{"type":"object","properties":{"name":{"type":"string","maxLength":120},"language":{"$ref":"#/components/schemas/LanguageEnum"},"components":{"nullable":true},"id":{"type":"string","format":"uuid","readOnly":true,"description":"The UUID of the WhatsApp Template to be sent."},"category":{"$ref":"#/components/schemas/CategoryEnum"},"status":{"$ref":"#/components/schemas/WhatsAppTemplateStatusEnum"},"rejected_reason":{"type":"string","nullable":true},"is_deleted":{"type":"boolean"},"channel":{"allOf":[{"$ref":"#/components/schemas/SimpleChannel"}],"readOnly":true,"description":"The ID of the WhatsApp Channel that the WhatsApp Template is for."},"is_sample":{"type":"boolean"},"show_in_sandbox":{"type":"boolean"}}},"RoleSimple":{"type":"object","properties":{"id":{"type":"integer","readOnly":true},"name":{"type":"string","maxLength":150},"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"},"can_be_deleted":{"type":"boolean"}},"required":["id","last_updated_on","name"]},"SimpleChannel":{"type":"object","properties":{"id":{"type":"integer","readOnly":true},"channel_type":{"$ref":"#/components/schemas/ChannelTypeEnum"},"name":{"type":"string","maxLength":100},"channel_id":{"type":"string","maxLength":100},"status":{"$ref":"#/components/schemas/ChannelStatusEnum"},"created_on":{"type":"string","format":"date-time","title":"Creado el"},"channel_provider":{"$ref":"#/components/schemas/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","format":"uri","nullable":true},"role":{"type":"integer","nullable":true}},"required":["email","id"]},"StepConditionalCondition":{"type":"object","properties":{"field":{"type":"string","maxLength":255},"comparison":{"$ref":"#/components/schemas/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":"#/components/schemas/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","nullable":true,"maxLength":255}},"required":["id","uploaded_file","url"]},"UserBasicEdit":{"type":"object","properties":{"id":{"type":"integer"}},"required":["id"]},"UserList":{"type":"object","properties":{"id":{"type":"integer"},"first_name":{"type":"string","readOnly":true},"last_name":{"type":"string","readOnly":true},"email":{"type":"string","format":"email","readOnly":true},"account":{"type":"integer","readOnly":true,"nullable":true},"profile_image":{"type":"string","format":"uri","readOnly":true,"nullable":true},"date_joined":{"type":"string","format":"date-time","readOnly":true},"role":{"$ref":"#/components/schemas/RoleSimple"}},"required":["account","date_joined","email","first_name","id","last_name","profile_image","role"]},"UserSimple":{"type":"object","properties":{"id":{"type":"integer"},"first_name":{"type":"string","readOnly":true},"last_name":{"type":"string","readOnly":true},"email":{"type":"string","format":"email","readOnly":true},"account":{"type":"integer","readOnly":true,"nullable":true},"profile_image":{"type":"string","format":"uri","readOnly":true,"nullable":true},"date_joined":{"type":"string","format":"date-time","readOnly":true}},"required":["account","date_joined","email","first_name","id","last_name","profile_image"]},"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","nullable":true},"direction":{"type":"string"},"timestamp":{"type":"string","format":"date-time","readOnly":true},"contact":{"type":"string"},"status":{"allOf":[{"$ref":"#/components/schemas/MessageStatusEnum"}],"readOnly":true},"queued_on":{"type":"string","format":"date-time","readOnly":true,"nullable":true},"accepted_on":{"type":"string","format":"date-time","readOnly":true,"nullable":true},"sent_on":{"type":"string","format":"date-time","readOnly":true,"nullable":true},"delivered_on":{"type":"string","format":"date-time","readOnly":true,"nullable":true},"read_on":{"type":"string","format":"date-time","readOnly":true,"nullable":true},"failed_on":{"type":"string","format":"date-time","readOnly":true,"nullable":true},"provider_id":{"type":"string","readOnly":true,"nullable":true},"provider_error_code":{"type":"string","readOnly":true,"nullable":true},"provider_error_message":{"type":"string","readOnly":true,"nullable":true},"sent_by":{"$ref":"#/components/schemas/SimpleUser"},"is_deleted":{"type":"boolean","readOnly":true},"content":{"readOnly":true,"nullable":true},"whatsapp_template":{"$ref":"#/components/schemas/WhatsAppTemplateSimpleRead"},"content_type":{"type":"string","readOnly":true,"nullable":true},"content_url":{"type":"string","format":"uri","readOnly":true,"nullable":true},"msg_type":{"allOf":[{"$ref":"#/components/schemas/MessageTypeEnum"}],"readOnly":true},"location":{"$ref":"#/components/schemas/LocationMessage"},"failed_attempts":{"type":"integer","readOnly":true},"contacts":{"type":"array","items":{"$ref":"#/components/schemas/ContactMessage"}},"source":{"allOf":[{"$ref":"#/components/schemas/MessageSourceEnum"}],"readOnly":true},"context_message":{"allOf":[{"$ref":"#/components/schemas/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"]},"WhatsAppMessageSimple":{"type":"object","properties":{"id":{"type":"string"},"to_number":{"type":"string","readOnly":true},"from_number":{"type":"string","readOnly":true},"body":{"type":"string","nullable":true},"direction":{"type":"string"},"timestamp":{"type":"string","format":"date-time","readOnly":true},"contact":{"type":"string"},"status":{"allOf":[{"$ref":"#/components/schemas/MessageStatusEnum"}],"readOnly":true},"queued_on":{"type":"string","format":"date-time","readOnly":true,"nullable":true},"accepted_on":{"type":"string","format":"date-time","readOnly":true,"nullable":true},"sent_on":{"type":"string","format":"date-time","readOnly":true,"nullable":true},"delivered_on":{"type":"string","format":"date-time","readOnly":true,"nullable":true},"read_on":{"type":"string","format":"date-time","readOnly":true,"nullable":true},"failed_on":{"type":"string","format":"date-time","readOnly":true,"nullable":true},"provider_id":{"type":"string","readOnly":true,"nullable":true},"provider_error_code":{"type":"string","readOnly":true,"nullable":true},"provider_error_message":{"type":"string","readOnly":true,"nullable":true},"sent_by":{"$ref":"#/components/schemas/SimpleUser"},"is_deleted":{"type":"boolean","readOnly":true},"content":{"readOnly":true,"nullable":true},"whatsapp_template":{"type":"string","format":"uuid","readOnly":true,"nullable":true},"content_type":{"type":"string","readOnly":true,"nullable":true},"content_url":{"type":"string","format":"uri","nullable":true,"maxLength":2000},"msg_type":{"$ref":"#/components/schemas/MessageTypeEnum"},"failed_attempts":{"type":"integer","readOnly":true},"source":{"allOf":[{"$ref":"#/components/schemas/MessageSourceEnum"}],"readOnly":true}},"required":["accepted_on","contact","content","content_type","delivered_on","direction","failed_attempts","failed_on","from_number","id","is_deleted","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","nullable":true},"direction":{"type":"string"},"timestamp":{"type":"string","format":"date-time","readOnly":true},"contact":{"type":"string"},"status":{"allOf":[{"$ref":"#/components/schemas/MessageStatusEnum"}],"readOnly":true},"queued_on":{"type":"string","format":"date-time","readOnly":true,"nullable":true},"accepted_on":{"type":"string","format":"date-time","readOnly":true,"nullable":true},"sent_on":{"type":"string","format":"date-time","readOnly":true,"nullable":true},"delivered_on":{"type":"string","format":"date-time","readOnly":true,"nullable":true},"read_on":{"type":"string","format":"date-time","readOnly":true,"nullable":true},"failed_on":{"type":"string","format":"date-time","readOnly":true,"nullable":true},"provider_id":{"type":"string","readOnly":true,"nullable":true},"provider_error_code":{"type":"string","readOnly":true,"nullable":true},"provider_error_message":{"type":"string","readOnly":true,"nullable":true},"sent_by":{"$ref":"#/components/schemas/SimpleUser"},"is_deleted":{"type":"boolean","readOnly":true},"content":{"readOnly":true,"nullable":true},"whatsapp_template":{"$ref":"#/components/schemas/WhatsAppTemplateSimpleRead"},"content_type":{"type":"string","readOnly":true,"nullable":true},"content_url":{"type":"string","format":"uri","readOnly":true,"nullable":true},"msg_type":{"allOf":[{"$ref":"#/components/schemas/MessageTypeEnum"}],"readOnly":true},"location":{"$ref":"#/components/schemas/LocationMessage"},"failed_attempts":{"type":"integer","readOnly":true},"contacts":{"type":"array","items":{"$ref":"#/components/schemas/ContactMessage"}},"source":{"allOf":[{"$ref":"#/components/schemas/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"]},"WhatsAppTemplateRead":{"type":"object","properties":{"name":{"type":"string","maxLength":120},"language":{"$ref":"#/components/schemas/LanguageEnum"},"components":{"nullable":true},"id":{"type":"string","format":"uuid","readOnly":true,"description":"The UUID of the WhatsApp Template to be sent."},"category":{"$ref":"#/components/schemas/CategoryEnum"},"status":{"$ref":"#/components/schemas/WhatsAppTemplateStatusEnum"},"rejected_reason":{"type":"string","nullable":true},"is_deleted":{"type":"boolean"},"channel":{"allOf":[{"$ref":"#/components/schemas/SimpleChannel"}],"readOnly":true,"description":"The ID of the WhatsApp Channel that the WhatsApp Template is for."},"is_sample":{"type":"boolean"},"show_in_sandbox":{"type":"boolean"}},"required":["category","channel","id","language","name"]},"WhatsAppTemplateSend":{"type":"object","properties":{"variables":{"type":"array","items":{"type":"string"},"description":"An array of variables to be used in the WhatsApp Template. Variables are taken in order HEADER, BODY and BUTTONs. (e.g. position 0 corresponds to the HEADER (if it exists) or variable {{1}}, position 1 to variable {{2}} and so on."},"phone":{"type":"string","description":"The phone number to send the WhatsApp Template to.","maxLength":20}},"required":["phone"]},"WhatsAppTemplateSendPublicResponse":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Message Id"},"conversation":{"type":"string","format":"uuid","description":"Message Conversation Id"}},"required":["conversation","id"]},"WhatsAppTemplateSimpleRead":{"type":"object","properties":{"name":{"type":"string","maxLength":120},"language":{"$ref":"#/components/schemas/LanguageEnum"},"components":{"nullable":true},"id":{"type":"string","format":"uuid","readOnly":true,"description":"The UUID of the WhatsApp Template to be sent."},"category":{"$ref":"#/components/schemas/CategoryEnum"},"status":{"$ref":"#/components/schemas/WhatsAppTemplateStatusEnum"},"rejected_reason":{"type":"string","nullable":true},"is_deleted":{"type":"boolean"},"channel":{"allOf":[{"$ref":"#/components/schemas/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"}},"securitySchemes":{"tokenAuth":{"type":"apiKey","in":"header","name":"Token","description":"Token-based authentication with required prefix \"Token\""}}},"x-tagGroups":[{"name":"Users","tags":["User"]},{"name":"Channels","tags":["WhatsApp","Broadcast"]},{"name":"Flows","tags":["Flow Execution","Flow Execution Contact"]},{"name":"CRM","tags":["Contact","Conversation"]},{"name":"Integrations","tags":["Webhook Subscription"]}],"servers":[{"url":"https://{youraccountname}.api-us1.com/api/3","description":"Production Server"}],"tags":[{"name":"Contacts"},{"name":"Templates"},{"name":"Conversations"},{"name":"Flows"},{"name":"Account Management"}]}