PropertyPixel Docs

Delete photos

POST
/projects/{project_id}/photos/delete

Delete photos from a project, together with every edit, staging and video made from them. Only do this when the user explicitly asks to remove those photos; confirm which ones first. All IDs must belong to the project, otherwise nothing is deleted. Returns the deleted IDs; call get_project to see what remains.

Requires a connection with edit access.

Authorization

headerAuthorizationBearer <token>

An API key from Settings → Developers (pp_live_…), or an OAuth access token.

Path Parameters

project_id*string

The project the photos belong to.

Match^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
Formatuuid

Header Parameters

Idempotency-Key?string

A unique key (for example a UUID) that makes retries safe. A retry with the same key and body returns the stored response; the same key with a different body returns 422. Keys last 24 hours.

Lengthlength <= 255

Request Body

application/json
  1. body
photo_ids*array<>

Photo IDs to delete (max 100).

Items1 <= items <= 100

Response Body

Delete photos

application/json
  1. response
object*string
deleted_ids*array<>
project_id*string
Match^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
Formatuuid
curl -X POST "https://example.com/projects/497f6eca-6276-4993-bfeb-53cbbbba6f08/photos/delete" \  -H "Content-Type: application/json" \  -d '{    "photo_ids": [      "68e4fc1a-5272-4c7c-88ae-00ad654f19af"    ]  }'
{  "object": "deletion",  "deleted_ids": [    "68e9c922-42e0-442b-8c61-e4abd0ab95e5"  ],  "project_id": "405d8375-3514-403b-8c43-83ae74cfe0e9"}