This route will send a single communication to a customer

post

https://example.com/comms-api/{type}

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

type

string

enum

required

Each communication type has its own role that can be set in admin. 
To send 'email' you must have 'send:email' role

Allowed:

Body Params

FCCID

string

required

customers reference

templateID

object

required

_id of the template to use

contactID

string

required

_id of the communication item E.g FCCORE_email

variables

object

{ custom_variable: "value" } will replace {{ custom_variable }} in the template

attachments

array of strings

LUUID of FCCORE_attachment. Must belong to the FCCID

attachments

freeTypeHtml

string

free type text to add to email template

Responses

201

communication sent

400

Bad Request

403

user is missing the required roles to send this communication type

Language

Loading…

Response

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