# WhatsApp Business Onboard WhatsApp Business senders through Twilio Partner Solution, send test messages, and register approved Twilio ContentSid templates for campaign automations. ## GET /whatsapp-channels > List Whatsapp Channels ```json {"openapi":"3.1.0","info":{"title":"Umanize API","version":"0.1.0"},"tags":[{"name":"whatsapp-channels","description":"Onboard WhatsApp Business senders through Twilio Partner Solution, send test messages, and register approved Twilio ContentSid templates for campaign automations."}],"servers":[{"url":"https://api.aurorasuite.ai","description":"Production"}],"security":[{"bearerAuth":[]},{"apiKeyAuth":[]}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Use a JWT bearer token in the Authorization header."},"apiKeyAuth":{"type":"apiKey","in":"header","name":"X-API-Key","description":"Use an API key for server-to-server integrations."}},"schemas":{"WhatsAppChannelOut":{"properties":{"id":{"type":"string","format":"uuid","title":"Id"},"provider":{"type":"string","title":"Provider"},"status":{"anyOf":[{"type":"string","enum":["onboarding","pending","active","rejected","disabled","error"]},{"type":"string"}],"title":"Status"},"name":{"type":"string","title":"Name"},"phone_number":{"type":"string","title":"Phone Number"},"display_name":{"title":"Display Name","type":"string"},"twilio_subaccount_sid":{"title":"Twilio Subaccount Sid","type":"string"},"twilio_sender_sid":{"title":"Twilio Sender Sid","type":"string"},"messaging_service_sid":{"title":"Messaging Service Sid","type":"string"},"waba_id":{"title":"Waba Id","type":"string"},"phone_number_id":{"title":"Phone Number Id","type":"string"},"quality_rating":{"title":"Quality Rating","type":"string"},"last_error":{"title":"Last Error","type":"string"},"config":{"additionalProperties":true,"type":"object","title":"Config"},"created_at":{"type":"string","format":"date-time","title":"Created At"},"updated_at":{"type":"string","format":"date-time","title":"Updated At"}},"type":"object","required":["id","provider","status","name","phone_number","created_at","updated_at"],"title":"WhatsAppChannelOut"},"HTTPValidationError":{"properties":{"detail":{"items":{"$ref":"#/components/schemas/ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"},"ValidationError":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"}}},"paths":{"/whatsapp-channels":{"get":{"tags":["whatsapp-channels"],"summary":"List Whatsapp Channels","operationId":"list_whatsapp_channels_whatsapp_channels_get","parameters":[{"name":"include_disabled","in":"query","required":false,"schema":{"type":"boolean","default":false,"title":"Include Disabled"}},{"name":"X-API-Key","in":"header","required":false,"schema":{"title":"X-Api-Key","type":"string"}}],"responses":{"200":{"description":"Request completed successfully.","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/WhatsAppChannelOut"},"title":"Response List Whatsapp Channels Whatsapp Channels Get"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}}}} ``` ## GET /whatsapp-channels/embedded-signup-config > Embedded Signup Config ```json {"openapi":"3.1.0","info":{"title":"Umanize API","version":"0.1.0"},"tags":[{"name":"whatsapp-channels","description":"Onboard WhatsApp Business senders through Twilio Partner Solution, send test messages, and register approved Twilio ContentSid templates for campaign automations."}],"servers":[{"url":"https://api.aurorasuite.ai","description":"Production"}],"security":[{"bearerAuth":[]},{"apiKeyAuth":[]}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Use a JWT bearer token in the Authorization header."},"apiKeyAuth":{"type":"apiKey","in":"header","name":"X-API-Key","description":"Use an API key for server-to-server integrations."}},"schemas":{"WhatsAppEmbeddedSignupConfig":{"properties":{"enabled":{"type":"boolean","title":"Enabled"},"meta_app_id":{"title":"Meta App Id","type":"string"},"embedded_signup_config_id":{"title":"Embedded Signup Config Id","type":"string"},"partner_solution_id":{"title":"Partner Solution Id","type":"string"}},"type":"object","required":["enabled"],"title":"WhatsAppEmbeddedSignupConfig"},"HTTPValidationError":{"properties":{"detail":{"items":{"$ref":"#/components/schemas/ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"},"ValidationError":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"}}},"paths":{"/whatsapp-channels/embedded-signup-config":{"get":{"tags":["whatsapp-channels"],"summary":"Embedded Signup Config","operationId":"embedded_signup_config_whatsapp_channels_embedded_signup_config_get","parameters":[{"name":"X-API-Key","in":"header","required":false,"schema":{"title":"X-Api-Key","type":"string"}}],"responses":{"200":{"description":"Request completed successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WhatsAppEmbeddedSignupConfig"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}}}} ``` ## POST /whatsapp-channels/embedded-signup/complete > Complete Embedded Signup ```json {"openapi":"3.1.0","info":{"title":"Umanize API","version":"0.1.0"},"tags":[{"name":"whatsapp-channels","description":"Onboard WhatsApp Business senders through Twilio Partner Solution, send test messages, and register approved Twilio ContentSid templates for campaign automations."}],"servers":[{"url":"https://api.aurorasuite.ai","description":"Production"}],"security":[{"bearerAuth":[]},{"apiKeyAuth":[]}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Use a JWT bearer token in the Authorization header."},"apiKeyAuth":{"type":"apiKey","in":"header","name":"X-API-Key","description":"Use an API key for server-to-server integrations."}},"schemas":{"WhatsAppEmbeddedSignupComplete":{"properties":{"phone_number":{"type":"string","maxLength":32,"minLength":6,"title":"Phone Number"},"display_name":{"type":"string","maxLength":160,"minLength":1,"title":"Display Name"},"waba_id":{"title":"Waba Id","type":"string","maxLength":128},"phone_number_id":{"title":"Phone Number Id","type":"string","maxLength":128}},"type":"object","required":["phone_number","display_name"],"title":"WhatsAppEmbeddedSignupComplete"},"WhatsAppChannelOut":{"properties":{"id":{"type":"string","format":"uuid","title":"Id"},"provider":{"type":"string","title":"Provider"},"status":{"anyOf":[{"type":"string","enum":["onboarding","pending","active","rejected","disabled","error"]},{"type":"string"}],"title":"Status"},"name":{"type":"string","title":"Name"},"phone_number":{"type":"string","title":"Phone Number"},"display_name":{"title":"Display Name","type":"string"},"twilio_subaccount_sid":{"title":"Twilio Subaccount Sid","type":"string"},"twilio_sender_sid":{"title":"Twilio Sender Sid","type":"string"},"messaging_service_sid":{"title":"Messaging Service Sid","type":"string"},"waba_id":{"title":"Waba Id","type":"string"},"phone_number_id":{"title":"Phone Number Id","type":"string"},"quality_rating":{"title":"Quality Rating","type":"string"},"last_error":{"title":"Last Error","type":"string"},"config":{"additionalProperties":true,"type":"object","title":"Config"},"created_at":{"type":"string","format":"date-time","title":"Created At"},"updated_at":{"type":"string","format":"date-time","title":"Updated At"}},"type":"object","required":["id","provider","status","name","phone_number","created_at","updated_at"],"title":"WhatsAppChannelOut"},"HTTPValidationError":{"properties":{"detail":{"items":{"$ref":"#/components/schemas/ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"},"ValidationError":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"}}},"paths":{"/whatsapp-channels/embedded-signup/complete":{"post":{"tags":["whatsapp-channels"],"summary":"Complete Embedded Signup","operationId":"complete_embedded_signup_whatsapp_channels_embedded_signup_complete_post","parameters":[{"name":"X-API-Key","in":"header","required":false,"schema":{"title":"X-Api-Key","type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WhatsAppEmbeddedSignupComplete"}}}},"responses":{"201":{"description":"Resource created successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WhatsAppChannelOut"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}}}} ``` ## DELETE /whatsapp-channels/{channel\_id} > Delete Whatsapp Channel ```json {"openapi":"3.1.0","info":{"title":"Umanize API","version":"0.1.0"},"tags":[{"name":"whatsapp-channels","description":"Onboard WhatsApp Business senders through Twilio Partner Solution, send test messages, and register approved Twilio ContentSid templates for campaign automations."}],"servers":[{"url":"https://api.aurorasuite.ai","description":"Production"}],"security":[{"bearerAuth":[]},{"apiKeyAuth":[]}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Use a JWT bearer token in the Authorization header."},"apiKeyAuth":{"type":"apiKey","in":"header","name":"X-API-Key","description":"Use an API key for server-to-server integrations."}},"schemas":{"HTTPValidationError":{"properties":{"detail":{"items":{"$ref":"#/components/schemas/ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"},"ValidationError":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"}}},"paths":{"/whatsapp-channels/{channel_id}":{"delete":{"tags":["whatsapp-channels"],"summary":"Delete Whatsapp Channel","operationId":"delete_whatsapp_channel_whatsapp_channels__channel_id__delete","parameters":[{"name":"channel_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Channel Id"}},{"name":"X-API-Key","in":"header","required":false,"schema":{"title":"X-Api-Key","type":"string"}}],"responses":{"204":{"description":"Request completed successfully with no response body."},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}}}} ``` ## POST /whatsapp-channels/{channel\_id}/refresh > Refresh Whatsapp Channel ```json {"openapi":"3.1.0","info":{"title":"Umanize API","version":"0.1.0"},"tags":[{"name":"whatsapp-channels","description":"Onboard WhatsApp Business senders through Twilio Partner Solution, send test messages, and register approved Twilio ContentSid templates for campaign automations."}],"servers":[{"url":"https://api.aurorasuite.ai","description":"Production"}],"security":[{"bearerAuth":[]},{"apiKeyAuth":[]}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Use a JWT bearer token in the Authorization header."},"apiKeyAuth":{"type":"apiKey","in":"header","name":"X-API-Key","description":"Use an API key for server-to-server integrations."}},"schemas":{"WhatsAppChannelOut":{"properties":{"id":{"type":"string","format":"uuid","title":"Id"},"provider":{"type":"string","title":"Provider"},"status":{"anyOf":[{"type":"string","enum":["onboarding","pending","active","rejected","disabled","error"]},{"type":"string"}],"title":"Status"},"name":{"type":"string","title":"Name"},"phone_number":{"type":"string","title":"Phone Number"},"display_name":{"title":"Display Name","type":"string"},"twilio_subaccount_sid":{"title":"Twilio Subaccount Sid","type":"string"},"twilio_sender_sid":{"title":"Twilio Sender Sid","type":"string"},"messaging_service_sid":{"title":"Messaging Service Sid","type":"string"},"waba_id":{"title":"Waba Id","type":"string"},"phone_number_id":{"title":"Phone Number Id","type":"string"},"quality_rating":{"title":"Quality Rating","type":"string"},"last_error":{"title":"Last Error","type":"string"},"config":{"additionalProperties":true,"type":"object","title":"Config"},"created_at":{"type":"string","format":"date-time","title":"Created At"},"updated_at":{"type":"string","format":"date-time","title":"Updated At"}},"type":"object","required":["id","provider","status","name","phone_number","created_at","updated_at"],"title":"WhatsAppChannelOut"},"HTTPValidationError":{"properties":{"detail":{"items":{"$ref":"#/components/schemas/ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"},"ValidationError":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"}}},"paths":{"/whatsapp-channels/{channel_id}/refresh":{"post":{"tags":["whatsapp-channels"],"summary":"Refresh Whatsapp Channel","operationId":"refresh_whatsapp_channel_whatsapp_channels__channel_id__refresh_post","parameters":[{"name":"channel_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Channel Id"}},{"name":"X-API-Key","in":"header","required":false,"schema":{"title":"X-Api-Key","type":"string"}}],"responses":{"200":{"description":"Request completed successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WhatsAppChannelOut"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}}}} ``` ## GET /whatsapp-channels/{channel\_id}/templates > List Whatsapp Templates ```json {"openapi":"3.1.0","info":{"title":"Umanize API","version":"0.1.0"},"tags":[{"name":"whatsapp-channels","description":"Onboard WhatsApp Business senders through Twilio Partner Solution, send test messages, and register approved Twilio ContentSid templates for campaign automations."}],"servers":[{"url":"https://api.aurorasuite.ai","description":"Production"}],"security":[{"bearerAuth":[]},{"apiKeyAuth":[]}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Use a JWT bearer token in the Authorization header."},"apiKeyAuth":{"type":"apiKey","in":"header","name":"X-API-Key","description":"Use an API key for server-to-server integrations."}},"schemas":{"WhatsAppTemplateOut":{"properties":{"name":{"type":"string","maxLength":160,"minLength":1,"title":"Name"},"content_sid":{"type":"string","maxLength":64,"minLength":1,"title":"Content Sid"},"language":{"title":"Language","type":"string","maxLength":16},"status":{"type":"string","maxLength":32,"title":"Status","default":"active"},"variables":{"additionalProperties":true,"type":"object","title":"Variables"},"description":{"title":"Description","type":"string","maxLength":500},"id":{"type":"string","format":"uuid","title":"Id"},"channel_id":{"title":"Channel Id","type":"string","format":"uuid"},"created_at":{"type":"string","format":"date-time","title":"Created At"},"updated_at":{"type":"string","format":"date-time","title":"Updated At"}},"type":"object","required":["name","content_sid","id","created_at","updated_at"],"title":"WhatsAppTemplateOut"},"HTTPValidationError":{"properties":{"detail":{"items":{"$ref":"#/components/schemas/ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"},"ValidationError":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"}}},"paths":{"/whatsapp-channels/{channel_id}/templates":{"get":{"tags":["whatsapp-channels"],"summary":"List Whatsapp Templates","operationId":"list_whatsapp_templates_whatsapp_channels__channel_id__templates_get","parameters":[{"name":"channel_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Channel Id"}},{"name":"X-API-Key","in":"header","required":false,"schema":{"title":"X-Api-Key","type":"string"}}],"responses":{"200":{"description":"Request completed successfully.","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/WhatsAppTemplateOut"},"title":"Response List Whatsapp Templates Whatsapp Channels Channel Id Templates Get"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}}}} ``` ## POST /whatsapp-channels/{channel\_id}/templates > Create Whatsapp Template ```json {"openapi":"3.1.0","info":{"title":"Umanize API","version":"0.1.0"},"tags":[{"name":"whatsapp-channels","description":"Onboard WhatsApp Business senders through Twilio Partner Solution, send test messages, and register approved Twilio ContentSid templates for campaign automations."}],"servers":[{"url":"https://api.aurorasuite.ai","description":"Production"}],"security":[{"bearerAuth":[]},{"apiKeyAuth":[]}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Use a JWT bearer token in the Authorization header."},"apiKeyAuth":{"type":"apiKey","in":"header","name":"X-API-Key","description":"Use an API key for server-to-server integrations."}},"schemas":{"WhatsAppTemplateCreate":{"properties":{"name":{"type":"string","maxLength":160,"minLength":1,"title":"Name"},"content_sid":{"type":"string","maxLength":64,"minLength":1,"title":"Content Sid"},"language":{"title":"Language","type":"string","maxLength":16},"status":{"type":"string","maxLength":32,"title":"Status","default":"active"},"variables":{"additionalProperties":true,"type":"object","title":"Variables"},"description":{"title":"Description","type":"string","maxLength":500}},"type":"object","required":["name","content_sid"],"title":"WhatsAppTemplateCreate"},"WhatsAppTemplateOut":{"properties":{"name":{"type":"string","maxLength":160,"minLength":1,"title":"Name"},"content_sid":{"type":"string","maxLength":64,"minLength":1,"title":"Content Sid"},"language":{"title":"Language","type":"string","maxLength":16},"status":{"type":"string","maxLength":32,"title":"Status","default":"active"},"variables":{"additionalProperties":true,"type":"object","title":"Variables"},"description":{"title":"Description","type":"string","maxLength":500},"id":{"type":"string","format":"uuid","title":"Id"},"channel_id":{"title":"Channel Id","type":"string","format":"uuid"},"created_at":{"type":"string","format":"date-time","title":"Created At"},"updated_at":{"type":"string","format":"date-time","title":"Updated At"}},"type":"object","required":["name","content_sid","id","created_at","updated_at"],"title":"WhatsAppTemplateOut"},"HTTPValidationError":{"properties":{"detail":{"items":{"$ref":"#/components/schemas/ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"},"ValidationError":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"}}},"paths":{"/whatsapp-channels/{channel_id}/templates":{"post":{"tags":["whatsapp-channels"],"summary":"Create Whatsapp Template","operationId":"create_whatsapp_template_whatsapp_channels__channel_id__templates_post","parameters":[{"name":"channel_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Channel Id"}},{"name":"X-API-Key","in":"header","required":false,"schema":{"title":"X-Api-Key","type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WhatsAppTemplateCreate"}}}},"responses":{"201":{"description":"Resource created successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WhatsAppTemplateOut"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}}}} ``` ## DELETE /whatsapp-channels/{channel\_id}/templates/{template\_id} > Delete Whatsapp Template ```json {"openapi":"3.1.0","info":{"title":"Umanize API","version":"0.1.0"},"tags":[{"name":"whatsapp-channels","description":"Onboard WhatsApp Business senders through Twilio Partner Solution, send test messages, and register approved Twilio ContentSid templates for campaign automations."}],"servers":[{"url":"https://api.aurorasuite.ai","description":"Production"}],"security":[{"bearerAuth":[]},{"apiKeyAuth":[]}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Use a JWT bearer token in the Authorization header."},"apiKeyAuth":{"type":"apiKey","in":"header","name":"X-API-Key","description":"Use an API key for server-to-server integrations."}},"schemas":{"HTTPValidationError":{"properties":{"detail":{"items":{"$ref":"#/components/schemas/ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"},"ValidationError":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"}}},"paths":{"/whatsapp-channels/{channel_id}/templates/{template_id}":{"delete":{"tags":["whatsapp-channels"],"summary":"Delete Whatsapp Template","operationId":"delete_whatsapp_template_whatsapp_channels__channel_id__templates__template_id__delete","parameters":[{"name":"channel_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Channel Id"}},{"name":"template_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Template Id"}},{"name":"X-API-Key","in":"header","required":false,"schema":{"title":"X-Api-Key","type":"string"}}],"responses":{"204":{"description":"Request completed successfully with no response body."},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}}}} ``` ## PATCH /whatsapp-channels/{channel\_id}/templates/{template\_id} > Update Whatsapp Template ```json {"openapi":"3.1.0","info":{"title":"Umanize API","version":"0.1.0"},"tags":[{"name":"whatsapp-channels","description":"Onboard WhatsApp Business senders through Twilio Partner Solution, send test messages, and register approved Twilio ContentSid templates for campaign automations."}],"servers":[{"url":"https://api.aurorasuite.ai","description":"Production"}],"security":[{"bearerAuth":[]},{"apiKeyAuth":[]}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Use a JWT bearer token in the Authorization header."},"apiKeyAuth":{"type":"apiKey","in":"header","name":"X-API-Key","description":"Use an API key for server-to-server integrations."}},"schemas":{"WhatsAppTemplateUpdate":{"properties":{"name":{"title":"Name","type":"string","maxLength":160,"minLength":1},"content_sid":{"title":"Content Sid","type":"string","maxLength":64,"minLength":1},"language":{"title":"Language","type":"string","maxLength":16},"status":{"title":"Status","type":"string","maxLength":32},"variables":{"title":"Variables","additionalProperties":true,"type":"object"},"description":{"title":"Description","type":"string","maxLength":500}},"type":"object","title":"WhatsAppTemplateUpdate"},"WhatsAppTemplateOut":{"properties":{"name":{"type":"string","maxLength":160,"minLength":1,"title":"Name"},"content_sid":{"type":"string","maxLength":64,"minLength":1,"title":"Content Sid"},"language":{"title":"Language","type":"string","maxLength":16},"status":{"type":"string","maxLength":32,"title":"Status","default":"active"},"variables":{"additionalProperties":true,"type":"object","title":"Variables"},"description":{"title":"Description","type":"string","maxLength":500},"id":{"type":"string","format":"uuid","title":"Id"},"channel_id":{"title":"Channel Id","type":"string","format":"uuid"},"created_at":{"type":"string","format":"date-time","title":"Created At"},"updated_at":{"type":"string","format":"date-time","title":"Updated At"}},"type":"object","required":["name","content_sid","id","created_at","updated_at"],"title":"WhatsAppTemplateOut"},"HTTPValidationError":{"properties":{"detail":{"items":{"$ref":"#/components/schemas/ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"},"ValidationError":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"}}},"paths":{"/whatsapp-channels/{channel_id}/templates/{template_id}":{"patch":{"tags":["whatsapp-channels"],"summary":"Update Whatsapp Template","operationId":"update_whatsapp_template_whatsapp_channels__channel_id__templates__template_id__patch","parameters":[{"name":"channel_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Channel Id"}},{"name":"template_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Template Id"}},{"name":"X-API-Key","in":"header","required":false,"schema":{"title":"X-Api-Key","type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WhatsAppTemplateUpdate"}}}},"responses":{"200":{"description":"Request completed successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WhatsAppTemplateOut"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}}}} ``` ## POST /whatsapp-channels/{channel\_id}/test-message > Send Test Whatsapp Message ```json {"openapi":"3.1.0","info":{"title":"Umanize API","version":"0.1.0"},"tags":[{"name":"whatsapp-channels","description":"Onboard WhatsApp Business senders through Twilio Partner Solution, send test messages, and register approved Twilio ContentSid templates for campaign automations."}],"servers":[{"url":"https://api.aurorasuite.ai","description":"Production"}],"security":[{"bearerAuth":[]},{"apiKeyAuth":[]}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Use a JWT bearer token in the Authorization header."},"apiKeyAuth":{"type":"apiKey","in":"header","name":"X-API-Key","description":"Use an API key for server-to-server integrations."}},"schemas":{"WhatsAppTestMessageRequest":{"properties":{"to_number":{"type":"string","maxLength":32,"minLength":6,"title":"To Number"},"body":{"type":"string","maxLength":1600,"minLength":1,"title":"Body"}},"type":"object","required":["to_number","body"],"title":"WhatsAppTestMessageRequest"},"WhatsAppMessageOut":{"properties":{"id":{"type":"string","format":"uuid","title":"Id"},"channel_id":{"title":"Channel Id","type":"string","format":"uuid"},"twilio_message_sid":{"title":"Twilio Message Sid","type":"string"},"direction":{"type":"string","title":"Direction"},"from_number":{"title":"From Number","type":"string"},"to_number":{"title":"To Number","type":"string"},"body":{"title":"Body","type":"string"},"status":{"title":"Status","type":"string"},"error_code":{"title":"Error Code","type":"string"},"created_at":{"type":"string","format":"date-time","title":"Created At"},"updated_at":{"type":"string","format":"date-time","title":"Updated At"}},"type":"object","required":["id","direction","created_at","updated_at"],"title":"WhatsAppMessageOut"},"HTTPValidationError":{"properties":{"detail":{"items":{"$ref":"#/components/schemas/ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"},"ValidationError":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"}}},"paths":{"/whatsapp-channels/{channel_id}/test-message":{"post":{"tags":["whatsapp-channels"],"summary":"Send Test Whatsapp Message","operationId":"send_test_whatsapp_message_whatsapp_channels__channel_id__test_message_post","parameters":[{"name":"channel_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Channel Id"}},{"name":"X-API-Key","in":"header","required":false,"schema":{"title":"X-Api-Key","type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WhatsAppTestMessageRequest"}}}},"responses":{"200":{"description":"Request completed successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WhatsAppMessageOut"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}}}} ``` --- # Agent Instructions: Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter: ``` GET https://docs.aurorasuite.ai/api-reference/integrations/whatsapp-business.md?ask= ``` The question should be specific, self-contained, and written in natural language. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.