Collection.AddCustomField

Prev Next

Description

Create a custom field to all new collections in an account.

URL parameters

URL parameter ordering

The URL parameters below are listed in the order they should be entered in the API URL.

Name Required Type Description
Name True string Name of the new custom field.
Description False string Description of the custom field.
Format False string Format of the field. Either text, DateTime, URL, File, Number.
Default Value False string Default value for the custom field.
Confidential False string Set the agent as confidential. Default as not confidential.

Responses

Name Type Description
Result string Success if the operation was successful.
FieldID numeric The ID number of the custom field.