Send a message | Surge | Documentation

1 curl -X POST https://api.surge.app/accounts/acct_01j9a43avnfqzbjfch6pygv1td/messages \ 2 -H "Authorization: Bearer <token>" \ 3 -H "Content-Type: application/json" \ 4 -d '{ 5 "conversation": { 6 "contact": { 7 "first_name": "Dominic", 8 "last_name": "Toretto", 9 "phone_number": "+18015551234" 10 } 11 }, 12 "attachments": [ 13 { 14 "url": "https://toretto.family/coronas.gif" 15 } 16 ], 17 "body": "Thought you could leave without saying goodbye?" 18 }'

1 { 2 "attachments": [ 3 { 4 "id": "att_01j9e0m1m6fc38gsv2vkfqgzz2", 5 "type": "image", 6 "url": "https://api.surge.app/attachments/att_01jbwyqj7rejzat7pq03r7fgmf" 7 } 8 ], 9 "body": "Thought you could leave without saying goodbye?", 10 "conversation": { 11 "contact": { 12 "id": "ctc_01j9dy8mdzfn3r0e8x1tbdrdrf", 13 "phone_number": "+18015551234", 14 "first_name": "Dominic", 15 "last_name": "Toretto" 16 }, 17 "id": "cnv_01j9e0dgmdfkj86c877ws0znae", 18 "phone_number": { 19 "id": "pn_01jsjwe4d9fx3tpymgtg958d9w", 20 "number": "+18015552345", 21 "type": "local" 22 } 23 }, 24 "id": "msg_01j9e0m1m6fc38gsv2vkfqgzz2" 25 }

Sends a Message.

Path parameters

account_idstringRequired

The account for which the message should be sent.

Headers

AuthorizationstringRequired

Bearer authentication of the form Bearer <token>, where token is your auth token.

Request

This endpoint expects an object.

conversationobjectRequired

Params for selecting or creating a new conversation. Either the id or the Contact must be given.

attachmentslist of objectsOptional

bodystringOptional

The message body.

send_atdatetimeOptional

An optional datetime for scheduling message up to a couple of months in the future.

Response

When the message is enqueued successfully, this will be returned.

attachmentslist of objectsOptional

bodystringOptional

The message body.

conversationobjectOptional

A conversation with a Contact

idstringOptional

Unique identifier for the object.