Add Message


Description

This method add a messages in the system.

Authentication

Requires HTTP BASIC authentication.The authenticating user must be associated with the from creditor.

HTTP Methods

Accepts POST requests.

URI

/api/debtors/{uuid}/messages.json

Path Variables

Name Required/Optional Description Validation
uuid required The UUID of the debtor Debtor UUID should exist in the system.

HTTP Parameters

Name Required/Optional Description Validation
fromCreditor required The UUID of the Creditor Creditor UUID should exist in the system.
toCreditor required The UUID of the Creditor Creditor UUID should exist in the system.
subject required The subject of the message
message required The description of the message

Curl Example

Request

curl -u apiuser:test -X POST "https://www.factorsnetwork.com/api/debtors/ebb16383-2109-4f98-ba74-40e91eb39876/messages.json?fromCreditor=ff5ac510-4dd8-4f0e-863a-2bda1f96f82f&toCreditor=24b3602c-dacc-4022-9ade-ecf99f749519&subject=test&message=test"

Response

{
  "messages" : [ {
    "uuid" : "cb44d0f5-5459-4315-8a34-1234ba4f28ff",
    "debtorUuid" : "ebb65478-3e02-4d54-ba74-40e91eb40059",
    "toCreditorUuid" : "24b3602c-dacc-4022-9ade-ecf99f749519",
    "fromCreditorUuid" : "ff5ac510-7780-12a8-863a-2bda1f96f82f",
    "subject" : "test",
    "message" : "test",
    "creationDate" : "Mon Dec 31 16:22:39 IST 2012"
  } ]
}

Note: Responses will not be pretty printed when using the API, but have been formatted here for documentation purposes.