Create
curl --request POST \
--url https://api.birdeye.com/resources/v1/business/public/custom-fields/create \
--header 'Content-Type: application/json' \
--data '
{
"defaultValue": "Green",
"dropDownOptions": [
"Blue",
"Green",
"Red"
],
"fieldDescription": "This custom field contains list of colours",
"fieldName": "colours",
"filterable": "false",
"type": "DROPDOWN_MULTI"
}
'import requests
url = "https://api.birdeye.com/resources/v1/business/public/custom-fields/create"
payload = {
"defaultValue": "Green",
"dropDownOptions": ["Blue", "Green", "Red"],
"fieldDescription": "This custom field contains list of colours",
"fieldName": "colours",
"filterable": "false",
"type": "DROPDOWN_MULTI"
}
headers = {"Content-Type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({
defaultValue: 'Green',
dropDownOptions: ['Blue', 'Green', 'Red'],
fieldDescription: 'This custom field contains list of colours',
fieldName: 'colours',
filterable: 'false',
type: 'DROPDOWN_MULTI'
})
};
fetch('https://api.birdeye.com/resources/v1/business/public/custom-fields/create', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.birdeye.com/resources/v1/business/public/custom-fields/create",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'defaultValue' => 'Green',
'dropDownOptions' => [
'Blue',
'Green',
'Red'
],
'fieldDescription' => 'This custom field contains list of colours',
'fieldName' => 'colours',
'filterable' => 'false',
'type' => 'DROPDOWN_MULTI'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.birdeye.com/resources/v1/business/public/custom-fields/create"
payload := strings.NewReader("{\n \"defaultValue\": \"Green\",\n \"dropDownOptions\": [\n \"Blue\",\n \"Green\",\n \"Red\"\n ],\n \"fieldDescription\": \"This custom field contains list of colours\",\n \"fieldName\": \"colours\",\n \"filterable\": \"false\",\n \"type\": \"DROPDOWN_MULTI\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.birdeye.com/resources/v1/business/public/custom-fields/create")
.header("Content-Type", "application/json")
.body("{\n \"defaultValue\": \"Green\",\n \"dropDownOptions\": [\n \"Blue\",\n \"Green\",\n \"Red\"\n ],\n \"fieldDescription\": \"This custom field contains list of colours\",\n \"fieldName\": \"colours\",\n \"filterable\": \"false\",\n \"type\": \"DROPDOWN_MULTI\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.birdeye.com/resources/v1/business/public/custom-fields/create")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"defaultValue\": \"Green\",\n \"dropDownOptions\": [\n \"Blue\",\n \"Green\",\n \"Red\"\n ],\n \"fieldDescription\": \"This custom field contains list of colours\",\n \"fieldName\": \"colours\",\n \"filterable\": \"false\",\n \"type\": \"DROPDOWN_MULTI\"\n}"
response = http.request(request)
puts response.read_body{
"code": 5040,
"message": "Max limit reached for custom fields."
}Custom Fields
Create Custom Field
POST
/
v1
/
business
/
public
/
custom-fields
/
create
Create
curl --request POST \
--url https://api.birdeye.com/resources/v1/business/public/custom-fields/create \
--header 'Content-Type: application/json' \
--data '
{
"defaultValue": "Green",
"dropDownOptions": [
"Blue",
"Green",
"Red"
],
"fieldDescription": "This custom field contains list of colours",
"fieldName": "colours",
"filterable": "false",
"type": "DROPDOWN_MULTI"
}
'import requests
url = "https://api.birdeye.com/resources/v1/business/public/custom-fields/create"
payload = {
"defaultValue": "Green",
"dropDownOptions": ["Blue", "Green", "Red"],
"fieldDescription": "This custom field contains list of colours",
"fieldName": "colours",
"filterable": "false",
"type": "DROPDOWN_MULTI"
}
headers = {"Content-Type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({
defaultValue: 'Green',
dropDownOptions: ['Blue', 'Green', 'Red'],
fieldDescription: 'This custom field contains list of colours',
fieldName: 'colours',
filterable: 'false',
type: 'DROPDOWN_MULTI'
})
};
fetch('https://api.birdeye.com/resources/v1/business/public/custom-fields/create', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.birdeye.com/resources/v1/business/public/custom-fields/create",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'defaultValue' => 'Green',
'dropDownOptions' => [
'Blue',
'Green',
'Red'
],
'fieldDescription' => 'This custom field contains list of colours',
'fieldName' => 'colours',
'filterable' => 'false',
'type' => 'DROPDOWN_MULTI'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.birdeye.com/resources/v1/business/public/custom-fields/create"
payload := strings.NewReader("{\n \"defaultValue\": \"Green\",\n \"dropDownOptions\": [\n \"Blue\",\n \"Green\",\n \"Red\"\n ],\n \"fieldDescription\": \"This custom field contains list of colours\",\n \"fieldName\": \"colours\",\n \"filterable\": \"false\",\n \"type\": \"DROPDOWN_MULTI\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.birdeye.com/resources/v1/business/public/custom-fields/create")
.header("Content-Type", "application/json")
.body("{\n \"defaultValue\": \"Green\",\n \"dropDownOptions\": [\n \"Blue\",\n \"Green\",\n \"Red\"\n ],\n \"fieldDescription\": \"This custom field contains list of colours\",\n \"fieldName\": \"colours\",\n \"filterable\": \"false\",\n \"type\": \"DROPDOWN_MULTI\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.birdeye.com/resources/v1/business/public/custom-fields/create")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"defaultValue\": \"Green\",\n \"dropDownOptions\": [\n \"Blue\",\n \"Green\",\n \"Red\"\n ],\n \"fieldDescription\": \"This custom field contains list of colours\",\n \"fieldName\": \"colours\",\n \"filterable\": \"false\",\n \"type\": \"DROPDOWN_MULTI\"\n}"
response = http.request(request)
puts response.read_body{
"code": 5040,
"message": "Max limit reached for custom fields."
}Headers
e.g. application/json
e.g. - Partner specific API key provided by Birdeye for data exchange.
e.g. - Long Business Number
Body
application/json
Name of custom field.
Type of custom field.
Values allowed are TEXT, URL, NUMBER, DATE, DROPDOWN_SINGLE ,DROPDOWN_MULTI,TEXT_RAW.
Default Value of custom field.
The list of options in custom field.
Only required when when type is either "DROPDOWN_SINGLE" or "DROPDOWN_MULTI".
Description of custom field.
Whether the custom field will be filterable or not. Default: false
Response
OK

