Skip to main content
POST
/
v1
/
message
/
send-campaign
Send Campaign Message
curl --request POST \
  --url https://karibu.briq.tz/v1/message/send-campaign \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "campaign_id": "<string>",
  "content": "<string>",
  "sender_id": "<string>"
}
'
{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>"
    }
  ]
}

Authorizations

​
X-API-Key
string
header
required

Headers

​
X-API-Key
string
required
​
X-App-ID
string | null

Body

application/json

Campaign sending Request Schema.

​
campaign_id
string
required
​
content
string
required
Example:

"Greetings from Briq! We're here to make communication simple, reliable, and seamless. The future of messaging is bright."

​
sender_id
string
required
Required string length: 2 - 13
​
start_date
string<date-time> | null

When sending starts

​
end_date
string<date-time> | null
​
frequency
enum<string> | null
default:once

Campaign Frequency.

Available options:
once,
hourly,
daily,
weekly,
monthly

Response

Successful Response