Skip to main content
POST
Create campaign
Call this endpoint on the campaigns service: https://campaigns.pingmee.co.il.
Creates a campaign that runs a workflow. Recipients come from tags or an Excel list. Each choice shows only its own fields.

Authorizations

Personal access token from Pingmee Settings → Developer Tools

x-api-key
string
header
required

Business API key from Pingmee Settings → Developer Tools

Body

application/json

Campaign to create.

id
string
required

Campaign id.

name
string
required

Campaign name.

contentType
enum<string>
required

Runs a workflow.

Available options:
triggerWorkflow
workflowId
string
required

Workflow id.

workflowName
string
required

Workflow name.

folderId
string
required

Campaign folder id. In the Pingmee app this is the path segment in https://chat.pingmee.co.il/dashboard/campaigns/{folderId}.

Example:

"1785185339087"

whenToSendMessage
enum<string>
required

now sends immediately. future sends at scheduledAt.

Available options:
now,
future
associatedToBusinessId
string
required

Phone number id the campaign sends from.

isActive
boolean
required

Whether the campaign is active.

source
enum<string>
required

Send to tagged conversations.

Available options:
tags
conversationTags
object[]
required

Tags.

description
string

Campaign description.

scheduledAt
number

Send time in Unix milliseconds. Required when whenToSendMessage is future.

audienceCountry
string

ISO country code for numbers without a calling code.

Example:

"IL"

Response

Campaign created

message
string
required
Example:

"Campaign '1710000000000' created."

Last modified on October 14, 2026