Contact Us

curl --request POST \
  --url https://api.birdeye.com/resources/v1/contactUs/{businessId} \
  --header 'Content-Type: application/json' \
  --data '
{
  "customerComment": "What all services do you offer?",
  "customer": {
    "name": "Dummy Name",
    "emailId": "sam@gmail.com",
    "phone": "4424242424"
  },
  "additionalParams": {
    "channel": "Web",
    "utm_campiagn": "New Year"
  }
}
'

import requests

url = "https://api.birdeye.com/resources/v1/contactUs/{businessId}"

payload = {
    "customerComment": "What all services do you offer?",
    "customer": {
        "name": "Dummy Name",
        "emailId": "sam@gmail.com",
        "phone": "4424242424"
    },
    "additionalParams": {
        "channel": "Web",
        "utm_campiagn": "New Year"
    }
}
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({
    customerComment: 'What all services do you offer?',
    customer: {name: 'Dummy Name', emailId: 'sam@gmail.com', phone: '4424242424'},
    additionalParams: {channel: 'Web', utm_campiagn: 'New Year'}
  })
};

fetch('https://api.birdeye.com/resources/v1/contactUs/{businessId}', 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/contactUs/{businessId}",
  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([
    'customerComment' => 'What all services do you offer?',
    'customer' => [
        'name' => 'Dummy Name',
        'emailId' => 'sam@gmail.com',
        'phone' => '4424242424'
    ],
    'additionalParams' => [
        'channel' => 'Web',
        'utm_campiagn' => 'New Year'
    ]
  ]),
  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/contactUs/{businessId}"

	payload := strings.NewReader("{\n  \"customerComment\": \"What all services do you offer?\",\n  \"customer\": {\n    \"name\": \"Dummy Name\",\n    \"emailId\": \"sam@gmail.com\",\n    \"phone\": \"4424242424\"\n  },\n  \"additionalParams\": {\n    \"channel\": \"Web\",\n    \"utm_campiagn\": \"New Year\"\n  }\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/contactUs/{businessId}")
  .header("Content-Type", "application/json")
  .body("{\n  \"customerComment\": \"What all services do you offer?\",\n  \"customer\": {\n    \"name\": \"Dummy Name\",\n    \"emailId\": \"sam@gmail.com\",\n    \"phone\": \"4424242424\"\n  },\n  \"additionalParams\": {\n    \"channel\": \"Web\",\n    \"utm_campiagn\": \"New Year\"\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.birdeye.com/resources/v1/contactUs/{businessId}")

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  \"customerComment\": \"What all services do you offer?\",\n  \"customer\": {\n    \"name\": \"Dummy Name\",\n    \"emailId\": \"sam@gmail.com\",\n    \"phone\": \"4424242424\"\n  },\n  \"additionalParams\": {\n    \"channel\": \"Web\",\n    \"utm_campiagn\": \"New Year\"\n  }\n}"

response = http.request(request)
puts response.read_body

{
  "customerId": 1234567
}

{
  "code": 5046,
  "message": "The customer is blocked"
}

{
  "code": 1167,
  "message": "API key is missing"
}

{
  "code": 1175,
  "message": "No business found with the given id"
}

{
  "code": 89,
  "message": "Rate limit exceeded"
}

POST

contactUs

{businessId}

curl --request POST \
  --url https://api.birdeye.com/resources/v1/contactUs/{businessId} \
  --header 'Content-Type: application/json' \
  --data '
{
  "customerComment": "What all services do you offer?",
  "customer": {
    "name": "Dummy Name",
    "emailId": "sam@gmail.com",
    "phone": "4424242424"
  },
  "additionalParams": {
    "channel": "Web",
    "utm_campiagn": "New Year"
  }
}
'

import requests

url = "https://api.birdeye.com/resources/v1/contactUs/{businessId}"

payload = {
    "customerComment": "What all services do you offer?",
    "customer": {
        "name": "Dummy Name",
        "emailId": "sam@gmail.com",
        "phone": "4424242424"
    },
    "additionalParams": {
        "channel": "Web",
        "utm_campiagn": "New Year"
    }
}
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({
    customerComment: 'What all services do you offer?',
    customer: {name: 'Dummy Name', emailId: 'sam@gmail.com', phone: '4424242424'},
    additionalParams: {channel: 'Web', utm_campiagn: 'New Year'}
  })
};

fetch('https://api.birdeye.com/resources/v1/contactUs/{businessId}', 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/contactUs/{businessId}",
  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([
    'customerComment' => 'What all services do you offer?',
    'customer' => [
        'name' => 'Dummy Name',
        'emailId' => 'sam@gmail.com',
        'phone' => '4424242424'
    ],
    'additionalParams' => [
        'channel' => 'Web',
        'utm_campiagn' => 'New Year'
    ]
  ]),
  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/contactUs/{businessId}"

	payload := strings.NewReader("{\n  \"customerComment\": \"What all services do you offer?\",\n  \"customer\": {\n    \"name\": \"Dummy Name\",\n    \"emailId\": \"sam@gmail.com\",\n    \"phone\": \"4424242424\"\n  },\n  \"additionalParams\": {\n    \"channel\": \"Web\",\n    \"utm_campiagn\": \"New Year\"\n  }\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/contactUs/{businessId}")
  .header("Content-Type", "application/json")
  .body("{\n  \"customerComment\": \"What all services do you offer?\",\n  \"customer\": {\n    \"name\": \"Dummy Name\",\n    \"emailId\": \"sam@gmail.com\",\n    \"phone\": \"4424242424\"\n  },\n  \"additionalParams\": {\n    \"channel\": \"Web\",\n    \"utm_campiagn\": \"New Year\"\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.birdeye.com/resources/v1/contactUs/{businessId}")

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  \"customerComment\": \"What all services do you offer?\",\n  \"customer\": {\n    \"name\": \"Dummy Name\",\n    \"emailId\": \"sam@gmail.com\",\n    \"phone\": \"4424242424\"\n  },\n  \"additionalParams\": {\n    \"channel\": \"Web\",\n    \"utm_campiagn\": \"New Year\"\n  }\n}"

response = http.request(request)
puts response.read_body

{
  "customerId": 1234567
}

{
  "code": 5046,
  "message": "The customer is blocked"
}

{
  "code": 1167,
  "message": "API key is missing"
}

{
  "code": 1175,
  "message": "No business found with the given id"
}

{
  "code": 89,
  "message": "Rate limit exceeded"
}

Headers

string

e.g. application/json

x-api-key

string

e.g. [Required] Partner specific API key provided by Birdeye for data exchange.

Path Parameters

businessId

string

required

Id of the business.

Body

application/json

customer

object

required

Customer details.

Show child attributes

customerComment

string

Comment or query by the customer

additionalParams

object

Additional Params contains (key,value) pair which can be used to track the customers.

Response

customerId

number

Id of the enterprise customer.

Overview

Business

Custom Fields

User

Reviews

Contact

Contact V2

Campaign

Aggregation

Report

Survey

Business Media

Social

Employee

Conversation

Subscription

Webhook

Competitor

Competitor AI

Insight AI

Google Q&A

Google Services

FAQ

Listing

GMB Products

Search AI

Ticketing

Integration

Headers

Path Parameters

Body

Response