Skip to content

PUT 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/3

Description

This endpoint is used to update an existing custom field in the system. By providing the custom field ID and the new custom field name along with associated metadata, you can modify an existing custom field. The response will include a confirmation message indicating that the custom field was updated successfully, along with the details of the updated custom field.

AUTHORIZATION

Bearer Token

  • Token: {{jwt_token}}

Bode raw

{
    "customFieldName": "My_Name",
    "meta_data": {
        "account_id": "123-1234-12342355-12323534635"
    }
}

Example Request

curl --location -g --request PUT '{{base_url}}/custom-fields/3' \
--data '{
    "customFieldName": "My_Name"
}'

Example Response

{
  "message": "Custom fields created successfully",
  "data": {
    "id": "3",
    "key": "{{CF.MY_NAME}}",
    "value": "My_Name",
    "defaultValue": "",
    "isLiveMode": true,
    "creator": null,
    "createdAt": "2024-02-15T13:06:27.285Z"
  }
}