Basic Messages

Endpoints for sending and retrieving basic messages

Get all messages

get

This endpoint retrieves all messages.

Authorizations

Responses

200

A list of messages

application/json

401

Unauthorized.

500

Internal Server Error

application/json

get

HTTPcURLJavaScriptPython

GET /api/v1/messages HTTP/1.1
Host: 
x-api-key: YOUR_API_KEY
Accept: */*

[]

Send a basic message

post

This endpoint allows you to send a basic message.

Authorizations

Body

invitation_idintegerOptional

The ID of the invitation.

Example: 1

contact_idstringOptional

The ID of the contact.

messagestringOptional

The message content.

Example: your message here

Responses

200

Message sent successfully

application/json

400

Bad request. Invalid parameters.

application/json

401

Unauthorized.

500

Internal Server Error

application/json

post

HTTPcURLJavaScriptPython

POST /api/v1/messages HTTP/1.1
Host: 
x-api-key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 65

{
  "invitation_id": 1,
  "contact_id": "",
  "message": "your message here"
}

{
  "success": "Messages was sent!"
}

Get a message by ID

get

This endpoint retrieves a message by its ID.

Authorizations

Path parameters

idstringRequired

The ID of the message to retrieve.

Responses

200

A message object

application/json

401

Unauthorized.

404

Message not found

application/json

500

Internal Server Error

application/json

get

HTTPcURLJavaScriptPython

GET /api/v1/messages/{id} HTTP/1.1
Host: 
x-api-key: YOUR_API_KEY
Accept: */*

{
  "invitation_id": 3,
  "contact_id": "2",
  "message": "your message here"
}