UPupflow
Custom Fields

Create Custom Field

This endpoint can be used to create a new custom field.

post/custom_fields

Request

  • Base URL
    https://api.upflow.io/v1
  • Auth
    API key in header X-Api-Key and API key in header X-Api-Secret

Request body

externalIdstring required

Custom field external identifier.

labelstring required

Custom field label displayed in the UI.

descriptionstring nullable

Custom field description.

dataType'STRING' | 'BOOLEAN' | 'FLOAT' | 'DATE' | 'DATETIME' | 'SELECT' | 'MULTI_SELECT' required

Data type of the custom field.

entityType'CUSTOMER' | 'INVOICE' | 'CONTACT' required

The type of entity the custom field applies to.

Example request

{
  "externalId": "AEGaaZD",
  "label": "custom field 01",
  "description": "custom field 01 description"
}

Response

Custom Field Created

externalIdstring required

Custom field external identifier.

labelstring required

Custom field label displayed in the UI.

descriptionstring nullable

Custom field description.

dataType'STRING' | 'BOOLEAN' | 'FLOAT' | 'DATE' | 'DATETIME' | 'SELECT' | 'MULTI_SELECT' required

Data type of the custom field.

entityType'CUSTOMER' | 'INVOICE' | 'CONTACT' required

The type of entity the custom field applies to.

idstring uuid required

The Custom Field ID.

sourcestring nullable

Source of the custom field definition.

Example response

{
  "externalId": "AEGaaZD",
  "label": "custom field 01",
  "description": "custom field 01 description",
  "id": "00a70b35-2be3-4c43-aefb-397190134655",
  "source": "USER_DEFINED"
}

Changes

No recorded changes to this operation across all 1 revision of this API.