{"metadata":{"image":[],"title":"","description":""},"api":{"url":"/resource/:site_id/:resource_id","auth":"required","params":[{"name":"site_id","type":"string","default":"","desc":"The unique identifier for your Boomtrain site.","required":true,"in":"path","ref":"","_id":"576859ce138f8c1900a8754e"},{"name":"resource_id","type":"string","default":"","desc":"The ID of the resource to delete.","required":true,"in":"path","ref":"","_id":"56d9e77caa96cc150020eb63"},{"name":"resource_type","type":"string","default":"A string designation of the resource type, e.g. `article`, `product`, `recipe`, `video`.","desc":"","required":true,"in":"query","ref":"","_id":"592dd1f6c050a42d00f814ea"}],"results":{"codes":[{"status":204,"language":"json","code":"// No body returned from a successful deletion\n{}","name":"No Content (Successful Deletion)"},{"language":"json","code":"{\n    \"errors\": [\n      \t{    \"message\": \"The requested resource could not be found.\" }\n      ]\n}","name":"Not Found (Unable to Delete)","status":404}]},"settings":"57432f2eeed4ab0e00edc652","examples":{"codes":[{"code":"curl -H 'Authorization: Bearer <jwt>'\n-X DELETE 'https://resources.api.boomtrain.com/resource/your-site/c182c299a664e80a9d5b5f381a8d5c53?resource_type=article'","language":"curl"}]},"method":"delete"},"next":{"description":"","pages":[]},"title":"Delete a Resource","type":"endpoint","slug":"delete-a-resource","excerpt":"Deletes the specified resource from your resource collection.","body":"","updates":[],"order":11,"isReference":true,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"_id":"57432e8ce42a590e00e26cd4","githubsync":"","parentDoc":null,"project":"56aff08c3a5b810d00745d99","__v":9,"createdAt":"2016-05-23T16:23:40.237Z","editedParams2":true,"user":"566887ff8639090d00759415","version":{"version":"1","version_clean":"1.0.0","codename":"","is_stable":true,"is_beta":false,"is_hidden":false,"is_deprecated":false,"categories":["56aff08d3a5b810d00745d9d","56aff24f3a5b810d00745da0","56aff25dbc304a0d00ace207","56aff287e0b1e40d00c53798","56aff2b260a37a0d00ed8883","56aff2b8e0b1e40d00c53799","56aff2bd5b1f01170014dc7b","56aff2c9d21e9c0d00b62993","56aff493aef9a21700da0e67","56aff4ce1486990d009c0f64","56aff4da5b1f01170014dc7d","56aff4dfe0b1e40d00c537a2","56aff4e59d32e30d0006d3e9","56aff4e91486990d009c0f65","56aff4f93a5b810d00745da2","56aff4fe9d32e30d0006d3ea","56b91c7ab1e03e0d001057c5","56c4f51aba4a540d0091b9a2","56cd09488c4a331d002c1e44","56d4ec4773dcd20b00fb8769","56e79bc515f96b2200878e54","56ec25c538ff1d2200d56cc2","56ec3a6f36bc8e0e00f190c8","56ec3e308ea7ce0e00a3d8b0","5724d8fe4255580e005938b2","5724dc842ad0bc1700122803","5776ef2a04f7500e0095dc37","57ab9f70b5e8742000e17eb9","57d7117646dcc30e007dd21f","58e6abd5b1eece19008b7d31","59288c65e2653627003e1221","5a8f4797a44f8600128e75ee","5bbf8833eb416300039a2c14","5ea811617bf4b5007328a0af"],"_id":"56aff08c3a5b810d00745d9c","project":"56aff08c3a5b810d00745d99","releaseDate":"2016-02-01T23:55:56.544Z","__v":34,"createdAt":"2016-02-01T23:55:56.544Z"},"category":{"sync":{"isSync":false,"url":""},"pages":["56d4ec8573dcd20b00fb876a"],"title":"Server-Side Integration REST API","slug":"authorization","order":3,"from_sync":false,"reference":true,"_id":"56d4ec4773dcd20b00fb8769","__v":1,"version":"56aff08c3a5b810d00745d9c","createdAt":"2016-03-01T01:11:35.547Z","project":"56aff08c3a5b810d00745d99"},"editedParams":true}

deleteDelete a Resource

Deletes the specified resource from your resource collection.

Definition

{{ api_url }}{{ page_api_url }}

Parameters

Path Params

site_id:
required
string
The unique identifier for your Boomtrain site.
resource_id:
required
string
The ID of the resource to delete.

Query Params

resource_type:
required
stringA string designation of the resource type, e.g. `article`, `product`, `recipe`, `video`.

Examples


Result Format


User Information

Try It Out

delete
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}