Subscribe/Unsubscribe Customer

curl --request POST \
  --url https://api.birdeye.com/resources/v1/customer-v2/change-permission \
  --header 'Content-Type: application/json' \
  --data '
{
  "permission": "both-unsubscribed",
  "email": [
    "test1@mail.in"
  ],
  "phone": [
    "2345654326"
  ],
  "accountNumber": 123456789876543
}
'

import requests

url = "https://api.birdeye.com/resources/v1/customer-v2/change-permission"

payload = {
    "permission": "both-unsubscribed",
    "email": ["test1@mail.in"],
    "phone": ["2345654326"],
    "accountNumber": 123456789876543
}
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({
    permission: 'both-unsubscribed',
    email: ['test1@mail.in'],
    phone: ['2345654326'],
    accountNumber: 123456789876543
  })
};

fetch('https://api.birdeye.com/resources/v1/customer-v2/change-permission', 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/customer-v2/change-permission",
  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([
    'permission' => 'both-unsubscribed',
    'email' => [
        'test1@mail.in'
    ],
    'phone' => [
        '2345654326'
    ],
    'accountNumber' => 123456789876543
  ]),
  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/customer-v2/change-permission"

	payload := strings.NewReader("{\n  \"permission\": \"both-unsubscribed\",\n  \"email\": [\n    \"test1@mail.in\"\n  ],\n  \"phone\": [\n    \"2345654326\"\n  ],\n  \"accountNumber\": 123456789876543\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/customer-v2/change-permission")
  .header("Content-Type", "application/json")
  .body("{\n  \"permission\": \"both-unsubscribed\",\n  \"email\": [\n    \"test1@mail.in\"\n  ],\n  \"phone\": [\n    \"2345654326\"\n  ],\n  \"accountNumber\": 123456789876543\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.birdeye.com/resources/v1/customer-v2/change-permission")

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  \"permission\": \"both-unsubscribed\",\n  \"email\": [\n    \"test1@mail.in\"\n  ],\n  \"phone\": [\n    \"2345654326\"\n  ],\n  \"accountNumber\": 123456789876543\n}"

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

{
  "code": 1089,
  "message": "Customer id is invalid."
}

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

{
  "code": 1011,
  "message": "Business id is invalid"
}

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

POST

customer-v2

change-permission

Subscribe/Unsubscribe Customer

curl --request POST \
  --url https://api.birdeye.com/resources/v1/customer-v2/change-permission \
  --header 'Content-Type: application/json' \
  --data '
{
  "permission": "both-unsubscribed",
  "email": [
    "test1@mail.in"
  ],
  "phone": [
    "2345654326"
  ],
  "accountNumber": 123456789876543
}
'

import requests

url = "https://api.birdeye.com/resources/v1/customer-v2/change-permission"

payload = {
    "permission": "both-unsubscribed",
    "email": ["test1@mail.in"],
    "phone": ["2345654326"],
    "accountNumber": 123456789876543
}
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({
    permission: 'both-unsubscribed',
    email: ['test1@mail.in'],
    phone: ['2345654326'],
    accountNumber: 123456789876543
  })
};

fetch('https://api.birdeye.com/resources/v1/customer-v2/change-permission', 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/customer-v2/change-permission",
  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([
    'permission' => 'both-unsubscribed',
    'email' => [
        'test1@mail.in'
    ],
    'phone' => [
        '2345654326'
    ],
    'accountNumber' => 123456789876543
  ]),
  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/customer-v2/change-permission"

	payload := strings.NewReader("{\n  \"permission\": \"both-unsubscribed\",\n  \"email\": [\n    \"test1@mail.in\"\n  ],\n  \"phone\": [\n    \"2345654326\"\n  ],\n  \"accountNumber\": 123456789876543\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/customer-v2/change-permission")
  .header("Content-Type", "application/json")
  .body("{\n  \"permission\": \"both-unsubscribed\",\n  \"email\": [\n    \"test1@mail.in\"\n  ],\n  \"phone\": [\n    \"2345654326\"\n  ],\n  \"accountNumber\": 123456789876543\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.birdeye.com/resources/v1/customer-v2/change-permission")

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  \"permission\": \"both-unsubscribed\",\n  \"email\": [\n    \"test1@mail.in\"\n  ],\n  \"phone\": [\n    \"2345654326\"\n  ],\n  \"accountNumber\": 123456789876543\n}"

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

{
  "code": 1089,
  "message": "Customer id is invalid."
}

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

{
  "code": 1011,
  "message": "Business id is invalid"
}

{
  "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.

Body

application/json

accountNumber

number

required

Location id.

permission

string

unsubscribed (string, required) - Action to be taken. Valid values are both-subscribed, both-unsubscribed, sms-subscribed, and email-subscribed.

any[]

Customer email ids.

phone

any[]

Customer phone numbers.

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

Subscribe/Unsubscribe Customer

Headers

Body

Response