Create a custom field definition

POST

/custom-fields

Requires contacts:write and an active integration creator with settings.general in the token company. Attribute names use camelCase. Omitted attributes are preserved on PATCH.

Requisição

Parâmetros Bodyapplication/jsonNecessário

Examples

Respostas

🟢201Criado

application/json

Custom field definitions.

Bodyapplication/json

🟠401Não Autorizado

🟠403Proibido

🟠404Registo Não Encontrado

🟠422Erro de Parâmetro

🟠429

Request Example

Shell

JavaScript

Java

Swift

curl --location '/custom-fields' \
--header 'Content-Type: application/json' \
--data '{
    "key": "string",
    "label": "string",
    "type": "text",
    "scope": "contact",
    "description": "string",
    "required": false,
    "active": true,
    "showToClient": false,
    "section": "string",
    "position": -2147483648,
    "multiline": false,
    "hideWhenEmpty": false,
    "readOnly": false,
    "options": [
        {
            "value": "string",
            "label": "string"
        }
    ],
    "optionsPatch": {
        "upsert": [
            {
                "value": "string",
                "label": "string"
            }
        ],
        "remove": [
            "string"
        ]
    },
    "linkTemplate": "string",
    "linkLabel": "string",
    "hideWhenEqualsNative": "name",
    "mirror": {
        "idAlias": "string"
    }
}'

Response Example

201 - Exemplo 1

{
    "data": {
        "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
        "key": "string",
        "label": "string",
        "type": "text",
        "scope": "contact",
        "description": "string",
        "required": false,
        "active": true,
        "showToClient": false,
        "section": "string",
        "position": -2147483648,
        "multiline": false,
        "hideWhenEmpty": false,
        "readOnly": false,
        "options": [
            {
                "value": "string",
                "label": "string"
            }
        ],
        "linkTemplate": "string",
        "linkLabel": "string",
        "hideWhenEqualsNative": "name",
        "mirror": {
            "idAlias": "string",
            "integrationUuid": "b7aad38b-3fd6-492e-99a1-6cea55d79e80",
            "terminalValues": [
                "string"
            ]
        }
    }
}

Modificado em 2026-10-01 04:51:22

Página anterior

List custom field definitions

Próxima página

Update a custom field definition