Messages
An In-app Message between a Requestor and a Wonoloer

Wonolo’s In-app Messages allow a Requestor and a Wonoloer to communicate about a Job.

Supported Formats

json
>>>

Returns a list of Messages, optionally paginated. Note: the maximum number returned per page in any case is 50.

Supported Formats

json

Errors

Code Description
401 Unauthorized

Examples

curl -v -d "token=HdgXqxYWd5tTdyabzfzo" http://api.wonolo.com/api_v2/messages
curl -v -d "token=HdgXqxYWd5tTdyabzfzo" http://api.wonolo.com/api_v2/messages?page=10&per=25

Params

Param name Description
token
required

Token obtained from /authorize

Validations:

  • Must be a String
page
optional

The page number to start from

Validations:

  • Must be a Integer
per
optional

The size of the page

Validations:

  • Must be a Integer
job_id
optional

Filter Messages by Job

Validations:

  • Must be a Integer
sender_id
optional

Filter Messages by Sender (User ID)

Validations:

  • Must be a Integer
receiver_id
optional

Filter Messages by Receiver (User ID)

Validations:

  • Must be a Integer
>>>

POST /api_v2/messages
Create a Message

Supported Formats

json

Errors

Code Description
401 Unauthorized

Params

Param name Description
token
required

Token obtained from /authorize

Validations:

  • Must be a String
message
required

An In-app Message

Validations:

  • Must be a Hash
message[sender_id]
required

User ID of sender of this Message. Can be a Wonoloer or a Requestor

Validations:

  • Must be a Integer
message[receiver_id]
required

User ID of recipient of this Message. Can be a Wonoloer or a Requestor

Validations:

  • Must be a Integer
message[job_id]
required

ID of the Job to which this Message relates

Validations:

  • Must be a Integer
message[body]
required

The text content of this Message

Validations:

  • Must be a String
message[image_url]
optional

The URL of an image to accompany this Message

Validations:

  • Must be a String
message[read_at]
optional

If read, when this message was read

Validations:

  • Must be a DateTime
>>>

GET /api_v2/messages/:id
Get a specific Message

Supported Formats

json

Errors

Code Description
401 Unauthorized

Params

Param name Description
token
required

Token obtained from /authorize

Validations:

  • Must be a String
id
required

ID of Message

Validations:

  • Must be a Integer