delete-limeobject¶
The delete-limeobject command deletes a limeobject given a limetype and
the record ID.
Example
{
"name": "delete-limeobject",
"parameters": {
"limetype": "deal",
"id": 1001
}
}
Parameters¶
limetype¶
Required. Specifies the limetype the command maps to.
id¶
Required. Specifies the ID of the limeobject to delete. Must be a positive integer.
Errors¶
| Code | Message |
|---|---|
PARAMETER |
"The command parameter(s) are required: missingparameters" |
PARAMETER |
"Invalid limetype: limetype" |
PARAMETER |
"Invalid limeobject limetype:id" |
PARAMETER |
"Invalid id: id. Expected a positive integer" |
PARAMETER |
"Access to limetype 'limetype' or a property is denied" |
OTHER |
"An internal error occurred while executing the command" |
Note
The command will not fail when trying to delete an already deleted limeobject.