Book traversal links for Delete Image (delete-image)
Parameters Sent from Web Hook
Method: POST
Parameter Name | Value (or typical value) | Description |
---|---|---|
command-type | delete-image | The name of the command the web hook is attempting to execute. |
push-authorization-token | [Your Custom Push Authorization Token] | Recommended to be either an SHA-256 or SHA-512 value that is agreeable (or common) between https://proboast.com and the receiving website or web service. |
image-uuid | 7bfaa3a3-ca82-4128-abce-2e397116d164 | The image's unique identifier (UUID), as generated by ProBoast. |
album-uuid | 41090c9b-6f35-4b55-b326-242cbc0b1d82 | The album's unique identifier (UUID), as generated by ProBoast, and displayed with your account on https://proboast.com/. |
image-url | [URL of the image on your website] | The URL of the image on your website. When creating an image via the "create-image" web hook, the URL of its permanent location on your website is returned and stored on https://proboast.com within the image entity. |
image-preferred-id | [The preferred ID of the image on your website] | This may be any arbitrary value that can assist your website/web application in locating the image to delete. When creating an image via the "create-image" web hook, the "preferred image ID' may be optionally returned and stored on https://proboast.com within the image entity. |
Expected Response
Status must be: 200
Response format must be: JSON
{"deleted"}