User
WhatsApp Campaigns
Screen guide
Before you start
Use the account and workspace that own the relevant records. The feature also needs to be enabled for this installation and plan.
Open this feature
- Open /portal/whatsapp-hub/campaigns/create on your site.
Steps
Choose a task
Create or update: Save changes / Save campaign
- Open /portal/whatsapp-hub/campaigns/create on your application domain, using the workspace account for this task.
- Find the form containing WhatsApp sender, Campaign name, Campaign status. Complete the relevant fields using the table below. Fields can appear or change after you select an option.
- Use the button shown for the current state: Save changes, Save campaign. Creation and editing can show different labels; submit the form once.
- If the application identifies a missing or invalid field, correct that field and submit again. If an external request or payment has an uncertain outcome, check its history before repeating it.
| Field | What to enter or choose |
|---|---|
| WhatsApp sender | Required. Enter a number in the unit shown by this setting. Check any currency, duration or count label before saving. |
| Campaign name | Required. Enter the campaign name for this task, using the help or example shown by the form. Internal name used to find this campaign later. Maximum 120 characters. |
| Campaign status | Required. Enter the campaign status for this task, using the help or example shown by the form. |
| Approved template | Required. Enter the approved template for this task, using the help or example shown by the form. Maximum 255 characters. |
| Audience stage | Required. Enter the audience stage for this task, using the help or example shown by the form. |
| Delivery | Required. Choose Queue manually after review, Schedule delivery. |
| Scheduled time | Optional unless the current form requests it. Enter the scheduled time for this task, using the help or example shown by the form. Recipients and consent are checked again when delivery starts. |
| Plan start date | Optional unless the current form requests it. Use the date/time picker. Check the date range and the timezone shown by your account or this screen. |
| Plan end date | Optional unless the current form requests it. Use the date/time picker. Check the date range and the timezone shown by your account or this screen. |
| Description | Optional unless the current form requests it. Enter the description for this task, using the help or example shown by the form. Maximum 1000 characters. |
| Internal notes | Optional unless the current form requests it. Enter the internal notes for this task, using the help or example shown by the form. Maximum 1000 characters. |
Use Queue campaign
- Open /portal/whatsapp-hub/campaigns/create on your application domain, using the workspace account for this task.
- Select the intended record or item first and review its displayed values. There is no separate input form described for this control.
- Select Queue campaign. Check the current record, recipients, amount or destination before confirming when those values apply.
- If the application identifies a missing or invalid field, correct that field and submit again. If an external request or payment has an uncertain outcome, check its history before repeating it.
Fields and choices
Field descriptions appear beside each task above so that separate forms are not mixed together.
Check the result
- Stay in the same account/workspace and reopen the intended record or result screen.
- For saved settings, compare the displayed values with the choices you made. For filters and previews, check the current result scope.
- For queued or external work, inspect its status/history and provider result where applicable. A successful save does not by itself prove message delivery, publication, payment completion or provider approval.
Common problems
| Problem | What to check |
|---|---|
| The screen or action is missing | Check the correct workspace account, role, enabled app and plan. A hidden action is not fixed by typing an internal endpoint. |
| A field is rejected | Read its validation message, choose from the offered options and check the relevant format or limit. Do not substitute a database ID for a displayed choice. |
| A list is empty | Check the selected workspace, search text, date range and status filters. Clear one filter at a time before concluding that records are missing. |
| A request is still pending | Check its status/history before repeating it. For messages, publishing, imports and payments, a submitted request can finish later or fail separately. |
Technical reference
Role-scoped source references
Pinned commit: 37d44a1727216f5c492205024b323aa522730ebc
Source-only route information
| Method | Source-default route |
|---|---|
| GET | /portal/whatsapp-hub/campaigns/create |
| GET | /portal/whatsapp-hub/campaigns/{campaignId}/edit |
| GET | /portal/whatsapp-hub/campaigns |
Unmapped fields — not user instructions
These fields belong to this role’s source handler, but their screen labels were not confirmed.
| Source key | Handler |
|---|---|
| form.name | modules/WhatsappCRM/WhatsappCrmCampaigns/Livewire/WhatsappCampaignWorkspace.php |
| form.status | modules/WhatsappCRM/WhatsappCrmCampaigns/Livewire/WhatsappCampaignWorkspace.php |
| form.color | modules/WhatsappCRM/WhatsappCrmCampaigns/Livewire/WhatsappCampaignWorkspace.php |
| form.starts_on | modules/WhatsappCRM/WhatsappCrmCampaigns/Livewire/WhatsappCampaignWorkspace.php |
| form.ends_on | modules/WhatsappCRM/WhatsappCrmCampaigns/Livewire/WhatsappCampaignWorkspace.php |
| form.description | modules/WhatsappCRM/WhatsappCrmCampaigns/Livewire/WhatsappCampaignWorkspace.php |
| form.notes | modules/WhatsappCRM/WhatsappCrmCampaigns/Livewire/WhatsappCampaignWorkspace.php |
| form.account_id | modules/WhatsappCRM/WhatsappCrmCampaigns/Livewire/WhatsappCampaignWorkspace.php |
| form.template_name | modules/WhatsappCRM/WhatsappCrmCampaigns/Livewire/WhatsappCampaignWorkspace.php |
| form.audience_stage | modules/WhatsappCRM/WhatsappCrmCampaigns/Livewire/WhatsappCampaignWorkspace.php |
| form.send_mode | modules/WhatsappCRM/WhatsappCrmCampaigns/Livewire/WhatsappCampaignWorkspace.php |
| form.scheduled_at | modules/WhatsappCRM/WhatsappCrmCampaigns/Livewire/WhatsappCampaignWorkspace.php |