POST
/
api
/
campaigns

Authorizations

Authorization
string
headerrequired

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
name
string
required

The name of the campaign

groupMembersLimit
number
required

The maximum number of members allowed in a group

releaseDate
string
required

The date and time when the campaign will be released

acceptEntriesUntil
string
required

The date and time until which entries will be accepted for the campaign

whatsappId
string | null

The ID of the WhatsApp connection associated with the campaign

Response

201 - application/json
id
string
required

The ID of the campaign

name
string
required

The name of the campaign

groupMembersLimit
integer
required

The limit of members for each group in the campaign

releaseDate
string
required

The release date of the campaign

acceptEntriesUntil
string
required

The deadline for accepting entries for the campaign

isActive
boolean
required

Indicates if the campaign is active

companyId
string
required

The ID of the company associated with the campaign

whatsappId
string
required

The WhatsApp ID associated with the campaign

createdAt
string
required

The date and time when the campaign was created

updatedAt
string
required

The date and time when the campaign was last updated

groups
object[]
required

The groups associated with the campaign

Delete DepartmentGet Campaign by ID