Skip to main content
POST
audience.optin.get

Authorizations

Authorization
string
header
required

A Lath API key: lath_live_sk… or lath_test_sk… on a server, lath_live_pk… or lath_test_pk… in a browser.

Body

application/json
channel
enum<string>
required
Available options:
email,
sms
address
string
required

An email address, or a phone number in E.164

Required string length: 3 - 320

Response

{ activityId, result }. activityId is empty for reads.

activityId
string
required

The activity this call created, or empty for a read.

result
object
required
Last modified on September 13, 2026