Add Custom Fields

POST/N/A

Submit URL for POST request of the custom fields remains the same for each endpoint (ie api/contacts for Contacts endpoint, api/invoices for Invoices endpoint, etc..)

In this example, we will use the following form data which corresponds to the following custom field types:

custom_fields[invoice][1] = Input Type
custom_fields[invoice][2] = Number
custom_fields[invoice][3] = Textarea
custom_fields[invoice][4] = Radio
custom_fields[invoice][5] = Checkbox
custom_fields[invoice][6] = Multiselect
custom_fields[invoice][7] = Date
custom_fields[invoice][8] = Datetime
custom_fields[invoice][9] = Color
custom_fields[invoice][10] = Link

Parameters

FieldTypeDescription
custom_fields[customFieldType] string/array Custom Field Key should be same as field_name returned from Search custom field values' information
curl -X POST "https://yoursite.com/N/A" \
  -H "authtoken: YOUR_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{ "custom_fields[customFieldType]": "..." }'

Success-Response:

HTTP/1.1 200 OK
 Same as Original request

Error-Response:

HTTP/1.1 404 Not Found
Same as Original request
MethodPOST
Path/N/A
GroupCustom Fields
Sincev0.2.0
Defined inmodules/api/controllers/Custom_fields.php