Associate
curl --request PUT \
--url https://api.birdeye.com/resources/v1/business/public/custom-fields/associate \
--header 'Content-Type: application/json' \
--data '
{
"businessNumber": 1234567890,
"fieldId": 376,
"fieldValue": "Green"
}
'import requests
url = "https://api.birdeye.com/resources/v1/business/public/custom-fields/associate"
payload = {
"businessNumber": 1234567890,
"fieldId": 376,
"fieldValue": "Green"
}
headers = {"Content-Type": "application/json"}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({businessNumber: 1234567890, fieldId: 376, fieldValue: 'Green'})
};
fetch('https://api.birdeye.com/resources/v1/business/public/custom-fields/associate', 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/associate",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'businessNumber' => 1234567890,
'fieldId' => 376,
'fieldValue' => 'Green'
]),
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/associate"
payload := strings.NewReader("{\n \"businessNumber\": 1234567890,\n \"fieldId\": 376,\n \"fieldValue\": \"Green\"\n}")
req, _ := http.NewRequest("PUT", 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.put("https://api.birdeye.com/resources/v1/business/public/custom-fields/associate")
.header("Content-Type", "application/json")
.body("{\n \"businessNumber\": 1234567890,\n \"fieldId\": 376,\n \"fieldValue\": \"Green\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.birdeye.com/resources/v1/business/public/custom-fields/associate")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"businessNumber\": 1234567890,\n \"fieldId\": 376,\n \"fieldValue\": \"Green\"\n}"
response = http.request(request)
puts response.read_body{
"id": 376,
"fieldName": "colours",
"type": "DROPDOWN_MULTI",
"fieldValue": "Green",
"defaultValue": "Green",
"isHidden": true,
"allBusinesses": true,
"filterable": true
}{
"code": 5028,
"message": "Custom field delete failed."
}Custom Fields
Associate Custom Fields
PUT
/
v1
/
business
/
public
/
custom-fields
/
associate
Associate
curl --request PUT \
--url https://api.birdeye.com/resources/v1/business/public/custom-fields/associate \
--header 'Content-Type: application/json' \
--data '
{
"businessNumber": 1234567890,
"fieldId": 376,
"fieldValue": "Green"
}
'import requests
url = "https://api.birdeye.com/resources/v1/business/public/custom-fields/associate"
payload = {
"businessNumber": 1234567890,
"fieldId": 376,
"fieldValue": "Green"
}
headers = {"Content-Type": "application/json"}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({businessNumber: 1234567890, fieldId: 376, fieldValue: 'Green'})
};
fetch('https://api.birdeye.com/resources/v1/business/public/custom-fields/associate', 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/associate",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'businessNumber' => 1234567890,
'fieldId' => 376,
'fieldValue' => 'Green'
]),
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/associate"
payload := strings.NewReader("{\n \"businessNumber\": 1234567890,\n \"fieldId\": 376,\n \"fieldValue\": \"Green\"\n}")
req, _ := http.NewRequest("PUT", 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.put("https://api.birdeye.com/resources/v1/business/public/custom-fields/associate")
.header("Content-Type", "application/json")
.body("{\n \"businessNumber\": 1234567890,\n \"fieldId\": 376,\n \"fieldValue\": \"Green\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.birdeye.com/resources/v1/business/public/custom-fields/associate")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"businessNumber\": 1234567890,\n \"fieldId\": 376,\n \"fieldValue\": \"Green\"\n}"
response = http.request(request)
puts response.read_body{
"id": 376,
"fieldName": "colours",
"type": "DROPDOWN_MULTI",
"fieldValue": "Green",
"defaultValue": "Green",
"isHidden": true,
"allBusinesses": true,
"filterable": true
}{
"code": 5028,
"message": "Custom field delete failed."
}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
Response
OK
fieldId of the custom field.
Example:
376
Name of the custom field.
Example:
"colours"
Type of field.
Example:
"DROPDOWN_MULTI"
Associated Field Value of custom field .
Example:
"Green"
Default Value of custom field and will only be visible if value is present.
Example:
"Green"
Whether the custom field will be hidden or not.
Whether the custom field will be for all businesses or not.
Whether the custom field will be filterable or not.

