API Reference

Send a message.

post
https://localhost/v4/messages

Send a message. A message can only be sent on behalf of a user if they have the necessary permissions to send
messages in: conversations assigned to them, conversations assigned to others, and unassigned conversations.

Required scope: write_messages.

Body Params

Create message body params

string
required

Text of the message.

channel
object
required

Channel to send the message to.

string

Name of the contact to send the message to. If a contact already exists for the channel then their name will be updated.

uuid
required

Podium unique identifier for location.

string

The name that will be credited with sending the message. This will appear under the sent message in the Podium app.

boolean
Defaults to false

new conversations will be created in a 'closed' state by default. This will override that setting going to 'open' inbox.

string

Subject of the message.

Responses

Callback

Updated 24 days ago

Language
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 24 days ago