custom-fields

Delete a custom field

Changed on

Permanently delete a custom field definition and remove its values from all contacts.

delete/v1/custom-fields/{customFieldId}

Request

  • Base URL: https://api.prod.getdex.com
  • URL: https://api.prod.getdex.com/v1/custom-fields/{customFieldId}
  • Auth: HTTP bearer

Path parameters

customFieldIdstring uuid required

Response

Successful response

errorboolean required
messagestring required

Changes

  • a2f71a243839Revision changes
    • info

      api operation id deleteCustomFieldV1 was added

    • info

      added the non-success response with the status

  • d7a4e2554573Revision changes
    • breaking

      added the pattern ^([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)$ to the path request parameter customFieldId

    • breaking

      for the path request parameter customFieldId, the format changed from no format to uuid