Create Request Message

Creates a new request message.

post
Path parameters
requestIdstringRequired

Request Id

Body
visibilityall ofRequired
contentstring · min: 1Required
Responses
201
Created
application/json
post
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"
}
{
  "id": "text",
  "audit": {
    "created": {
      "at": "2025-06-27T14:06:55.350Z",
      "by": "[Circular Reference]"
    },
    "updated": {
      "at": "2025-06-27T14:06:55.350Z",
      "by": "[Circular Reference]"
    }
  },
  "$meta": {
    "omitted": [
      "text"
    ]
  },
  "visibility": {
    "client": true,
    "operations": true,
    "vendor": true
  },
  "account": {
    "id": "text",
    "icon": "text",
    "type": "Client",
    "status": "Active",
    "name": "text"
  },
  "type": "text",
  "content": "text",
  "request": {
    "id": "text",
    "audit": {
      "created": {
        "at": "2025-06-27T14:06:55.350Z",
        "by": "[Circular Reference]"
      },
      "updated": {
        "at": "2025-06-27T14:06:55.350Z",
        "by": "[Circular Reference]"
      }
    },
    "$meta": {
      "omitted": [
        "text"
      ]
    },
    "externalId": "text",
    "name": "text",
    "status": "text",
    "error": "text",
    "from": {
      "id": "text",
      "icon": "text",
      "type": "Client",
      "status": "Active",
      "name": "text"
    },
    "requester": {
      "id": "text",
      "icon": "text",
      "name": "text"
    },
    "assignee": {
      "id": "text",
      "icon": "text",
      "name": "text"
    },
    "to": {
      "id": "text",
      "icon": "text",
      "type": "Client",
      "status": "Active",
      "name": "text"
    },
    "product": {
      "id": "text",
      "name": "text",
      "externalIds": {
        "operations": "text"
      },
      "icon": "text",
      "status": "text"
    },
    "parameters": [
      {
        "id": "text",
        "audit": {
          "0": "[",
          "1": "C",
          "2": "i",
          "3": "r",
          "4": "c",
          "5": "u",
          "6": "l",
          "7": "a",
          "8": "r",
          "9": " ",
          "10": "R",
          "11": "e",
          "12": "f",
          "13": "e",
          "14": "r",
          "15": "e",
          "16": "n",
          "17": "c",
          "18": "e",
          "19": "]"
        },
        "externalId": "text",
        "title": "text",
        "description": "text",
        "value": "text",
        "displayOrder": 1,
        "constraints": {
          "isReadonly": true,
          "isOptional": true
        },
        "typeOptions": null,
        "errorMessage": "text",
        "errorCode": "text",
        "request": {
          "0": "[",
          "1": "C",
          "2": "i",
          "3": "r",
          "4": "c",
          "5": "u",
          "6": "l",
          "7": "a",
          "8": "r",
          "9": " ",
          "10": "R",
          "11": "e",
          "12": "f",
          "13": "e",
          "14": "r",
          "15": "e",
          "16": "n",
          "17": "c",
          "18": "e",
          "19": "]"
        }
      }
    ],
    "messages": [
      {
        "id": "text",
        "audit": {
          "created": {
            "at": "2025-06-27T14:06:55.350Z",
            "by": "[Circular Reference]"
          },
          "updated": {
            "at": "2025-06-27T14:06:55.350Z",
            "by": "[Circular Reference]"
          }
        },
        "$meta": {
          "omitted": [
            "text"
          ]
        },
        "visibility": {
          "client": true,
          "operations": true,
          "vendor": true
        },
        "account": {
          "id": "text",
          "icon": "text",
          "type": "Client",
          "status": "Active",
          "name": "text"
        },
        "type": "text",
        "content": "text",
        "request": {
          "0": "[",
          "1": "C",
          "2": "i",
          "3": "r",
          "4": "c",
          "5": "u",
          "6": "l",
          "7": "a",
          "8": "r",
          "9": " ",
          "10": "R",
          "11": "e",
          "12": "f",
          "13": "e",
          "14": "r",
          "15": "e",
          "16": "n",
          "17": "c",
          "18": "e",
          "19": "]"
        }
      }
    ]
  }
}

Last updated

Was this helpful?