Rule.io SDK

Appearance

Rule.io SDK

Rule.io SDK / client/src / CreateCustomFieldEntry

Interface: CreateCustomFieldEntry

Defined in: client/src/resources/custom-field/custom-field.types.ts:89

An entry for CustomFieldClient.createGroups.

Specifies one field to create using the "GroupName.FieldName" key format. Both the group and the field are created if they do not already exist.

Example ​

typescript
await client.customField.createGroups([
  { key: 'Booking.FirstName', type: 'text' },
  { key: 'Booking.LastName',  type: 'text' },
  { key: 'Order.TotalAmount', type: 'text' },
]);

Properties ​

key ​

key: string

Defined in: client/src/resources/custom-field/custom-field.types.ts:95

Group and field name joined by a dot: "GroupName.FieldName".

Both the group and the field are created if they do not already exist.

type? ​

optional type?: CustomFieldValueType

Defined in: client/src/resources/custom-field/custom-field.types.ts:101

Field data type.

Defaults to 'text' when omitted.