The Request Message object represents a message object in the scope of the request. It contains the following properties:
id
string
Primary identifier for the message.
Example: MSG-1212-3434-5656-7878
href
string
Relative reference to the object in the API.
Example: /v1/commerce/requests/REQ-1671-0642/messages/MSG-1212-3434-5656-7878
type
string
Type of message, such as User or System.
Example: User
content
string
Content of the message.
Example: I would like a discount of 5%.
request
Reference to the Request object.
Example:
{
"id": "E001234",
"message": "Agreement provisioning failed due to unavailability of the item"
}audit
AuditObject
Audit object with entries, including Created and Updated.
Example:
{
"created": { "at": "...", "by": { } },
"updated": { "at": "...", "by": { } }
}{
"id": "MSG-1212-3434-5656-7878",
"type": "User",
"content": "would agree discount of 5%"
}{
"id": "MSG-1212-3434-5656-7878",
"type": "User",
"content": "would agree discount of 5%",
"request": {
"id": "REQ-1671-0642"
},
"audit": {
"created": {
"at": "2023-12-14T17:28:57.667Z",
"by": {
"id": "USR-1234-1234-1234",
"name": "John Smith"
},
"of": {
"id": "ACC-1234-1234",
"name": "Microsoft",
"icon": "/static/ACC-1234-1234/account.png"
}
}
}
}Get a single request message.
OK
OK
OK
Not Found
GET /public/v1/commerce/requests/{requestId}/messages/{id} HTTP/1.1
Host: api.platform.softwareone.com
Accept: */*
GET /public/v1/commerce/requests/{requestId}/messages HTTP/1.1
Host: api.platform.softwareone.com
Accept: */*
{
"$meta": {
"pagination": {
"offset": 1,
"limit": 1,
"total": 1
},
"omitted": [
"text"
]
},
"data": [
{
"id": "text",
"audit": {
"created": {},
"updated": {}
},
"$meta": {
"omitted": [
"text"
]
},
"visibility": {
"client": true,
"operations": true,
"vendor": true
},
"account": {
"id": "text",
"icon": "text",
"type": "text",
"status": "text",
"name": "text"
},
"type": "text",
"content": "text",
"request": {
"id": "text",
"audit": {},
"$meta": {
"omitted": [
"text"
]
},
"externalId": "text",
"name": "text",
"status": "text",
"error": "text",
"from": {
"id": "text",
"icon": "text",
"type": "text",
"status": "text",
"name": "text"
},
"requester": {
"id": "text",
"icon": "text",
"name": "text"
},
"assignee": {
"id": "text",
"icon": "text",
"name": "text"
},
"to": {
"id": "text",
"icon": "text",
"type": "text",
"status": "text",
"name": "text"
},
"product": {
"id": "text",
"name": "text",
"externalIds": {
"operations": "text",
"defaultErpItem": "text"
},
"icon": "text",
"status": "text"
},
"parameters": [
"[Circular Reference]"
],
"messages": [
"[Circular Reference]"
]
}
}
]
}{
"id": "text",
"audit": {
"created": {
"at": "2025-12-14T08:21:33.917Z",
"by": {}
},
"updated": {
"at": "2025-12-14T08:21:33.917Z",
"by": {}
}
},
"$meta": {
"omitted": [
"text"
]
},
"visibility": {
"client": true,
"operations": true,
"vendor": true
},
"account": {
"id": "text",
"icon": "text",
"type": "text",
"status": "text",
"name": "text"
},
"type": "text",
"content": "text",
"request": {
"id": "text",
"audit": {
"created": {
"at": "2025-12-14T08:21:33.917Z",
"by": {}
},
"updated": {
"at": "2025-12-14T08:21:33.917Z",
"by": {}
}
},
"$meta": {
"omitted": [
"text"
]
},
"externalId": "text",
"name": "text",
"status": "text",
"error": "text",
"from": {
"id": "text",
"icon": "text",
"type": "text",
"status": "text",
"name": "text"
},
"requester": {
"id": "text",
"icon": "text",
"name": "text"
},
"assignee": {
"id": "text",
"icon": "text",
"name": "text"
},
"to": {
"id": "text",
"icon": "text",
"type": "text",
"status": "text",
"name": "text"
},
"product": {
"id": "text",
"name": "text",
"externalIds": {
"operations": "text",
"defaultErpItem": "text"
},
"icon": "text",
"status": "text"
},
"parameters": [
{
"id": "text",
"audit": {},
"externalId": "text",
"title": "text",
"description": "text",
"value": "text",
"displayOrder": 1,
"constraints": {
"isReadonly": true,
"isOptional": true
},
"typeOptions": null,
"errorMessage": "text",
"errorCode": "text",
"request": {}
}
],
"messages": [
{
"id": "text",
"audit": {
"created": {
"at": "2025-12-14T08:21:33.917Z",
"by": {}
},
"updated": {
"at": "2025-12-14T08:21:33.917Z",
"by": {}
}
},
"$meta": {
"omitted": [
"text"
]
},
"visibility": {
"client": true,
"operations": true,
"vendor": true
},
"account": {
"id": "text",
"icon": "text",
"type": "text",
"status": "text",
"name": "text"
},
"type": "text",
"content": "text",
"request": {}
}
]
}
}{
"id": "text",
"audit": {
"created": {
"at": "2025-12-14T08:21:33.917Z",
"by": {}
},
"updated": {
"at": "2025-12-14T08:21:33.917Z",
"by": {}
}
},
"$meta": {
"omitted": [
"text"
]
},
"visibility": {
"client": true,
"operations": true,
"vendor": true
},
"account": {
"id": "text",
"icon": "text",
"type": "text",
"status": "text",
"name": "text"
},
"type": "text",
"content": "text",
"request": {
"id": "text",
"audit": {
"created": {
"at": "2025-12-14T08:21:33.917Z",
"by": {}
},
"updated": {
"at": "2025-12-14T08:21:33.917Z",
"by": {}
}
},
"$meta": {
"omitted": [
"text"
]
},
"externalId": "text",
"name": "text",
"status": "text",
"error": "text",
"from": {
"id": "text",
"icon": "text",
"type": "text",
"status": "text",
"name": "text"
},
"requester": {
"id": "text",
"icon": "text",
"name": "text"
},
"assignee": {
"id": "text",
"icon": "text",
"name": "text"
},
"to": {
"id": "text",
"icon": "text",
"type": "text",
"status": "text",
"name": "text"
},
"product": {
"id": "text",
"name": "text",
"externalIds": {
"operations": "text",
"defaultErpItem": "text"
},
"icon": "text",
"status": "text"
},
"parameters": [
{
"id": "text",
"audit": {},
"externalId": "text",
"title": "text",
"description": "text",
"value": "text",
"displayOrder": 1,
"constraints": {
"isReadonly": true,
"isOptional": true
},
"typeOptions": null,
"errorMessage": "text",
"errorCode": "text",
"request": {}
}
],
"messages": [
{
"id": "text",
"audit": {
"created": {
"at": "2025-12-14T08:21:33.917Z",
"by": {}
},
"updated": {
"at": "2025-12-14T08:21:33.917Z",
"by": {}
}
},
"$meta": {
"omitted": [
"text"
]
},
"visibility": {
"client": true,
"operations": true,
"vendor": true
},
"account": {
"id": "text",
"icon": "text",
"type": "text",
"status": "text",
"name": "text"
},
"type": "text",
"content": "text",
"request": {}
}
]
}
}POST /public/v1/commerce/requests/{requestId}/messages HTTP/1.1
Host: api.platform.softwareone.com
Content-Type: application/json
Accept: */*
Content-Length: 79
{
"visibility": {
"client": true,
"operations": true,
"vendor": true
},
"content": "text"
}