Skip to main content
GET
Recommend the best messaging channel for a contact

Authorizations

Authorization
string
header
required

Dashboard JWT token from Clerk

Path Parameters

id
string
required

Query Parameters

messageType
enum<string>

Kind of message being sent; biases the ranking. Defaults to transactional.

Available options:
transactional,
marketing,
otp
urgency
enum<string>

Delivery urgency; high urgency favours fast channels. Defaults to medium.

Available options:
low,
medium,
high
costOptimize
string

Pass "true" or "1" to prefer the cheapest channel that still meets the quality bar.

Response

200 - application/json

The ranked channel recommendation for the contact.

data
object
meta
object