Get Message

get

Path parameters

idstringRequired

Query parameters

selectstringOptional

Responses

200

application/json

idstringOptional

discardReasonstring · nullableOptionalDeprecated

statusstringOptional

statusReasonstring · nullableOptional

subjectstringOptional

bodystring · nullableOptional

400

Bad Request

application/json

404

Not Found

application/json

get

/public/v1/notifications/messages/{id}

GET /public/v1/notifications/messages/{id} HTTP/1.1
Host: api.platform.softwareone.com
Accept: */*

{
  "id": "text",
  "audit": {
    "created": {
      "at": "2026-02-20T00:37:31.689Z",
      "by": {}
    },
    "updated": {
      "at": "2026-02-20T00:37:31.689Z",
      "by": {}
    },
    "queued": {
      "at": "2026-02-20T00:37:31.689Z",
      "by": {}
    },
    "discarded": {
      "at": "2026-02-20T00:37:31.689Z",
      "by": {}
    },
    "sent": {
      "at": "2026-02-20T00:37:31.689Z",
      "by": {}
    },
    "bounced": {
      "at": "2026-02-20T00:37:31.689Z",
      "by": {}
    },
    "complained": {
      "at": "2026-02-20T00:37:31.689Z",
      "by": {}
    },
    "failed": {
      "at": "2026-02-20T00:37:31.689Z",
      "by": {}
    }
  },
  "$meta": {
    "omitted": [
      "text"
    ]
  },
  "batch": {
    "id": "text",
    "audit": {
      "created": {},
      "updated": {}
    },
    "$meta": {
      "omitted": [
        "text"
      ]
    },
    "category": {
      "id": "text",
      "audit": {},
      "$meta": {
        "omitted": [
          "text"
        ]
      },
      "description": "text",
      "optOutAllowed": true,
      "status": "text",
      "name": "text",
      "note": "text",
      "deleteAllowed": true,
      "icon": "text",
      "statistics": {
        "month": {
          "bounced": 1,
          "complained": 1,
          "discarded": 1,
          "failed": 1,
          "sent": 1,
          "total": 1
        },
        "today": {
          "bounced": 1,
          "complained": 1,
          "discarded": 1,
          "failed": 1,
          "sent": 1,
          "total": 1
        },
        "week": {
          "bounced": 1,
          "complained": 1,
          "discarded": 1,
          "failed": 1,
          "sent": 1,
          "total": 1
        }
      },
      "lastUsed": "2026-02-20T00:37:31.689Z"
    },
    "account": {
      "id": "text",
      "audit": {},
      "$meta": {
        "omitted": [
          "text"
        ]
      },
      "icon": "text",
      "externalIds": {
        "pyraTenantId": "123e4567-e89b-12d3-a456-426614174000"
      },
      "externalId": "text",
      "externalName": "text",
      "type": "text",
      "status": "text",
      "serviceLevel": "text",
      "address": {
        "addressLine1": "text",
        "addressLine2": "text",
        "postCode": "text",
        "city": "text",
        "state": "text",
        "country": "text"
      },
      "technicalSupportEmail": "[email protected]",
      "website": "text",
      "description": "text",
      "name": "text",
      "groups": [
        {
          "id": "text",
          "name": "text",
          "description": "text",
          "logo": "text",
          "isDefault": true
        }
      ],
      "eligibility": {
        "client": true,
        "partner": true
      }
    },
    "subject": "text",
    "body": "text",
    "attachments": [
      {
        "id": "text",
        "audit": {},
        "$meta": {
          "omitted": [
            "text"
          ]
        },
        "name": "text",
        "type": "text",
        "description": "text",
        "filename": "text",
        "size": 1,
        "contentType": "text",
        "request": {}
      }
    ]
  },
  "contact": {
    "id": "text",
    "audit": {
      "created": {},
      "updated": {},
      "activated": {},
      "blocked": {},
      "deleted": {}
    },
    "$meta": {
      "omitted": [
        "text"
      ]
    },
    "blockedReason": "text",
    "email": "text",
    "name": "text",
    "optOuts": [
      {
        "id": "text",
        "description": "text",
        "name": "text",
        "icon": "text",
        "lastUsed": "2026-02-20T00:37:31.689Z"
      }
    ],
    "status": "text",
    "userId": "text",
    "user": {
      "id": "text",
      "audit": {},
      "$meta": {
        "omitted": [
          "text"
        ]
      },
      "email": "text",
      "status": "text",
      "phone": {
        "prefix": "text",
        "number": "text"
      },
      "firstName": "text",
      "lastName": "text",
      "icon": "text",
      "lastLoginAt": "2026-02-20T00:37:31.689Z",
      "settings": {
        "cultureCode": "text",
        "languageCode": "text"
      },
      "name": "text",
      "accounts": [
        {
          "id": "text",
          "icon": "text",
          "type": "text",
          "status": "text",
          "name": "text"
        }
      ],
      "currentAccount": {
        "id": "text",
        "icon": "text",
        "type": "text",
        "status": "text",
        "name": "text"
      }
    }
  },
  "category": {
    "id": "text",
    "audit": {},
    "$meta": {
      "omitted": [
        "text"
      ]
    },
    "description": "text",
    "optOutAllowed": true,
    "status": "text",
    "name": "text",
    "note": "text",
    "deleteAllowed": true,
    "icon": "text",
    "statistics": {
      "month": {
        "bounced": 1,
        "complained": 1,
        "discarded": 1,
        "failed": 1,
        "sent": 1,
        "total": 1
      },
      "today": {
        "bounced": 1,
        "complained": 1,
        "discarded": 1,
        "failed": 1,
        "sent": 1,
        "total": 1
      },
      "week": {
        "bounced": 1,
        "complained": 1,
        "discarded": 1,
        "failed": 1,
        "sent": 1,
        "total": 1
      }
    },
    "lastUsed": "2026-02-20T00:37:31.689Z"
  },
  "account": {
    "id": "text",
    "audit": {},
    "$meta": {
      "omitted": [
        "text"
      ]
    },
    "icon": "text",
    "externalIds": {
      "pyraTenantId": "123e4567-e89b-12d3-a456-426614174000"
    },
    "externalId": "text",
    "externalName": "text",
    "type": "text",
    "status": "text",
    "serviceLevel": "text",
    "address": {
      "addressLine1": "text",
      "addressLine2": "text",
      "postCode": "text",
      "city": "text",
      "state": "text",
      "country": "text"
    },
    "technicalSupportEmail": "[email protected]",
    "website": "text",
    "description": "text",
    "name": "text",
    "groups": [
      {
        "id": "text",
        "name": "text",
        "description": "text",
        "logo": "text",
        "isDefault": true
      }
    ],
    "eligibility": {
      "client": true,
      "partner": true
    }
  },
  "status": "text",
  "statusReason": "text",
  "subject": "text",
  "body": "text",
  "attachments": [
    {
      "id": "text",
      "audit": {},
      "$meta": {
        "omitted": [
          "text"
        ]
      },
      "name": "text",
      "type": "text",
      "description": "text",
      "filename": "text",
      "size": 1,
      "contentType": "text",
      "request": {}
    }
  ]
}

PreviousList Messages NextSubscriber

Last updated 9 months ago

Was this helpful?

{ "id": "text", "audit": { "created": { "at": "2026-02-20T00:37:31.689Z", "by": {} }, "updated": { "at": "2026-02-20T00:37:31.689Z", "by": {} }, "queued": { "at": "2026-02-20T00:37:31.689Z", "by": {} }, "discarded": { "at": "2026-02-20T00:37:31.689Z", "by": {} }, "sent": { "at": "2026-02-20T00:37:31.689Z", "by": {} }, "bounced": { "at": "2026-02-20T00:37:31.689Z", "by": {} }, "complained": { "at": "2026-02-20T00:37:31.689Z", "by": {} }, "failed": { "at": "2026-02-20T00:37:31.689Z", "by": {} } }, "$meta": { "omitted": [ "text" ] }, "batch": { "id": "text", "audit": { "created": {}, "updated": {} }, "$meta": { "omitted": [ "text" ] }, "category": { "id": "text", "audit": {}, "$meta": { "omitted": [ "text" ] }, "description": "text", "optOutAllowed": true, "status": "text", "name": "text", "note": "text", "deleteAllowed": true, "icon": "text", "statistics": { "month": { "bounced": 1, "complained": 1, "discarded": 1, "failed": 1, "sent": 1, "total": 1 }, "today": { "bounced": 1, "complained": 1, "discarded": 1, "failed": 1, "sent": 1, "total": 1 }, "week": { "bounced": 1, "complained": 1, "discarded": 1, "failed": 1, "sent": 1, "total": 1 } }, "lastUsed": "2026-02-20T00:37:31.689Z" }, "account": { "id": "text", "audit": {}, "$meta": { "omitted": [ "text" ] }, "icon": "text", "externalIds": { "pyraTenantId": "123e4567-e89b-12d3-a456-426614174000" }, "externalId": "text", "externalName": "text", "type": "text", "status": "text", "serviceLevel": "text", "address": { "addressLine1": "text", "addressLine2": "text", "postCode": "text", "city": "text", "state": "text", "country": "text" }, "technicalSupportEmail": "[email protected]", "website": "text", "description": "text", "name": "text", "groups": [ { "id": "text", "name": "text", "description": "text", "logo": "text", "isDefault": true } ], "eligibility": { "client": true, "partner": true } }, "subject": "text", "body": "text", "attachments": [ { "id": "text", "audit": {}, "$meta": { "omitted": [ "text" ] }, "name": "text", "type": "text", "description": "text", "filename": "text", "size": 1, "contentType": "text", "request": {} } ] }, "contact": { "id": "text", "audit": { "created": {}, "updated": {}, "activated": {}, "blocked": {}, "deleted": {} }, "$meta": { "omitted": [ "text" ] }, "blockedReason": "text", "email": "text", "name": "text", "optOuts": [ { "id": "text", "description": "text", "name": "text", "icon": "text", "lastUsed": "2026-02-20T00:37:31.689Z" } ], "status": "text", "userId": "text", "user": { "id": "text", "audit": {}, "$meta": { "omitted": [ "text" ] }, "email": "text", "status": "text", "phone": { "prefix": "text", "number": "text" }, "firstName": "text", "lastName": "text", "icon": "text", "lastLoginAt": "2026-02-20T00:37:31.689Z", "settings": { "cultureCode": "text", "languageCode": "text" }, "name": "text", "accounts": [ { "id": "text", "icon": "text", "type": "text", "status": "text", "name": "text" } ], "currentAccount": { "id": "text", "icon": "text", "type": "text", "status": "text", "name": "text" } } }, "category": { "id": "text", "audit": {}, "$meta": { "omitted": [ "text" ] }, "description": "text", "optOutAllowed": true, "status": "text", "name": "text", "note": "text", "deleteAllowed": true, "icon": "text", "statistics": { "month": { "bounced": 1, "complained": 1, "discarded": 1, "failed": 1, "sent": 1, "total": 1 }, "today": { "bounced": 1, "complained": 1, "discarded": 1, "failed": 1, "sent": 1, "total": 1 }, "week": { "bounced": 1, "complained": 1, "discarded": 1, "failed": 1, "sent": 1, "total": 1 } }, "lastUsed": "2026-02-20T00:37:31.689Z" }, "account": { "id": "text", "audit": {}, "$meta": { "omitted": [ "text" ] }, "icon": "text", "externalIds": { "pyraTenantId": "123e4567-e89b-12d3-a456-426614174000" }, "externalId": "text", "externalName": "text", "type": "text", "status": "text", "serviceLevel": "text", "address": { "addressLine1": "text", "addressLine2": "text", "postCode": "text", "city": "text", "state": "text", "country": "text" }, "technicalSupportEmail": "[email protected]", "website": "text", "description": "text", "name": "text", "groups": [ { "id": "text", "name": "text", "description": "text", "logo": "text", "isDefault": true } ], "eligibility": { "client": true, "partner": true } }, "status": "text", "statusReason": "text", "subject": "text", "body": "text", "attachments": [ { "id": "text", "audit": {}, "$meta": { "omitted": [ "text" ] }, "name": "text", "type": "text", "description": "text", "filename": "text", "size": 1, "contentType": "text", "request": {} } ] }