Delete a CMS message

Prev Next
Delete
/cmsMessages/delete

Delete archives the object (lifecycleStatus becomes ARCHIVED). It does not check whether the object is still in use, and objects built from it are not changed.

Query parameters
cmsMessageId
integer (int64) Required

The numeric ID of the CM2 message. Not the cmsMessageId of the legacy cms domain (cms/getMimeMessage), which is a different ID.

Responses
204

The message was deleted.

400

Error. All errors are returned as HTTP 400; errorCode in the body says what went wrong: INVALID_PARAMETER or MISSING_PARAMETER (a parameter is missing or invalid), NO_SUCH_OBJECT (no object with this ID in your account), PERMISSION_DENIED (your user lacks the CMS permission for this action), UNEXPECTED_ERROR (backend error). Example: {"errorActor": "CLIENT", "errorCode": "NO_SUCH_OBJECT", "message": "...", "objectType": null, "propertyName": null, "propertyValue": null}