Create message for campaign
POST {{baseUrl}}/v4/campaigns/{uid}/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.
Request Body
{"body"=>"Just a reminder that your appointment is today!", "channel"=>{"identifier"=>"email@email.com", "type"=>"email"}, "locationUid"=>"00000000-0000-0000-0000-000000000000", "contactName"=>"Joe Orange", "senderName"=>"Bot1234", "subject"=>"Appointment reminder"}
HEADERS
Key | Datatype | Required | Description |
---|---|---|---|
Content-Type | string | ||
Accept | string |
RESPONSES
status: OK
{"data":{"attachmentUrl":"https://www.podium.com/","body":"Hello there.","contact":{"externalIdentifier":"123-abc","name":"Joe Orange","uid":"00000000-0000-0000-0000-000000000000"},"contactName":"Joe Orange","conversation":{"assignedUserUid":"00000000-0000-0000-0000-000000000000","channel":{"identifier":"email@email.com","type":"email"},"startedAt":"2015-01-23T23:50:07Z","uid":"00000000-0000-0000-0000-000000000000"},"createdAt":"2015-01-23T23:50:07Z","failureReason":"Attempted to send SMS to a landline.","location":{"organizationUid":"00000000-0000-0000-0000-000000000000","uid":"00000000-0000-0000-0000-000000000000"},"sender":{"uid":"00000000-0000-0000-0000-000000000000"},"senderUid":"00000000-0000-0000-0000-000000000000","uid":"00000000-0000-0000-0000-000000000000"},"metadata":{"url":"https://www.podium.com/"}}