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