Developers
API referenceRecipients

Delete a recipient

DELETE
/recipients/{id}

Removes the recipient's personal data and its certificate. The trees return to your unassigned trees. The public certificate page shows "withdrawn" afterwards. Use this for a cancelled order or a data removal request.

Scope: recipients:write.

Authorization

bearerAuth
AuthorizationBearer <token>

A Platform API token, wyc_live_... or wyc_test_..., created at Settings > API tokens in the dashboard.

In: header

Path Parameters

id*string

Id of the recipient.

Match^rcp_[A-Za-z0-9]{24}$

Response Body

application/json

application/json

application/json

application/json

curl -X DELETE "https://example.com/recipients/string"
Empty