Campaigns

Campaigns

List all campaigns in a workspace with pagination

get

Authorizations

apiAuth

Path parameters

workspaceIdstringRequired

ID of the workspace

Query parameters

pageintegerOptional

Page number for pagination

Default: 1

per_pageintegerOptional

Number of campaigns per page

Default: 15

namestringOptional

Filter campaigns by name

Responses

200

List of campaigns

application/json

successbooleanOptionalExample: true

messagestringOptionalExample: Campaigns retrieved successfully

404

Workspace not found

application/json

get

/api/workspaces/{workspaceId}/campaigns

HTTPcURLJavaScriptPython

GET /api/workspaces/{workspaceId}/campaigns HTTP/1.1
Accept: */*

{
  "success": true,
  "message": "Campaigns retrieved successfully",
  "data": [
    {
      "id": "text",
      "name": "text",
      "type": "text",
      "send_time_method": "text",
      "workspace_id": "text",
      "campaign_lists": [
        {
          "id": "text",
          "name": "text"
        }
      ]
    }
  ],
  "pagination": {
    "total": 1,
    "per_page": 1,
    "current_page": 1,
    "last_page": 1,
    "from": 1,
    "to": 1
  }
}

Store a newly created campaign.

post

Authorizations

apiAuth

Path parameters

workspaceIdstringRequired

ID of the workspace

Body

application/json

namestringOptional

Name of the campaign

Example: Example Campaign

typestringOptional

Type of the campaign

Example: whatsapp

whatsapp_message_template_idstringOptional

Template Id

Example: dd479c4d-7ce6-439e-9adc-6d128a1b6e2d

send_time_methodstringOptional

Send time method of the campaign

Example: NOW

list_idstring[]Optional

Array of list IDs

Example: dd479c4d-7ce6-439e-9adc-6d128a1b6e2d

Responses

201

Campaign created successfully

application/json

400

Validation Error(s)

application/json

404

Workspace or List not found

application/json

post

/api/workspaces/{workspaceId}/campaigns

HTTPcURLJavaScriptPython

POST /api/workspaces/{workspaceId}/campaigns HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 191

{
  "name": "Example Campaign",
  "type": "whatsapp",
  "whatsapp_message_template_id": "dd479c4d-7ce6-439e-9adc-6d128a1b6e2d",
  "send_time_method": "NOW",
  "list_id": [
    "dd479c4d-7ce6-439e-9adc-6d128a1b6e2d"
  ]
}

{
  "message": "Campaign created successfully",
  "campaign": {}
}

Show a campaign

get

Display a campaign by ID

Path parameters

workspaceIdstringRequired

ID of the workspace

campaignIdstringRequired

ID of the campaign to show

Responses

200

Campaign found

application/json

idstringRequired

UUID of the campaign

namestringRequired

Name of the campaign

typestringRequired

Type of the campaign

send_time_methodstringRequired

Method of sending the campaign

workspace_idstringRequired

ID of the workspace the campaign belongs to

404

Campaign not found

application/json

get

/api/workspaces/{workspaceId}/campaigns/{campaignId}

HTTPcURLJavaScriptPython

GET /api/workspaces/{workspaceId}/campaigns/{campaignId} HTTP/1.1
Accept: */*

{
  "id": "text",
  "name": "text",
  "type": "text",
  "send_time_method": "text",
  "workspace_id": "text",
  "campaign_lists": [
    {
      "id": "text",
      "name": "text"
    }
  ]
}

Update a campaign

patch

Update a campaign by ID

Path parameters

workspaceIdstringRequired

ID of the workspace

campaignIdstringRequired

ID of the campaign to update

Body

application/json

idstringRequired

UUID of the campaign

namestringRequired

Name of the campaign

typestringRequired

Type of the campaign

send_time_methodstringRequired

Method of sending the campaign

workspace_idstringRequired

ID of the workspace the campaign belongs to

Responses

200

Campaign updated

application/json

idstringRequired

UUID of the campaign

namestringRequired

Name of the campaign

typestringRequired

Type of the campaign

send_time_methodstringRequired

Method of sending the campaign

workspace_idstringRequired

ID of the workspace the campaign belongs to

404

Campaign not found

application/json

patch

/api/workspaces/{workspaceId}/campaigns/{campaignId}

HTTPcURLJavaScriptPython

PATCH /api/workspaces/{workspaceId}/campaigns/{campaignId} HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 136

{
  "id": "text",
  "name": "text",
  "type": "text",
  "send_time_method": "text",
  "workspace_id": "text",
  "campaign_lists": [
    {
      "id": "text",
      "name": "text"
    }
  ]
}

{
  "id": "text",
  "name": "text",
  "type": "text",
  "send_time_method": "text",
  "workspace_id": "text",
  "campaign_lists": [
    {
      "id": "text",
      "name": "text"
    }
  ]
}

Delete a campaign.

delete

Authorizations

apiAuth

Path parameters

workspaceIdstringRequired

ID of the workspace

campaignstringRequired

Campaign ID

Responses

200

Campaign deleted

application/json

messagestringOptionalExample: Campaign and its contacts deleted successfully

404

Campaign not found

application/json

delete

/api/workspaces/{workspaceId}/campaigns/{campaign}

HTTPcURLJavaScriptPython

DELETE /api/workspaces/{workspaceId}/campaigns/{campaign} HTTP/1.1
Accept: */*

{
  "message": "Campaign and its contacts deleted successfully"
}

Send a test message for a campaign

post

Authorizations

apiAuth

Path parameters

workspaceIdstringRequired

The ID of the workspace

Example: workspace123

Body

application/json

fromstringRequired

ID of the sender's WhatsApp phone number

Example: whatsapp123

idstringRequired

Campaign ID

Example: dd479c4d-7ce6-439e-9adc-6d128a1b6e2d

tostringRequired

Recipient's contact ID

Example: contact456

Responses

200

Test message sent successfully

application/json

messagestringOptionalExample: Test message sent successfully

400

Validation Error(s)

application/json

404

Resource not found

application/json

post

/api/workspaces/{workspaceId}/campaigns/send-test-message

HTTPcURLJavaScriptPython

POST /api/workspaces/{workspaceId}/campaigns/send-test-message HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 84

{
  "from": "whatsapp123",
  "id": "dd479c4d-7ce6-439e-9adc-6d128a1b6e2d",
  "to": "contact456"
}

{
  "message": "Test message sent successfully"
}

Send a campaign

post

Dispatches a campaign to send messages to all associated contacts, with optional scheduling.

Authorizations

apiAuth

Path parameters

workspaceIdstringRequired

ID of the workspace

Example: 2e1e4547-473e-4bf5-a3df-94dda12683aa

campaignIdstringRequired

ID of the campaign to be sent

Example: 368f2f16-d0f9-4ce4-9291-aa082501b515

Body

application/json

fromstringOptional

WhatsApp phone number ID from which messages are sent

Example: 108427225641466

Responses

200

Campaign sent or scheduled successfully

application/json

successbooleanOptionalExample: true

messagestringOptionalExample: Campaign scheduled to be sent at 2023-10-30 12:00:00

400

Validation error or failure to get access token

application/json

404

Campaign or Workspace not found

application/json

post

/api/workspaces/{workspaceId}/campaigns/{campaignId}/send

HTTPcURLJavaScriptPython

POST /api/workspaces/{workspaceId}/campaigns/{campaignId}/send HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 26

{
  "from": "108427225641466"
}

{
  "success": true,
  "message": "Campaign scheduled to be sent at 2023-10-30 12:00:00"
}

Get Campaign Report

get

Fetches a detailed report of contacts associated with a campaign, including message counts and their last status.

Authorizations

apiAuth

Path parameters

workspaceIdstringRequired

ID of the workspace

Example: 2e1e4547-473e-4bf5-a3df-94dda12683aa

campaignIdstringRequired

ID of the campaign

Example: 368f2f16-d0f9-4ce4-9291-aa082501b515

Responses

200

Campaign report retrieved successfully

application/json

campaign_idstringOptionalExample: 368f2f16-d0f9-4ce4-9291-aa082501b515

campaign_namestringOptionalExample: Winter Promotion

404

Campaign or Workspace not found

application/json

get

/api/workspaces/{workspaceId}/campaigns/{campaignId}/report

HTTPcURLJavaScriptPython

GET /api/workspaces/{workspaceId}/campaigns/{campaignId}/report HTTP/1.1
Accept: */*

{
  "campaign_id": "368f2f16-d0f9-4ce4-9291-aa082501b515",
  "campaign_name": "Winter Promotion",
  "report": [
    {
      "contact_id": "12345678-1234-5678-1234-567812345678",
      "contact_phone_number": "[phone]",
      "total_messages": 5,
      "status": "delivered"
    }
  ]
}

Pause a campaign

patch

Authorizations

apiAuth

Path parameters

workspaceIdstringRequired

ID of the workspace

campaignstringRequired

ID of the campaign to pause

Responses

200

Campaign paused successfully

application/json

successbooleanOptionalExample: true

messagestringOptionalExample: Campaign paused successfully

400

Invalid request

application/json

404

Campaign not found

application/json

patch

/api/workspaces/{workspaceId}/campaigns/{campaign}/pause

HTTPcURLJavaScriptPython

PATCH /api/workspaces/{workspaceId}/campaigns/{campaign}/pause HTTP/1.1
Accept: */*

{
  "success": true,
  "message": "Campaign paused successfully"
}

Cancel a campaign

patch

Authorizations

apiAuth

Path parameters

workspaceIdstringRequired

ID of the workspace

campaignstringRequired

ID of the campaign to cancel

Responses

200

Campaign canceled successfully

application/json

successbooleanOptionalExample: true

messagestringOptionalExample: Campaign canceled successfully

400

Invalid request

application/json

404

Campaign not found

application/json

patch

/api/workspaces/{workspaceId}/campaigns/{campaign}/cancel

HTTPcURLJavaScriptPython

PATCH /api/workspaces/{workspaceId}/campaigns/{campaign}/cancel HTTP/1.1
Accept: */*

{
  "success": true,
  "message": "Campaign canceled successfully"
}

Activate a campaign

patch

Authorizations

apiAuth

Path parameters

workspaceIdstringRequired

ID of the workspace

Example: workspace123

campaignstringRequired

ID of the campaign to activate

Example: campaign456

Responses

200

Campaign activated successfully

application/json

successbooleanOptionalExample: true

messagestringOptionalExample: Campaign activated successfully

400

Invalid request

application/json

404

Campaign not found

application/json

patch

/api/workspaces/{workspaceId}/campaigns/{campaign}/activate

HTTPcURLJavaScriptPython

PATCH /api/workspaces/{workspaceId}/campaigns/{campaign}/activate HTTP/1.1
Accept: */*

{
  "success": true,
  "message": "Campaign activated successfully"
}