Sharing API \ Delete a message PHP SDK
Advanced Sharing API Resources
Resource/URI | GET | POST | PUT | DELETE |
---|---|---|---|---|
Sharing API Messages
/sharing/messages.json
|
List published messages | Publish a new message | – | – |
Sharing API Message /sharing/messages/<sharing_message_token>.json
|
Get message details | Re-Publish a message | – | Delete a message |
Workflow
Request: the code to send to the API
Send a DELETE
request to the resource /sharing/messages/<sharing_message_token>.json
to delete a previously shared message.
Please note that this operation does not remove the message from the social networks.
To prevent you from unintentionally deleting a sharing message by mixing up the DELETE/GET
methods
you have to include the url parameter confirm_deletion=true
in your DELETE
requests.
If you omit this parameter, the message will not be removed and an error will be thrown.
Result: the code returned by the API
The API either returns a HTTP status code 200
if the entry was deleted successfully
or an appropriate message body with further details on the error that occured.
Example Resultset
{ "response": { "request": { "date": "Tue, 23 Feb 2016 16:30:00 0100", "resource": "\/sharing\/messages\/da73e365-df50-4f61-859f-beeef7ea0432.json?confirm_deletion=true", "status": { "flag": "success", "code": 200, "info": "The specified sharing_message has successfully been removed" } } } }