ActiveCampaign WhatsApp API

{"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":"stri

# --- truncated at 32 KB (81 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/activecampaign/refs/heads/main/openapi/activecampaign-whatsapp-api-openapi.yml