POST collaboration/service-desk-requests/{serviceDeskRequestId}/messages

Sends a message in a service desk request.

Note: Log in to check if your API client have access to run this resource
Version: 4
Success HTTP Status Code: 201

Uri parameters

{serviceDeskRequestId} Integer Service desk request identifier

The following body must be added to the request. Mouse over fieldnames for description and other useful information about the fields. Note that fields in bold is required/mandatory.

Format:
1
<ServiceDeskRequestMessage>
2
     <OccuredAt
OccuredAt

Date and time the relationship activity occured

This field is optional.

>
{Datetime}</OccuredAt>
3
     <Subject
Subject

A short subject of the service desk request message

This field is optional.

>
{String}</Subject>
4
     <Message
Message

Message/comment/text of the service desk request message

This field is optional.

>
{String}</Message>
5
     <Direction
Direction

Indicates whether the relationship activity is inbound (INBOUND) or outbound (OUTBOUND).

This field is optional.

>
{String}</Direction>
6
     <Owner
Owner

All activities are assigned an owner who is responsible for completing/follow up the activity

This field is optional.

>
7
          <EmployeeId
EmployeeId

Employee identifier

This field is optional.

>
{Integer}</EmployeeId>
8
     </Owner>
9
     <Sender>
10
          <Description
Description

Name of the sender

This field is optional.

>
{String}</Description>
11
          <ObjectReference
ObjectReference

Required/mandatory field

Reference to the contact/customer/supplier/employee who sent the message

>
12
               <ObjectId
ObjectId

Required/mandatory field

Identifier of the object

>
{Integer}</ObjectId>
13
               <ObjectType
ObjectType

Required/mandatory field

Type of object

>
{String}</ObjectType>
14
          </ObjectReference>
15
     </Sender>
16
</ServiceDeskRequestMessage>
1
{
2
     "serviceDeskRequestMessage": {
3
          "occuredAt
OccuredAt

Date and time the relationship activity occured

This field is optional.

":
"{Datetime}",
4
          "subject
Subject

A short subject of the service desk request message

This field is optional.

":
"{String}",
5
          "message
Message

Message/comment/text of the service desk request message

This field is optional.

":
"{String}",
6
          "direction
Direction

Indicates whether the relationship activity is inbound (INBOUND) or outbound (OUTBOUND).

This field is optional.

":
"{String}",
7
          "owner
Owner

All activities are assigned an owner who is responsible for completing/follow up the activity

This field is optional.

":
{
8
               "employeeId
EmployeeId

Employee identifier

This field is optional.

":
"{Integer}"
9
          },
10
          "sender": {
11
               "description
Description

Name of the sender

This field is optional.

":
"{String}",
12
               "objectReference
ObjectReference

Required/mandatory field

Reference to the contact/customer/supplier/employee who sent the message

":
{
13
                    "objectId
ObjectId

Required/mandatory field

Identifier of the object

":
"{Integer}",
14
                    "objectType
ObjectType

Required/mandatory field

Type of object

":
"{String}"
15
               }
16
          }
17
     }
18
}

The query string is placed after the resource URL, seperated with a questionmark (?). The query string is composed of a series of query parameters with values. See the page about query parameters on how to use these parameters.

$db String, optional Set the database to use for the request
$format String, optional Set the format of the response to use for the request. Accepted values are "xml", "json"
$lang String, optional Use to get localized responses. Supported formats are 3-letter ISO-639-1 [lll], 2-letter ISO-639-2 [ll], or a combination of a two-letter language code and a two-letter country code ISO-639-2 and ISO-3166-1 [ll_CC], [ll-CC]
$useMinimumVersion Integer, optional This can be used to test a new version of a resource when your ApiClient is running an older, deprecated, version of a resource. $useminimumversion can be used to test against a newer version of the resource. See the Deprecated APIs page for more information about this.

See the page about filters and sorting on how to use filter parameters and named filters.

See the page about filters and sorting on how to use sortable parameters

Requesting this resource will yield the following response. Mouse over fieldnames (or fieldgroups) for descriptions and other useful information about the fields.

Please note that some fields may be removed from the response, based on user roles/duties/permissions.

Format:
1
1

List of available operations/actions for this resource.
See the operations documentation for more information about API operations.

Possible error codes the response might return:

Error 100107 HTTP 404 Service desk request not found
Error 100051 HTTP 400 When logged in as supplier {0} you do not have access to this API resource
Error 100055 HTTP 403 You have only admittance to your own objects
Error 100050 HTTP 403 No admittance as customer {0}
Error 100053 HTTP 403 You have only admittance to your own suppliers
Error 101033 HTTP 400 Description of sender is required
Error 101028 HTTP 400 Direction is required
Error 100114 HTTP 400 Request of HLD is required
Error 100018 HTTP 404 Document {0} not found
Error 100115 HTTP 404 ACTION not found in revision history
Error 100126 HTTP 400 The application field is not correctly filled for this type of service desk request
Error 101023 HTTP 400 Regarding is required
Error 101019 HTTP 400 Subject is required
Error 101031 HTTP 404 Service Desk Request message not found
Error 100036 HTTP 400 Missing required input parameter: {0}
Error 100380 HTTP 404 Releationship activity not found
Error 100054 HTTP 404 Document identifier not found
Error 101018 HTTP 400 Occured-at is required
Error 100382 HTTP 400 A relationship activity can only be regarding a customer or a supplier
Error 101020 HTTP 400 Owner not found
Error 101021 HTTP 400 Sender not found
Error 101022 HTTP 400 Customer/supplier this email is regarding was not found
Error 100209 HTTP 400 Illegal document Id {0}
Error 101086 HTTP 400 Missing required argument {0} for description
Error 101087 HTTP 400 Description argument/result mismatch
Error 100027 HTTP 400 Missing mandatory parameter {0}
Error 102529 HTTP 404 RamBase event type not found
Error 100009 HTTP 400 Missing required input arguments
Error 100012 HTTP 400 {0} must exist in {1}
Error 101079 HTTP 400 Mismatch in size of revision parameters
Error 101420 HTTP 404 Setting definition not found
Error 100048 HTTP 400 Parameter {0}: {1} not valid
Error 101015 HTTP 404 Permission not found
Error 101514 HTTP 400 Setting definition reference is required
Error 101708 HTTP 400 Default value is required
Error 101640 HTTP 400 Data type is required