CreateMessages

CreateMessages

Inputs (Array[]) inherits from EntityBase

Name

Type

Description

Mandatory

Available from version

Name

Type

Description

Mandatory

Available from version

Receiver

Guid

The user that the task is associated to.

Yes

New method in 2.24

Subject

string

The subject of the message.

 

 

Body

string

The body of the message.

 

 

EventDate

DateTime

A date associated with the message.

 

 

IsRead

bool

If the message is read by the customer.

 

 

IsPublic

bool

If the message is public.

 

 

IsPromoted

bool

If the message is promoted i.e. shown on the account overview when the user logs in.

 

 

IsHTML

bool

If the body of the message contains html this should be set to true.

 

 

Priority

string

Which priority the message should have. Allowed values are: "High", "Medium", "Low". Default are set to: "Medium".

 

 

Status

string

Which status the message should have. Allowed values are: "Created", "InProgress", "Done", "Closed". Default are set to "Created".

 

 

SendMail

bool

If mail should be sent to the receiver of the message

 

2.26

SendMailNotification

bool

If notification mail should be sent for this message

 

2.26

Response rows

Name

Type

Description

Available from version

Entities

Array

All messages in the request is returned along with each message BrickId and array of Errors per message

 

 

 

 

 

Code examples

public static void CreateActivityLogMessage() { var binding = new BasicHttpBinding(); binding.MaxReceivedMessageSize = Int32.MaxValue; var target = new bfsapi.bfsapiSoapClient(binding, new EndpointAddress("http://localhost:20010/bfsapi.asmx")); var req = new CreateMessagesRequest(); req.Credentials = new bfsapi.Credentials { UserName = GetApiUserName(), Password = GetApiPassword() }; req.identify = GetApiIdentifier(); req.Entities = new[] { new bfsapi.CreateMessage { Status = "Done", Subject = "TestSubject", IsHTML = true, Body = "Body", Receiver = Guid.NewGuid(), Priority = "Medium", CustomFields = new CustomField[] { new CustomField { FieldName = "TestField", Value = "TestValue" }, }, EventDate = DateTime.Today, IsPublic = true, IsPromoted = true, IsRead = false } }; var resp = target.CreateMessages(req); }