Sign in
iMessage

Send Message

post/api/v1/imessage/messages

Query parameters

agent_identity_idstring uuid nullable

Agent identity to send as. Required for org-wide callers when sending by to; ignored for agent-scoped keys.

Agent identity to send as. Required for org-wide callers when sending by to; ignored for agent-scoped keys.

Headers

Idempotency-Keystring nullable

Request body

conversation_idstring uuid nullable

Existing conversation to reply into. Mutually exclusive with to.

textstring nullable
media_urlsstring[] nullable
send_style'celebration' | 'shooting_star' | 'fireworks' | 'lasers' | 'love' | 'confetti' | 'balloons' | 'spotlight' | 'echo' | 'invisible' | 'gentle' | 'loud' | 'slam'

Example request

{
  "to": "+15551234567"
}

Response

Successful Response

OR
OR

Changes

No recorded changes to this endpoint across all 1 revision of this API.