photo-documentation/docs/api/PostGroupDelete.markdown

Delete Group

---

1. Purpose
2. Endpoint
3. Parameters
4. Examples

• Command line
• PHP

1. Response

• Sample

---

Purpose of the delete Group API

Use this API to delete a group.

---

Endpoint

Authentication: required

POST /group/:id/delete.json

Parameters

None

---

Examples

Command Line (using openphoto-php)

./openphoto -p -X POST -h current.openphoto.me -e /group/a/delete.json

PHP (using openphoto-php)

$client = new OpenPhotoOAuth($host, $consumerKey, $consumerSecret, $oauthToken, $oauthTokenSecret);
$response = $client->post("/group/a/delete.json");

---

Response

The response is in a standard response envelope.

• message, A string describing the result. Don't use this for anything but reading.
• code, 204 on success
• result, A boolean

Sample

{
  "message":"",
  "code":204,
  "result": true
}