Skip to main content
POST
cURL

Authorizations

Authorization
string
header
required

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

Body

application/json
contact_id
string
required

Contact ID.

Required string length: 10 - 50
Pattern: ^[0-9]+@[cs]\.us$
Example:

"xxx@c.us"

latitude
string
required

Latitude of the location..

Pattern: ^-?([0-8]?[0-9]|90)(\.[0-9]{1,10})?$
Example:

"38.8937255"

longitude
string
required

Longitude of the location.

Pattern: ^-?(1[0-7][0-9]|[0-9]?[0-9]|180)(\.[0-9]{1,10})?$
Example:

"-77.0969763"

title
string
required

Title of the location.

Required string length: 1 - 100
Example:

"Our office"

reply_to
string

Message ID to reply to (optional)

Required string length: 1 - 100
Pattern: ^[A-Za-z0-9_-]+$
Example:

"message_id_here"

Response

LocationMessageResource

success
boolean
required

The success status of response.

message
string
required

The message of response.

data
object
required