Skip to content

Delete Update Custom Field

Base URLs

Demo URL: https://demoapi.openletterconnect.com/api/v1

Production URL: https://api.openletterconnect.com/api/v1

{{base_url}}/custom-fields/{{id}}

Description

This endpoint is used to delete a specific custom field from the system. By providing the custom field ID, you can remove the custom field permanently. The response will include a confirmation message indicating that the custom field was deleted successfully, along with any relevant data regarding the deletion.

AUTHORIZATION

Bearer Token

  • Token: {{jwt_token}}

Example Request

curl --location -g --request DELETE '{{base_url}}/custom-fields/My_Name'

Example Response

{
  "message": "Custom field My_Name deleted successfully",
  "data": {
    "id": "2",
    "type": "custom-fields",
    "key": "custom-fields",
    "value": [
      {
        "key": "{{AGE}}",
        "value": "Age",
        "defaultValue": "Age"
      },
      {
        "key": "{{WIFE_NAME}}",
        "value": "Wife_Name",
        "defaultValue": "Wife_Name"
      }
    ],
    "isLiveMode": true,
    "creator": null,
    "createdAt": "2023-12-14T13:35:29.582Z"
  }
}