Sign in
iMessage

Create a tracked iMessage opt-in link

Generates a per-campaign link that opens Messages on this sender with body prefilled. iMessage is send-first: a sender can only message a contact who has written to it (a send to anyone else fails with recipient_must_message_first), and the contact's tap-and-send is what opens that door.

Each link carries a unique code in place of the [opt-in-code] placeholder; when the contact sends it, the resulting message.received webhook (and the stored inbox message's metadata) has optIn: true and your parameters under optInParameters, so you can attribute the conversation to the campaign or lead that produced it.

For an untracked link, use the sender's optInLink instead.

post/v1/imessage/senders/{senderId}/opt-in-links

Path parameters

senderIdstring required

Request body

bodystring required

Prefilled message text. Must contain the literal [opt-in-code] placeholder, e.g. "Hi! My code is [opt-in-code]".

parametersobject

Custom key/values (e.g. leadId, campaign) echoed back on the opt-in message.

optInCodestring

Your own code in place of the generated one (3-8 characters, no spaces or #, !, -). An unredeemed link lives 24 hours; re-issuing with the same code replaces it, and the earlier URL stops matching.

Response

Opt-in link created

successboolean

Changes