Skip to content

Delete a contact property

Remove a property, and the value every contact held for it.

http
DELETE /v1/contact-properties/{id}

Requires a Full access API key.

Path parameters

ParameterTypeRequiredDescription
idstringYesThe contact property id.

Example

bash
curl -X DELETE "https://api.sendgrail.com/v1/contact-properties/$PROPERTY_ID" \
  -H "Authorization: Bearer $SENDGRAIL_API_KEY"
js
await fetch(`https://api.sendgrail.com/v1/contact-properties/${id}`, {
  method: 'DELETE',
  headers: { Authorization: `Bearer ${process.env.SENDGRAIL_API_KEY}` },
});

Response

json
{
  "object": "contact_property",
  "id": "b6d24b8e-af0b-4c3c-be0c-359bbd97381e",
  "deleted": true
}

This deletes data, not just the definition

Deleting a property also deletes the value every contact stored against it. If a thousand contacts each had a company_name, those thousand values are gone, and re-creating a property with the same key does not bring them back — it creates an empty one.

Templates rendering {{{contact.company_name}}} will render nothing from that point on, since there is no longer a property to fall back to either.

If you only want to stop using a property, stop rendering its tag and leave it in place. Deleting is for when you want the data gone.

Transactional email on your own domain.