Communications

Server

List sms

GET

https://accounts.multitenant.slade360.co.ke

/api/notifications/sms

Get objects from the DB/cache.

List sms › query Parameters

branch_id

string

cluster_id

string

created

string

created_by

string

date_from

string

date_to

string

delivery_type

string

Indicates whether an SMS is inbound or outbound

OUTBOUND - OUTBOUND
INBOUND - INBOUND

department_id

string

failure_reason

string

format

string

id

string

intention

string

message

string

ordering

string

Which field to use when ordering the results.

organisation

string

page

string

A page number within the paginated result set.

page_size

string

Number of results to return per page.

recipients

string

search

string

A search term.

sender

string

sil_comms_sms_id

string

state

string

QUEUED - QUEUED
FAILED - FAILED
SENT - SENT
REJECTED - REJECTED
DELIVERED - DELIVERED
UNDELIVERED - UNDELIVERED
RECEIVED - RECEIVED
RETRIED - RETRIED

updated

string

updated_by

string

workstation_id

string

List sms › Responses

200

Untitled Response

count

string

object[]

next

string

previous

string

GET/api/notifications/sms

curl https://accounts.multitenant.slade360.co.ke/api/notifications/sms \
  --header 'Authorization: Bearer <token>'

Example Responses

{
  "count": "<integer>",
  "results": [
    {
      "created_by_name": "<string>",
      "from_field": "<string>",
      "id": "<uuid>",
      "intention": "<string>",
      "message": "<string>",
      "recipients": [
        "<string>",
        "<string>"
      ],
      "sender": {
        "created_by_name": "<string>",
        "disabled": {},
        "end_date": "<dateTime>",
        "id": "<uuid>",
        "name": "<string>",
        "sender_type": "PROMOTION",
        "start_date": "<dateTime>",
        "updated_by_name": "<string>",
        "active": "<boolean>",
        "classification": "SENDER_ID",
        "available_from": "<time>",
        "available_to": "<time>"
      },
      "to_field": "<string>",
      "updated_by_name": "<string>",
      "active": "<boolean>",
      "state": "RETRIED",
      "sil_comms_sms_id": "<uuid>",
      "failure_reason": "<string>",
      "delivery_type": "INBOUND"
    },
    {
      "created_by_name": "<string>",
      "from_field": "<string>",
      "id": "<uuid>",
      "intention": "<string>",
      "message": "<string>",
      "recipients": [
        "<string>",
        "<string>"
      ],
      "sender": {
        "created_by_name": "<string>",
        "disabled": {},
        "end_date": "<dateTime>",
        "id": "<uuid>",
        "name": "<string>",
        "sender_type": "TRANSACTION",
        "start_date": "<dateTime>",
        "updated_by_name": "<string>",
        "active": "<boolean>",
        "classification": "INTERACTIVE_SHORTCODE",
        "available_from": "<time>",
        "available_to": "<time>"
      },
      "to_field": "<string>",
      "updated_by_name": "<string>",
      "active": "<boolean>",
      "state": "RETRIED",
      "sil_comms_sms_id": "<uuid>",
      "failure_reason": "<string>",
      "delivery_type": "OUTBOUND"
    }
  ],
  "next": "<uri>",
  "previous": "<uri>"
}

json

application/json

Generate sms log report

POST

https://accounts.multitenant.slade360.co.ke

/api/notifications/sms/generate_sms_log_report

Generates an Excel type SMS log report.

Generate sms log report › query Parameters

format

string

Generate sms log report › Request Body

intention

string

message

string

recipients

string[]

object

active

string

state

string

sil_comms_sms_id

string

failure_reason

string

delivery_type

string

Generate sms log report › Responses

200

Untitled Response

created_by_name

string

from_field

string

id

string

intention

string

message

string

recipients

string[]

object

to_field

string

updated_by_name

string

active

string

state

string

sil_comms_sms_id

string

failure_reason

string

delivery_type

string

POST/api/notifications/sms/generate_sms_log_report

curl https://accounts.multitenant.slade360.co.ke/api/notifications/sms/generate_sms_log_report \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'sessionid: <api-key>' \
  --data '{
  "intention": "<string>",
  "message": "<string>",
  "recipients": [
    "<string>",
    "<string>"
  ],
  "sender": {
    "end_date": "<dateTime>",
    "name": "<string>",
    "sender_type": "PROMOTION",
    "start_date": "<dateTime>",
    "active": "<boolean>",
    "classification": "INTERACTIVE_SHORTCODE",
    "available_from": "<time>",
    "available_to": "<time>"
  },
  "active": "<boolean>",
  "state": "DELIVERED",
  "sil_comms_sms_id": "<uuid>",
  "failure_reason": "<string>",
  "delivery_type": "INBOUND"
}'

Example Request Body

{
  "intention": "<string>",
  "message": "<string>",
  "recipients": [
    "<string>",
    "<string>"
  ],
  "sender": {
    "end_date": "<dateTime>",
    "name": "<string>",
    "sender_type": "PROMOTION",
    "start_date": "<dateTime>",
    "active": "<boolean>",
    "classification": "INTERACTIVE_SHORTCODE",
    "available_from": "<time>",
    "available_to": "<time>"
  },
  "active": "<boolean>",
  "state": "DELIVERED",
  "sil_comms_sms_id": "<uuid>",
  "failure_reason": "<string>",
  "delivery_type": "INBOUND"
}

json

application/json

Example Responses

{
  "created_by_name": "<string>",
  "from_field": "<string>",
  "id": "<uuid>",
  "intention": "<string>",
  "message": "<string>",
  "recipients": [
    "<string>",
    "<string>"
  ],
  "sender": {
    "created_by_name": "<string>",
    "disabled": {},
    "end_date": "<dateTime>",
    "id": "<uuid>",
    "name": "<string>",
    "sender_type": "PROMOTION",
    "start_date": "<dateTime>",
    "updated_by_name": "<string>",
    "active": "<boolean>",
    "classification": "SENDER_ID",
    "available_from": "<time>",
    "available_to": "<time>"
  },
  "to_field": "<string>",
  "updated_by_name": "<string>",
  "active": "<boolean>",
  "state": "SENT",
  "sil_comms_sms_id": "<uuid>",
  "failure_reason": "<string>",
  "delivery_type": "OUTBOUND"
}

json

application/json

Send sms through segment

POST

https://accounts.multitenant.slade360.co.ke

/api/segments/segment-message/send_sms

Sends message to one or more segments at a time.

Payload format: { "segment_ids": "[ "", "", ]", "sender_id": "", "template_id": "", "template": { "name": "", "template": "", "message_type": "" }, "delivery_type": "", "scheduled_at": "<YYYY-MM-DD HH:mm:SS", "sequence_interval": "", # crontab string }

Send sms through segment › Headers

X-Cluster

string

X-Workstation

string

X-Branch

string

X-Department

string

Send sms through segment › Request Body

segment_ids

string[]

sender_id

string

delivery_type

string

send_on_segment_join

boolean

template

string

scheduled_at

string · date-time

Send sms through segment › Responses

200

Untitled Response

created

string

created_by

string

created_by_name

string

delivery_type

string

id

string

object

organisation

string

segment

string

object

template

string

updated

string

updated_by

string

updated_by_name

string

active

string

send_on_segment_join

string

scheduled_at

string

sequence_interval

string

task

string

POST/api/segments/segment-message/send_sms

curl https://accounts.multitenant.slade360.co.ke/api/segments/segment-message/send_sms \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer <token>' \
  --data '{
  "segment_ids": [
    "64245247-d09d-4a67-b009-ed96b409acc4"
  ],
  "sender_id": "50c80146-401d-4e51-acd3-c8e13cea03e9",
  "delivery_type": "SCHEDULED_ONE_TIME",
  "send_on_segment_join": false,
  "template": "Test message",
  "scheduled_at": "2025-04-25T13:00:00.000000+03:00"
}'

Example Request Body

{
  "segment_ids": [
    "64245247-d09d-4a67-b009-ed96b409acc4"
  ],
  "sender_id": "50c80146-401d-4e51-acd3-c8e13cea03e9",
  "delivery_type": "SCHEDULED_ONE_TIME",
  "send_on_segment_join": false,
  "template": "Test message",
  "scheduled_at": "2025-04-25T13:00:00.000000+03:00"
}

json

application/json

Example Responses

{
  "created": "<dateTime>",
  "created_by": "<uuid>",
  "created_by_name": "<string>",
  "delivery_type": "SCHEDULED_ONE_TIME",
  "id": "<uuid>",
  "message": {
    "has_sequence": "<boolean>",
    "id": "<uuid>",
    "message_type": "SEQUENCED",
    "name": "<string>",
    "sequence": "<string>",
    "status": "<string>",
    "template": "<string>",
    "template_en": "<string>",
    "template_fr": "<string>",
    "template_sw": "<string>"
  },
  "organisation": "<uuid>",
  "segment": "<uuid>",
  "sender": {
    "created_by_name": "<string>",
    "disabled": {},
    "end_date": "<dateTime>",
    "id": "<uuid>",
    "name": "<string>",
    "sender_type": "PROMOTION",
    "start_date": "<dateTime>",
    "updated_by_name": "<string>",
    "active": "<boolean>",
    "classification": "INTERACTIVE_SHORTCODE",
    "available_from": "<time>",
    "available_to": "<time>"
  },
  "template": "<uuid>",
  "updated": "<dateTime>",
  "updated_by": "<uuid>",
  "updated_by_name": "<string>",
  "active": "<boolean>",
  "send_on_segment_join": "<boolean>",
  "scheduled_at": "<dateTime>",
  "sequence_interval": "<string>",
  "task": "<integer>"
}

json

application/json

List segments

GET

https://accounts.multitenant.slade360.co.ke

/api/segments/segment-message

Get objects from the DB/cache.

List segments › query Parameters

created

string

created_by

string

delivery_type

string

INSTANT - Sends message immediately
SCHEDULED_ONE_TIME - Sends a scheduled message once
SCHEDULED_RECURRENT - Sends a scheduled message recurrently

format

string

id

string

ordering

string

Which field to use when ordering the results.

organisation

string

page

string

A page number within the paginated result set.

page_size

string

Number of results to return per page.

scheduled_at

string

search

string

A search term.

segment

string

send_on_segment_join

string

sender

string

sequence_interval

string

task

string

template

string

updated

string

updated_by

string

List segments › Responses

200

Untitled Response

count

string

object[]

next

string

previous

string

GET/api/segments/segment-message

curl https://accounts.multitenant.slade360.co.ke/api/segments/segment-message \
  --header 'Authorization: Bearer <token>'

Example Responses

{
  "count": "<integer>",
  "results": [
    {
      "created": "<dateTime>",
      "created_by": "<uuid>",
      "created_by_name": "<string>",
      "delivery_type": "INSTANT",
      "id": "<uuid>",
      "message": {
        "has_sequence": "<boolean>",
        "id": "<uuid>",
        "message_type": "SEQUENCED",
        "name": "<string>",
        "sequence": "<string>",
        "status": "<string>",
        "template": "<string>",
        "template_en": "<string>",
        "template_fr": "<string>",
        "template_sw": "<string>"
      },
      "organisation": "<uuid>",
      "segment": "<uuid>",
      "sender": {
        "created_by_name": "<string>",
        "disabled": {},
        "end_date": "<dateTime>",
        "id": "<uuid>",
        "name": "<string>",
        "sender_type": "TRANSACTION",
        "start_date": "<dateTime>",
        "updated_by_name": "<string>",
        "active": "<boolean>",
        "classification": "INTERACTIVE_SHORTCODE",
        "available_from": "<time>",
        "available_to": "<time>"
      },
      "template": "<uuid>",
      "updated": "<dateTime>",
      "updated_by": "<uuid>",
      "updated_by_name": "<string>",
      "active": "<boolean>",
      "send_on_segment_join": "<boolean>",
      "scheduled_at": "<dateTime>",
      "sequence_interval": "<string>",
      "task": "<integer>"
    },
    {
      "created": "<dateTime>",
      "created_by": "<uuid>",
      "created_by_name": "<string>",
      "delivery_type": "INSTANT",
      "id": "<uuid>",
      "message": {
        "has_sequence": "<boolean>",
        "id": "<uuid>",
        "message_type": "SINGULAR",
        "name": "<string>",
        "sequence": "<string>",
        "status": "<string>",
        "template": "<string>",
        "template_en": "<string>",
        "template_fr": "<string>",
        "template_sw": "<string>"
      },
      "organisation": "<uuid>",
      "segment": "<uuid>",
      "sender": {
        "created_by_name": "<string>",
        "disabled": {},
        "end_date": "<dateTime>",
        "id": "<uuid>",
        "name": "<string>",
        "sender_type": "TRANSACTION",
        "start_date": "<dateTime>",
        "updated_by_name": "<string>",
        "active": "<boolean>",
        "classification": "SENDER_ID",
        "available_from": "<time>",
        "available_to": "<time>"
      },
      "template": "<uuid>",
      "updated": "<dateTime>",
      "updated_by": "<uuid>",
      "updated_by_name": "<string>",
      "active": "<boolean>",
      "send_on_segment_join": "<boolean>",
      "scheduled_at": "<dateTime>",
      "sequence_interval": "<string>",
      "task": "<integer>"
    }
  ],
  "next": "<uri>",
  "previous": "<uri>"
}

json

application/json

Create segment

POST

https://accounts.multitenant.slade360.co.ke

/api/segments/segment

Create and persist single or multiple records.

Create segment › Headers

X-Cluster

string

X-Workstation

string

X-Branch

string

X-Department

string

Create segment › Request Body

name

string

description

string

array

Create segment › Responses

Untitled Response

created

string

id

string

member_count

string

name

string

status

string

object

label

string

description

string

object

ussd_enabled

string

send_welcome_message_notification

string

filter_execution_status

string

classification

string

POST/api/segments/segment

curl https://accounts.multitenant.slade360.co.ke/api/segments/segment \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer <token>' \
  --data '{
  "name": "Test Segment",
  "description": "Test description",
  "filter_groups": []
}'

Example Request Body

{
  "name": "Test Segment",
  "description": "Test description",
  "filter_groups": []
}

json

application/json

Example Responses

{
  "created": "<dateTime>",
  "id": "<uuid>",
  "member_count": "<integer>",
  "name": "<string>",
  "status": "ACTIVE",
  "welcome_message_template": {
    "has_sequence": "<boolean>",
    "id": "<uuid>",
    "message_type": "SINGULAR",
    "name": "<string>",
    "sequence": "<string>",
    "status": "<string>",
    "template": "<string>",
    "template_en": "<string>",
    "template_fr": "<string>",
    "template_sw": "<string>"
  },
  "label": "CERVICAL_CANCER_HIGH_RISK",
  "description": "<string>",
  "attributes": {
    "nullable": true,
    "description": "stores characteristics of a segment as defined by the user."
  },
  "ussd_enabled": "<boolean>",
  "send_welcome_message_notification": "<boolean>",
  "filter_execution_status": "FAILED",
  "classification": "JOURNEY"
}

json

application/json

Set segment status

PATCH

https://accounts.multitenant.slade360.co.ke

/api/segments/segment/{id}/transition/{status}

Segment Transition Log API View.

Set segment status › path Parameters

id

string · required

(Required)

status

string · required

(Required) Status: ACTIVE/RETIRED

Set segment status › Request Body

Set segment status › Responses

200

Untitled Response

created

string

id

string

member_count

string

name

string

status

string

object

label

string

description

string

object

ussd_enabled

string

send_welcome_message_notification

string

filter_execution_status

string

classification

string

PATCH/api/segments/segment/{id}/transition/{status}

curl https://accounts.multitenant.slade360.co.ke/api/segments/segment/:id/transition/:status \
  --request PATCH \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer <token>' \
  --data '{}'

Example Request Body

{}

json

application/json

Example Responses

{
  "created": "<dateTime>",
  "id": "<uuid>",
  "member_count": "<integer>",
  "name": "<string>",
  "status": "ACTIVE",
  "welcome_message_template": {
    "has_sequence": "<boolean>",
    "id": "<uuid>",
    "message_type": "SINGULAR",
    "name": "<string>",
    "sequence": "<string>",
    "status": "<string>",
    "template": "<string>",
    "template_en": "<string>",
    "template_fr": "<string>",
    "template_sw": "<string>"
  },
  "label": "CERVICAL_CANCER_HIGH_RISK",
  "description": "<string>",
  "attributes": {
    "nullable": true,
    "description": "stores characteristics of a segment as defined by the user."
  },
  "ussd_enabled": "<boolean>",
  "send_welcome_message_notification": "<boolean>",
  "filter_execution_status": "FAILED",
  "classification": "JOURNEY"
}

json

application/json

Update segment with welcome message

PATCH

https://accounts.multitenant.slade360.co.ke

/api/segments/segment/{id}

Segment viewset.

Update segment with welcome message › path Parameters

id

string · required

(Required) A UUID string identifying this segment.

Update segment with welcome message › Request Body

welcome_message_template_id

string

send_welcome_message_notification

boolean

Update segment with welcome message › Responses

200

Untitled Response

created

string

id

string

member_count

string

name

string

status

string

object

label

string

description

string

object

ussd_enabled

string

send_welcome_message_notification

string

filter_execution_status

string

classification

string

PATCH/api/segments/segment/{id}

curl https://accounts.multitenant.slade360.co.ke/api/segments/segment/:id \
  --request PATCH \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer <token>' \
  --data '{
  "welcome_message_template_id": "ea31dcd3-2d22-4b57-bd5f-9e12b098b0dc",
  "send_welcome_message_notification": true
}'

Example Request Body

{
  "welcome_message_template_id": "ea31dcd3-2d22-4b57-bd5f-9e12b098b0dc",
  "send_welcome_message_notification": true
}

json

application/json

Example Responses

{
  "created": "<dateTime>",
  "id": "<uuid>",
  "member_count": "<integer>",
  "name": "<string>",
  "status": "ACTIVE",
  "welcome_message_template": {
    "has_sequence": "<boolean>",
    "id": "<uuid>",
    "message_type": "SINGULAR",
    "name": "<string>",
    "sequence": "<string>",
    "status": "<string>",
    "template": "<string>",
    "template_en": "<string>",
    "template_fr": "<string>",
    "template_sw": "<string>"
  },
  "label": "CERVICAL_CANCER_HIGH_RISK",
  "description": "<string>",
  "attributes": {
    "nullable": true,
    "description": "stores characteristics of a segment as defined by the user."
  },
  "ussd_enabled": "<boolean>",
  "send_welcome_message_notification": "<boolean>",
  "filter_execution_status": "FAILED",
  "classification": "JOURNEY"
}

json

application/json

List templates

GET

https://accounts.multitenant.slade360.co.ke

/api/segments/template

MessageTemplate viewset.

List templates › query Parameters

branch_id

string

category

string

INSTANT - Instant message.
GENERAL - General message.

cluster_id

string

created

string

created_by

string

department_id

string

format

string

id

string

message_type

string

SEQUENCED - A sequenced message template.
SINGULAR - A standalone message

name

string

ordering

string

Which field to use when ordering the results.

organisation

string

page

string

A page number within the paginated result set.

page_size

string

Number of results to return per page.

parent

string

search

string

A search term.

status

string

DRAFT - Message in draft state
ACTIVE - Message in active state
RETIRED - Message in retired state

template

string

template_en

string

template_fr

string

template_sw

string

updated

string

updated_by

string

workstation_id

string

List templates › Responses

200

Untitled Response

count

string

object[]

next

string

previous

string

GET/api/segments/template

curl https://accounts.multitenant.slade360.co.ke/api/segments/template \
  --header 'Authorization: Bearer <token>'

Example Responses

{
  "count": "<integer>",
  "results": [
    {
      "has_sequence": "<boolean>",
      "id": "<uuid>",
      "message_type": "SINGULAR",
      "name": "<string>",
      "sequence": "<string>",
      "status": "<string>",
      "template": "<string>",
      "template_en": "<string>",
      "template_fr": "<string>",
      "template_sw": "<string>"
    },
    {
      "has_sequence": "<boolean>",
      "id": "<uuid>",
      "message_type": "SEQUENCED",
      "name": "<string>",
      "sequence": "<string>",
      "status": "<string>",
      "template": "<string>",
      "template_en": "<string>",
      "template_fr": "<string>",
      "template_sw": "<string>"
    }
  ],
  "next": "<uri>",
  "previous": "<uri>"
}

json

application/json

Create a draft message template

POST

https://accounts.multitenant.slade360.co.ke

/api/segments/template

Create and persist single or multiple records.

Create a draft message template › Headers

X-Cluster

string

X-Workstation

string

X-Branch

string

X-Department

string

Create a draft message template › Request Body

name

string

message_type

string

template

string

status

string

Create a draft message template › Responses

Untitled Response

has_sequence

string

id

string

message_type

string

name

string

sequence

string

status

string

template

string

template_en

string

template_fr

string

template_sw

string

POST/api/segments/template

curl https://accounts.multitenant.slade360.co.ke/api/segments/template \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer <token>' \
  --data '{
  "name": "Test Segment",
  "message_type": "SINGULAR",
  "template": "Test",
  "status": "DRAFT"
}'

Example Request Body

{
  "name": "Test Segment",
  "message_type": "SINGULAR",
  "template": "Test",
  "status": "DRAFT"
}

json

application/json

Example Responses

{
  "has_sequence": "<boolean>",
  "id": "<uuid>",
  "message_type": "SINGULAR",
  "name": "<string>",
  "sequence": "<string>",
  "status": "<string>",
  "template": "<string>",
  "template_en": "<string>",
  "template_fr": "<string>",
  "template_sw": "<string>"
}

json

application/json

Update segment

PATCH

https://accounts.multitenant.slade360.co.ke

/api/segments/template/{id}

MessageTemplate viewset.

Update segment › path Parameters

id

string · required

(Required) A UUID string identifying this message template.

Update segment › Request Body

name

string

message_type

string

template

string

Update segment › Responses

200

Untitled Response

has_sequence

string

id

string

message_type

string

name

string

sequence

string

status

string

template

string

template_en

string

template_fr

string

template_sw

string

List sender IDs

GET

https://accounts.multitenant.slade360.co.ke

/api/notifications/sender_ids

Returns default sender ids for Orgs that don't have.

List sender IDs › query Parameters

available_from

string

available_to

string

branch_id

string

classification

string

SENDER_ID - A BulkSMS SenderID
INTERACTIVE_SHORTCODE - An interactive ShortCode

cluster_id

string

created

string

created_by

string

department_id

string

end_date

string

format

string

id

string

name

string

ordering

string

Which field to use when ordering the results.

organisation

string

page

string

A page number within the paginated result set.

page_size

string

Number of results to return per page.

search

string

A search term.

sender_type

string

PROMOTION - PROMOTION
TRANSACTION - TRANSACTION

start_date

string

updated

string

updated_by

string

workstation_id

string

List sender IDs › Responses

200

Untitled Response

count

string

object[]

next

string

previous

string

GET/api/notifications/sender_ids

curl https://accounts.multitenant.slade360.co.ke/api/notifications/sender_ids \
  --header 'Authorization: Bearer <token>'

Example Responses

{
  "count": "<integer>",
  "results": [
    {
      "created_by_name": "<string>",
      "disabled": {
        "est_59d": {}
      },
      "end_date": "<dateTime>",
      "id": "<uuid>",
      "name": "<string>",
      "sender_type": "TRANSACTION",
      "start_date": "<dateTime>",
      "updated_by_name": "<string>",
      "active": "<boolean>",
      "classification": "SENDER_ID",
      "available_from": "<time>",
      "available_to": "<time>"
    },
    {
      "created_by_name": "<string>",
      "disabled": {
        "suntb_8": {}
      },
      "end_date": "<dateTime>",
      "id": "<uuid>",
      "name": "<string>",
      "sender_type": "PROMOTION",
      "start_date": "<dateTime>",
      "updated_by_name": "<string>",
      "active": "<boolean>",
      "classification": "SENDER_ID",
      "available_from": "<time>",
      "available_to": "<time>"
    }
  ],
  "next": "<uri>",
  "previous": "<uri>"
}

json

application/json

Check-ins and Appointments Visits