GET messageconfigs/{messageConfigId}

Gets a message config.

Request Information

» Parameters

Name Description Additional information
messageConfigId The ID of the message config.

Define this parameter in the request URI.

» Expands

Name Description Usage
messageType This will retrieve the related message type. GET messageconfigs/{messageConfigId}?expand=messagetype
portal This will retrieve the related list of portals. GET messageconfigs/{messageConfigId}?expand=portal

Response Information

» Response Body Formats

If this endpoint supports expands, they will be included in the sample response body below. However, please note that expands are NOT included in the response body by default. Expands are only included in the response body if they came through as part of the request.

  "MessageConfig": {
    "Description": "",
    "Key": "CurrentStoreSpecial",
    "LocaleId": 43,
    "MessageConfigId": 1,
    "MessageType": {
      "DisplayOrder": 1,
      "IsActive": true,
      "MessageTypeId": 1,
      "Name": "Message Block"
    "MessageTypeId": 1,
    "PageSeoName": "",
    "PortalId": 1,
    "Value": "Current Store Special",
    "PortalName": null,
    "CustomErrorMessage": null
  "ErrorCode": null,
  "ErrorMessage": null,
  "HasError": false