Delete a custom field
Permanently deletes a custom field definition by its ID. Request: DELETE /v1/custom-fields/{id}. Scope: contacts:delete.
DELETE
Permanently deletes a custom field definition by its ID.
apiKeyheader
x-api-key<token>id*stringMatch
^cfield_[0-9a-hjkmnp-tv-z]{16,24}$Success
application/json- response
success*booleanimport { createClient } from "samva";
const samva = createClient({ apiKey: process.env.SAMVA_API_KEY! });
const result = await samva.customFields.remove({
"id": "example"
});Example Response
{
"success": true
}