POST Create Custom Fields

Base URLs

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

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

{{base_url}}/custom-fields

Description

This endpoint is used to create a new custom field in the system. By providing the custom field name and associated metadata, you can add a new custom field that can be utilized for various purposes within the account. The response will include a confirmation message indicating that the custom field was created successfully, along with the details of the newly created custom field.

AUTHORIZATION

Bearer Token

• Token: {{jwt_token}}

Bode raw

{
    "customFieldName": "Father Name",
    "meta_data": {
        "account_id": "123-1234-12342355-12323534634"
    }
}

Example Request

curl --location -g '{{base_url}}/custom-fields' \
--data '{
    "customFieldName": "Age"
}'

Example Response

{
  "message": "Custom fields created successfully",
  "data": {
    "id": "1",
    "key": "{{CF.AGE}}",
    "value": "Age",
    "defaultValue": "",
    "isLiveMode": true,
    "creator": null,
    "createdAt": "2024-02-15T13:05:39.460Z"
  }
}