Send Communication

post

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

Send comms with content defined by liquid template

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

company_id

int32

required

Body Params

entity

string

enum

Allowed:

int32

subject[subject_type]

string

enum

required

Defaults to plaintext

Allowed:

subject[value]

string

required

body[body_type]

string

enum

required

Defaults to plaintext

Allowed:

body[value]

string

required

message_type

string

enum

required

Allowed:

sender

string

Defaults to the configured email address in settings if available else to JRNI [email protected]

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

Loading…

Response

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