Skip to content

Create EDICustomField

Request

Creates a new EDICustomField

Security
apiKeyAuth and bearerAuth
Headers
vbasoftware-databasestringrequired

Target database

Bodyapplication/jsonrequired
ediCustomField_Keyinteger, (int32)required

Key value that identifies a custom field on and EDI load Note: The database will apply a default value of 0 for this field if a value is not provided. This field is also marked as NOT NULL in the database and therefore required by the API. If you do not have a value for this field, supply the database default value of 0 to meet the API requirements and ensure that the functionality occurs as expected.

field_Namestring or null, <= 64 characters

Name of the EDI custom field

sourcestring, [ 1 .. 16 ] charactersrequired

Source where the EDI custom field will retrieved from

curl -i -X POST \
  https://vbapi.vbasoftware.com/vbasoftware/edi-custom-fields \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -H 'vbasoftware-database: string' \
  -H 'x-api-key: YOUR_API_KEY_HERE' \
  -d '{
    "ediCustomField_Key": 0,
    "field_Name": "string",
    "source": "string"
  }'

Responses

Success

Bodyapplication/json
dataobject
errorobject
debugobject
Response
{
  "data": { … },
  "error": { … },
  "debug": { … }
}