Delete a custom field

DELETE/api/v1/contact-fields/:id

Scopecontacts:write

Deletes the field and removes its value from every contact. This can't be undone. contactsCleared says how many contacts had a value.

Path parameters

Prop

Type

curl -X DELETE "https://api.pedibee.com/api/v1/contact-fields/66f1c2a9e4b0a1b2c3d4e201" \
  -H "Authorization: Bearer $PEDIBEE_API_KEY"

200 OK

{
  "deleted": true,
  "id": "66f1c2a9e4b0a1b2c3d4e201",
  "contactsCleared": 128
}

Every error is { "error": "…" } with a message you can show. See Errors and limits.

Status	When
`403`	The key doesn’t have `contacts:write`, or its creator’s role no longer allows it.
`404`	No field with this id in your workspace.
`401`	The API key is missing, invalid, revoked or expired.
`429`	Too many requests. Wait for the seconds in `Retry-After`.