Send Communication

post https://{api_url}/api/v5/admin/{company_id}/communications

Send comms with content defined by liquid template

Path Params

company_id

int32

required

Body Params

entity

string

int32

subject[subject_type]

string

required

Defaults to plaintext

subject[value]

string

required

body[body_type]

string

required

Defaults to plaintext

body[value]

string

required

message_type

string

required

sender

string

Defaults to JRNI <service@jrni.com>

recipient

string

The intended recepient, can be an email address or an sms capable mobile number

slot_id

int32

Sends an email to all attendees of the slot

member_id

int32

Logs email/sms in client interactions for this member id if recipient present

total_id

int32

Logs email/sms in booking and client interactions for this total id if recipient present

push_type

string

public_push

boolean

Responses

201

Created

403

Forbidden

404

Not Found

Language

Credentials

URL


xxxxxxxxxx
12
1
curl --request POST \
2
     --url https://example.jrni.com/api/v5/admin/company_id/communications \
3
     --header 'accept: application/json' \
4
     --header 'content-type: application/json' \
5
     --data '
6
{
7
  "subject[subject_type]": "plaintext",
8
  "body[body_type]": "plaintext",
9
  "message_type": "email",
10
  "sender": "JRNI <service@jrni.com>"
11
}
12
'

Click Try It! to start a request and see the response here!