Create SMS campaign

POST

https://api.jokoor.com/v1/sms/campaigns

Last modified:2025-11-15 15:49:01

Maintainer:Not configured

OperationId:createSMSCampaign

Create a new SMS campaign to send bulk messages

Request

Authorization

JWT Bearer

Add the parameter

Authorization

to Headers

Example:

Authorization: ********************

Body Params application/jsonRequired

Examples

Responses

🟢201Created

application/json

Campaign created

Body

Request Example

Shell

JavaScript

Java

Swift

curl --location --request POST 'https://api.jokoor.com/v1/sms/campaigns' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data-raw '{
    "name": "string",
    "message_body": "string",
    "template_id": "string",
    "template_params": {
        "property1": "string",
        "property2": "string"
    },
    "sender_id": "string",
    "contact_ids": [
        "string"
    ],
    "group_ids": [
        "string"
    ],
    "scheduled_at": "2019-08-24T14:15:22Z",
    "is_draft": true
}'

Response Example

{
    "data": {
        "id": "string",
        "organization_id": "string",
        "name": "string",
        "message_template_id": "string",
        "sender_id_config_id": "string",
        "status": "draft",
        "scheduled_at": "2019-08-24T14:15:22Z",
        "started_at": "2019-08-24T14:15:22Z",
        "completed_at": "2019-08-24T14:15:22Z",
        "created_by": "string",
        "created_at": "2019-08-24T14:15:22Z",
        "updated_at": "2019-08-24T14:15:22Z",
        "details": {
            "total_message_count": 0,
            "total_sent_messages": 0,
            "total_failed_messages": 0,
            "total_pending_messages": 0,
            "total_segments_used": 0,
            "delivery_rate": 0,
            "failure_rate": 0,
            "pending_rate": 0,
            "status_breakdown": {
                "property1": 0,
                "property2": 0
            }
        },
        "metadata": {}
    }
}

Modified at 2025-11-15 15:49:01

Remove contacts from group

List SMS campaigns