Business Numbers AI Tools

Open in ChatGPT

Open in ChatGPT to ask questions about this page

Open in Claude

Open in Claude to ask questions about this page

Copy as Markdown

Copy this page as markdown to use with AI assistants

View as Markdown

Open this page as markdown in a new tab

APIs for managing business numbers within the Arattai Business Platform. A business number is a phone number registered under a business that can send and receive messages on the Arattai network. Business numbers go through a display name verification flow and can carry a verified badge when approved by an administrator.

Host: https://business.arattai.in/api/v1

Required header: Arattai-CompanyId is required for all APIs.

The full set of attributes returned for a business number is documented under the Business Number schema in the API reference below.

Display Name Verification
A business number's display name can carry a verified badge on the Arattai network:

Submit a proposed name via POST /businessnumbers/{id}/displayname/submit. Status moves to "in_progress".
Withdraw a pending submission via POST /businessnumbers/{id}/displayname/revoke (only while "in_progress").
Admin approves or rejects. On approval, published_name is set and status becomes "verified".

Any direct edit of display_name via PATCH bypasses this flow and drops the verified badge.

Notes

phonenumber and phone_country_code are immutable after creation.
Logo download is GET /businessnumberlogo/{base64Encoded} via logo_url. There is no GET /businessnumbers/{id}/logo route.
Display name submit/revoke endpoints use OAuth scope businesses (not phonenumbers). The {id} path param is the business number reference_id.

Error Response Format
{"code": "error_code", "message": "A human-readable description."}

Download Business Numbers OpenAPI Document

End Points

PATCH

/api/v1/businessnumbers/{id}

GET

/api/v1/businessnumbers/{id}

DELETE

/api/v1/businessnumbers/{id}

GET

/api/v1/businessnumbers

GET

/api/v1/businesses/{id}/businessnumbers

POST

/api/v1/businessnumbers/{id}/logo

DELETE

/api/v1/businessnumbers/{id}/logo

GET

/api/v1/businessnumberlogo/{base64Encoded}

GET

/api/v1/arattaiphonenumbers/{phoneNumber}

GET

/api/v1/phonenumbers/{phoneNumber}

GET

/api/v1/usernames/{username}

POST

/api/v1/businessnumbers/{id}/profilepicture

POST

/api/v1/businessnumbers/{id}/coverimages

GET

/api/v1/businessnumbers/{id}/coverimages

GET

/api/v1/operatormedia/{token}

DELETE

/api/v1/businessnumbers/{id}/coverimages/{encodedId}

PUT

/api/v1/businessnumbers/{id}/miniapps

GET

/api/v1/businessnumbers/{id}/miniapps

POST

/api/v1/businessnumbers/{id}/miniappsorder

GET

/api/v1/numbersummary

POST

/api/v1/businessnumbers/{id}/displayname/submit

POST

/api/v1/businessnumbers/{id}/displayname/revoke

Attribute

string

Unique identifier of the business number, returned as a string. Use this value in the path of all subsequent calls that act on this business number, for example /businessnumbers/{id}.

reference_id

string

Base36-encoded opaque identifier for the business number. Always present in responses, and used as the lightweight identifier referenced from related objects such as a business's businessnumbers list.

phonenumber

string

The phone number itself, without country code. Immutable after creation.

phone_country_code

string

Country calling code for the phone number, always including the leading "+" (e.g. "+91"). Immutable after creation.

full_phonenumber

string

Full phone number in E.164 format, combining phone_country_code and phonenumber (e.g. "+919443789765"). Omitted from the response when not set.

phone_region_code

string

ISO 3166-1 alpha-2 region code for the phone number (e.g. "IN"). Always present in responses, returned as an empty string for pre-existing numbers created before this field was introduced.

display_name

object

The business number's display name and its admin-review lifecycle. A proposed name is submitted via POST /businessnumbers/{id}/displayname/submit and can be withdrawn via POST /businessnumbers/{id}/displayname/revoke while pending. Directly editing this field via PATCH bypasses the review flow and drops the verified badge.

Show Sub-Attributes

published_name

string

The last admin-approved display name. Present only once a submission has been approved.

draft_name

string

The current or pending display name, set either directly via PATCH or via a display name submission.

status

string

Verification status of the draft display name.
Allowed values:

unverified - No submission has been made, or a previous submission was withdrawn/rejected and not resubmitted.
in_progress - A name has been submitted and is awaiting admin review.
verified - The submitted name was approved, and published_name now reflects it.
rejected - The submitted name was declined, see rejection_reason.

rejection_reason

string

Human-readable explanation of why the submitted display name was rejected. Present only after a rejection.

user_name

string

Unique username/handle for the business number, used for shareable profile links. Subject to a limited number of changes, see the username_change_limit_exceeded error.

business

object

Lightweight reference to the business this number belongs to.

Show Sub-Attributes

string

Reference ID of the business.

name

string

Display name of the business.

status

string

Verification status of the business.

user_data

array

Array describing which user-data fields (name and phone) are shared and whether sharing is mandatory for this business number. Always present and always contains exactly 2 entries.

Show Sub-Attributes

type

string

Which user-data field this entry controls.
Allowed values:

name - The sender's name, shown to recipients.
phone - The sender's phone number, shown to recipients.

enabled

boolean

Whether this field is shared with recipients.

mandatory

boolean

Whether sharing this field is mandatory and cannot be disabled.

logo_url

string

Download URL for the business number logo, of the form GET /businessnumberlogo/{base64Encoded}. Note there is no GET /businessnumbers/{id}/logo route, the logo must be fetched via this URL.

created_time

integer

Timestamp when the business number was created, as epoch milliseconds.

modified_time

integer

Timestamp when the business number was last modified, as epoch milliseconds.

creator

object

User who created the business number.

Show Sub-Attributes

string

Unique identifier of the user.

display_name

string

Display name of the user.

string

Email address of the user.

zuid

string

Zoho account ID (ZUID) of the user.

modifier

object

User who last modified the business number. Same shape as creator. Always present in responses, and equals creator when the business number has never been updated.

Show Sub-Attributes

string

Unique identifier of the user.

display_name

string

Display name of the user.

string

Email address of the user.

zuid

string

Zoho account ID (ZUID) of the user.

{
    "id": "501000000005013",
    "reference_id": "1K3M5X2",
    "phonenumber": "9443789765",
    "phone_country_code": "+91",
    "full_phonenumber": "+919443789765",
    "phone_region_code": "IN",
    "display_name": {
        "published_name": "BMW Motorrad",
        "draft_name": "BMW",
        "status": "verified",
        "rejection_reason": "Name does not match registered business name."
    },
    "user_name": "BMW",
    "business": {
        "id": "1K3M5X2",
        "name": "BMW",
        "status": "verified"
    },
    "user_data": [
        {
            "type": "name",
            "enabled": true,
            "mandatory": false
        }
    ],
    "logo_url": "https://business.arattai.in/api/v1/businessnumberlogo/abcd1234==",
    "created_time": 1769489125588,
    "modified_time": 1769489125588,
    "creator": {
        "id": "501000000002001",
        "display_name": "Ryan West",
        "email": "ryan.west@example.com",
        "zuid": "72816325"
    },
    "modifier": {
        "id": "501000000002001",
        "display_name": "Ryan West",
        "email": "ryan.west@example.com",
        "zuid": "72816325"
    }
}

Update a Business Number AI Tools

Open in ChatGPT

Open in ChatGPT to ask questions about this page

Open in Claude

Open in Claude to ask questions about this page

Copy as Markdown

Copy this page as markdown to use with AI assistants

View as Markdown

Open this page as markdown in a new tab

Update an existing business number. All fields are optional; only send fields you want to update.

⚠

Notephonenumber and phone_country_code are immutable and cannot be updated after creation. A direct edit of display_name via this endpoint drops the verified badge. To get a verified badge, use the submit_for_verification flow.

submit_for_verification: When true and display_name is also present, submits the new display_name for admin review immediately.

business_hours: When provided, time_zone is required. To clear business_hours, send an empty object.

Rate Limits

Threshold Limit (Number of API calls allowed within a minute) - 30 requests per minute
Lock Period (Wait time before consecutive API requests) - 10 minutes

OAuth Scope : ArattaiBusiness.phonenumbers.UPDATE

Arguments

display_name

string

Display name for the business number, shown as the public-facing name on Arattai. Maximum 100 characters. Editing this field directly drops any existing verified badge; use submit_for_verification together with this field to route the new name through admin review instead.

user_name

string

Unique username/handle for the business number. Maximum 100 characters. Call GET /usernames/{username} first to check availability; returns 400 username_exists if already taken, or 400 username_change_limit_exceeded if the change limit has been reached.

description

string

Short description of the business number, shown to customers. Maximum 255 characters.

Path Parameters

string

(Required)

Business number ID.

Headers

Arattai-CompanyId

string

(Required)

The unique identifier of the company for this request.

Request Example

parameters_data='{"field1":"value1","field2":"value2"}';
headers_data = Map();
headers_data.put("Arattai-CompanyId", "SOME_STRING_VALUE");
headers_data.put("Authorization", "Bearer REPLACE_BEARER_TOKEN");
response = invokeUrl
[
url: "https://business.arattai.in/api/v1/businessnumbers/BUSINESS_NUMBER_ID"
type: PATCH
headers: headers_data
content-type: application/json
parameters: parameters_data
connection: <connection_name>
];
info response;

OkHttpClient client = new OkHttpClient();

MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{\"field1\":\"value1\",\"field2\":\"value2\"}");
Request request = new Request.Builder()
  .url("https://business.arattai.in/api/v1/businessnumbers/BUSINESS_NUMBER_ID")
  .patch(body)
  .addHeader("Arattai-CompanyId", "SOME_STRING_VALUE")
  .addHeader("Authorization", "Bearer REPLACE_BEARER_TOKEN")
  .addHeader("content-type", "application/json")
  .build();

Response response = client.newCall(request).execute();

const options = {
  method: 'PATCH',
  headers: {
    'Arattai-CompanyId': 'SOME_STRING_VALUE',
    Authorization: 'Bearer REPLACE_BEARER_TOKEN',
    'content-type': 'application/json'
  },
  body: '{"field1":"value1","field2":"value2"}'
};

fetch('https://business.arattai.in/api/v1/businessnumbers/BUSINESS_NUMBER_ID', options)
  .then(response => response.json())
  .then(response => console.log(response))
  .catch(err => console.error(err));

import http.client

conn = http.client.HTTPSConnection("business.arattai.in")

payload = "{\"field1\":\"value1\",\"field2\":\"value2\"}"

headers = {
    'Arattai-CompanyId': "SOME_STRING_VALUE",
    'Authorization': "Bearer REPLACE_BEARER_TOKEN",
    'content-type': "application/json"
    }

conn.request("PATCH", "/api/v1/businessnumbers/BUSINESS_NUMBER_ID", payload, headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))

const http = require("https");

const options = {
  "method": "PATCH",
  "hostname": "business.arattai.in",
  "port": null,
  "path": "/api/v1/businessnumbers/BUSINESS_NUMBER_ID",
  "headers": {
    "Arattai-CompanyId": "SOME_STRING_VALUE",
    "Authorization": "Bearer REPLACE_BEARER_TOKEN",
    "content-type": "application/json"
  }
};

const req = http.request(options, function (res) {
  const chunks = [];

  res.on("data", function (chunk) {
    chunks.push(chunk);
  });

  res.on("end", function () {
    const body = Buffer.concat(chunks);
    console.log(body.toString());
  });
});

req.write(JSON.stringify({field1: 'value1', field2: 'value2'}));
req.end();

var client = new RestClient("https://business.arattai.in/api/v1/businessnumbers/BUSINESS_NUMBER_ID");
var request = new RestRequest(Method.PATCH);
request.AddHeader("Arattai-CompanyId", "SOME_STRING_VALUE");
request.AddHeader("Authorization", "Bearer REPLACE_BEARER_TOKEN");
request.AddHeader("content-type", "application/json");
request.AddParameter("application/json", "{\"field1\":\"value1\",\"field2\":\"value2\"}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);

var client = new HttpClient();
var request = new HttpRequestMessage
{
    Method = HttpMethod.Patch,
    RequestUri = new Uri("https://business.arattai.in/api/v1/businessnumbers/BUSINESS_NUMBER_ID"),
    Headers =
    {
        { "Arattai-CompanyId", "SOME_STRING_VALUE" },
        { "Authorization", "Bearer REPLACE_BEARER_TOKEN" },
    },
    Content = new StringContent("{\"field1\":\"value1\",\"field2\":\"value2\"}")
    {
        Headers =
        {
            ContentType = new MediaTypeHeaderValue("application/json")
        }
    }
};
using (var response = await client.SendAsync(request))
{
    response.EnsureSuccessStatusCode();
    var body = await response.Content.ReadAsStringAsync();
    Console.WriteLine(body);
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io/ioutil"
)

func main() {

	url := "https://business.arattai.in/api/v1/businessnumbers/BUSINESS_NUMBER_ID"

	payload := strings.NewReader("{\"field1\":\"value1\",\"field2\":\"value2\"}")

	req, _ := http.NewRequest("PATCH", url, payload)

	req.Header.Add("Arattai-CompanyId", "SOME_STRING_VALUE")
	req.Header.Add("Authorization", "Bearer REPLACE_BEARER_TOKEN")
	req.Header.Add("content-type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}

const data = JSON.stringify({
  "field1": "value1",
  "field2": "value2"
});

const xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("PATCH", "https://business.arattai.in/api/v1/businessnumbers/BUSINESS_NUMBER_ID");
xhr.setRequestHeader("Arattai-CompanyId", "SOME_STRING_VALUE");
xhr.setRequestHeader("Authorization", "Bearer REPLACE_BEARER_TOKEN");
xhr.setRequestHeader("content-type", "application/json");

xhr.send(data);

curl --request PATCH \
  --url https://business.arattai.in/api/v1/businessnumbers/BUSINESS_NUMBER_ID \
  --header 'Arattai-CompanyId: SOME_STRING_VALUE' \
  --header 'Authorization: Bearer REPLACE_BEARER_TOKEN' \
  --header 'content-type: application/json' \
  --data '{"field1":"value1","field2":"value2"}'

{
    "description": "BMW Motorrad"
}

Response Example

{
    "url": "/api/v1/businessnumbers/501000000005013",
    "type": "businessnumber",
    "data": {
        "id": "501000000005013",
        "phonenumber": "9443789765",
        "phone_country_code": 91,
        "display_name": {
            "draft_name": "BMW",
            "status": "unverified"
        },
        "description": "BMW Motorrad"
    }
}

{
    "code": "invalid_input",
    "message": "Either the input stream or parameter is invalid or absent"
}

{
    "code": "username_exists",
    "message": "The requested username is already in use"
}

{
    "code": "username_change_limit_exceeded",
    "message": "The username change limit has been exceeded"
}

{
    "code": "invalid_oauthtoken",
    "message": "You are not authenticated to do this operation"
}

{
    "code": "not_found",
    "message": "The requested resource was not found"
}

{
    "code": "invalid_method",
    "message": "Invalid method"
}

Get a Business Number AI Tools

Open in ChatGPT

Open in ChatGPT to ask questions about this page

Open in Claude

Open in Claude to ask questions about this page

Copy as Markdown

Copy this page as markdown to use with AI assistants

View as Markdown

Open this page as markdown in a new tab

Retrieve the full details of a specific business number by its ID. Optionally include pinned miniapps.

Rate Limits

Threshold Limit (Number of API calls allowed within a minute) - 30 requests per minute
Lock Period (Wait time before consecutive API requests) - 10 minutes

OAuth Scope : ArattaiBusiness.phonenumbers.READ

Path Parameters

string

(Required)

Business number ID.

Query Parameters

include_fields

string

Comma-separated list of additional fields to include.
Allowed values: miniapps: Include pinned miniapps for the number (sorted by order).

Headers

Arattai-CompanyId

string

(Required)

The unique identifier of the company for this request.

Request Example

headers_data = Map();
headers_data.put("Arattai-CompanyId", "SOME_STRING_VALUE");
headers_data.put("Authorization", "Bearer REPLACE_BEARER_TOKEN");
response = invokeUrl
[
url: "https://business.arattai.in/api/v1/businessnumbers/BUSINESS_NUMBER_ID"
type: GET
headers: headers_data
connection: <connection_name>
];
info response;

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://business.arattai.in/api/v1/businessnumbers/BUSINESS_NUMBER_ID")
  .get()
  .addHeader("Arattai-CompanyId", "SOME_STRING_VALUE")
  .addHeader("Authorization", "Bearer REPLACE_BEARER_TOKEN")
  .build();

Response response = client.newCall(request).execute();

const options = {
  method: 'GET',
  headers: {
    'Arattai-CompanyId': 'SOME_STRING_VALUE',
    Authorization: 'Bearer REPLACE_BEARER_TOKEN'
  }
};

fetch('https://business.arattai.in/api/v1/businessnumbers/BUSINESS_NUMBER_ID', options)
  .then(response => response.json())
  .then(response => console.log(response))
  .catch(err => console.error(err));

import http.client

conn = http.client.HTTPSConnection("business.arattai.in")

headers = {
    'Arattai-CompanyId': "SOME_STRING_VALUE",
    'Authorization': "Bearer REPLACE_BEARER_TOKEN"
    }

conn.request("GET", "/api/v1/businessnumbers/BUSINESS_NUMBER_ID", headers=headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))

const http = require("https");

const options = {
  "method": "GET",
  "hostname": "business.arattai.in",
  "port": null,
  "path": "/api/v1/businessnumbers/BUSINESS_NUMBER_ID",
  "headers": {
    "Arattai-CompanyId": "SOME_STRING_VALUE",
    "Authorization": "Bearer REPLACE_BEARER_TOKEN"
  }
};

const req = http.request(options, function (res) {
  const chunks = [];

  res.on("data", function (chunk) {
    chunks.push(chunk);
  });

  res.on("end", function () {
    const body = Buffer.concat(chunks);
    console.log(body.toString());
  });
});

req.end();

var client = new RestClient("https://business.arattai.in/api/v1/businessnumbers/BUSINESS_NUMBER_ID");
var request = new RestRequest(Method.GET);
request.AddHeader("Arattai-CompanyId", "SOME_STRING_VALUE");
request.AddHeader("Authorization", "Bearer REPLACE_BEARER_TOKEN");
IRestResponse response = client.Execute(request);

var client = new HttpClient();
var request = new HttpRequestMessage
{
    Method = HttpMethod.Get,
    RequestUri = new Uri("https://business.arattai.in/api/v1/businessnumbers/BUSINESS_NUMBER_ID"),
    Headers =
    {
        { "Arattai-CompanyId", "SOME_STRING_VALUE" },
        { "Authorization", "Bearer REPLACE_BEARER_TOKEN" },
    },
};
using (var response = await client.SendAsync(request))
{
    response.EnsureSuccessStatusCode();
    var body = await response.Content.ReadAsStringAsync();
    Console.WriteLine(body);
}

package main

import (
	"fmt"
	"net/http"
	"io/ioutil"
)

func main() {

	url := "https://business.arattai.in/api/v1/businessnumbers/BUSINESS_NUMBER_ID"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Arattai-CompanyId", "SOME_STRING_VALUE")
	req.Header.Add("Authorization", "Bearer REPLACE_BEARER_TOKEN")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}

const data = null;

const xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://business.arattai.in/api/v1/businessnumbers/BUSINESS_NUMBER_ID");
xhr.setRequestHeader("Arattai-CompanyId", "SOME_STRING_VALUE");
xhr.setRequestHeader("Authorization", "Bearer REPLACE_BEARER_TOKEN");

xhr.send(data);

curl --request GET \
  --url https://business.arattai.in/api/v1/businessnumbers/BUSINESS_NUMBER_ID \
  --header 'Arattai-CompanyId: SOME_STRING_VALUE' \
  --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'

Response Example

{
    "url": "/api/v1/businessnumbers/501000000005013",
    "type": "businessnumber",
    "data": {
        "id": "501000000005013",
        "phonenumber": "9443789765",
        "phone_country_code": 91,
        "user_name": "BMW",
        "display_name": {
            "published_name": "BMW Motorrad",
            "draft_name": "BMW",
            "status": "verified"
        },
        "full_phonenumber": "+919443789765",
        "business": {
            "id": "1K3M5X2",
            "name": "BMW",
            "status": "verified"
        },
        "created_time": "1769489125588",
        "modified_time": "1769489125588"
    }
}

{
    "code": "invalid_input",
    "message": "Either the input stream or parameter is invalid or absent"
}

{
    "code": "invalid_oauthtoken",
    "message": "You are not authenticated to do this operation"
}

{
    "code": "not_found",
    "message": "The requested resource was not found"
}

{
    "code": "invalid_method",
    "message": "Invalid method"
}

Delete a Business Number AI Tools

Open in ChatGPT

Open in ChatGPT to ask questions about this page

Open in Claude

Open in Claude to ask questions about this page

Copy as Markdown

Copy this page as markdown to use with AI assistants

View as Markdown

Open this page as markdown in a new tab

Soft-delete a business number. Deletion sequence:

Arattai automation is torn down first. If this call fails, the deletion is aborted with an error.
The business number is soft-deleted in the DB. The record is retained for audit and will not appear in any list or GET responses.
An admin event is pushed to notify downstream systems. MQ failure is non-fatal; the deletion is still considered successful.

Rate Limits

Threshold Limit (Number of API calls allowed within a minute) - 10 requests per minute
Lock Period (Wait time before consecutive API requests) - 10 minutes

OAuth Scope : ArattaiBusiness.phonenumbers.DELETE

Path Parameters

string

(Required)

Business number ID.

Headers

Arattai-CompanyId

string

(Required)

The unique identifier of the company for this request.

Request Example

headers_data = Map();
headers_data.put("Arattai-CompanyId", "SOME_STRING_VALUE");
headers_data.put("Authorization", "Bearer REPLACE_BEARER_TOKEN");
response = invokeUrl
[
url: "https://business.arattai.in/api/v1/businessnumbers/BUSINESS_NUMBER_ID"
type: DELETE
headers: headers_data
connection: <connection_name>
];
info response;

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://business.arattai.in/api/v1/businessnumbers/BUSINESS_NUMBER_ID")
  .delete(null)
  .addHeader("Arattai-CompanyId", "SOME_STRING_VALUE")
  .addHeader("Authorization", "Bearer REPLACE_BEARER_TOKEN")
  .build();

Response response = client.newCall(request).execute();

const options = {
  method: 'DELETE',
  headers: {
    'Arattai-CompanyId': 'SOME_STRING_VALUE',
    Authorization: 'Bearer REPLACE_BEARER_TOKEN'
  }
};

fetch('https://business.arattai.in/api/v1/businessnumbers/BUSINESS_NUMBER_ID', options)
  .then(response => response.json())
  .then(response => console.log(response))
  .catch(err => console.error(err));

import http.client

conn = http.client.HTTPSConnection("business.arattai.in")

headers = {
    'Arattai-CompanyId': "SOME_STRING_VALUE",
    'Authorization': "Bearer REPLACE_BEARER_TOKEN"
    }

conn.request("DELETE", "/api/v1/businessnumbers/BUSINESS_NUMBER_ID", headers=headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))

const http = require("https");

const options = {
  "method": "DELETE",
  "hostname": "business.arattai.in",
  "port": null,
  "path": "/api/v1/businessnumbers/BUSINESS_NUMBER_ID",
  "headers": {
    "Arattai-CompanyId": "SOME_STRING_VALUE",
    "Authorization": "Bearer REPLACE_BEARER_TOKEN"
  }
};

const req = http.request(options, function (res) {
  const chunks = [];

  res.on("data", function (chunk) {
    chunks.push(chunk);
  });

  res.on("end", function () {
    const body = Buffer.concat(chunks);
    console.log(body.toString());
  });
});

req.end();

var client = new RestClient("https://business.arattai.in/api/v1/businessnumbers/BUSINESS_NUMBER_ID");
var request = new RestRequest(Method.DELETE);
request.AddHeader("Arattai-CompanyId", "SOME_STRING_VALUE");
request.AddHeader("Authorization", "Bearer REPLACE_BEARER_TOKEN");
IRestResponse response = client.Execute(request);

var client = new HttpClient();
var request = new HttpRequestMessage
{
    Method = HttpMethod.Delete,
    RequestUri = new Uri("https://business.arattai.in/api/v1/businessnumbers/BUSINESS_NUMBER_ID"),
    Headers =
    {
        { "Arattai-CompanyId", "SOME_STRING_VALUE" },
        { "Authorization", "Bearer REPLACE_BEARER_TOKEN" },
    },
};
using (var response = await client.SendAsync(request))
{
    response.EnsureSuccessStatusCode();
    var body = await response.Content.ReadAsStringAsync();
    Console.WriteLine(body);
}

package main

import (
	"fmt"
	"net/http"
	"io/ioutil"
)

func main() {

	url := "https://business.arattai.in/api/v1/businessnumbers/BUSINESS_NUMBER_ID"

	req, _ := http.NewRequest("DELETE", url, nil)

	req.Header.Add("Arattai-CompanyId", "SOME_STRING_VALUE")
	req.Header.Add("Authorization", "Bearer REPLACE_BEARER_TOKEN")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}

const data = null;

const xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("DELETE", "https://business.arattai.in/api/v1/businessnumbers/BUSINESS_NUMBER_ID");
xhr.setRequestHeader("Arattai-CompanyId", "SOME_STRING_VALUE");
xhr.setRequestHeader("Authorization", "Bearer REPLACE_BEARER_TOKEN");

xhr.send(data);

curl --request DELETE \
  --url https://business.arattai.in/api/v1/businessnumbers/BUSINESS_NUMBER_ID \
  --header 'Arattai-CompanyId: SOME_STRING_VALUE' \
  --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'

Response Example

{
    "code": "invalid_input",
    "message": "Either the input stream or parameter is invalid or absent"
}

{
    "code": "invalid_oauthtoken",
    "message": "You are not authenticated to do this operation"
}

{
    "code": "not_found",
    "message": "The requested resource was not found"
}

{
    "code": "invalid_method",
    "message": "Invalid method"
}

{
    "code": "operation_failed",
    "message": "Unable to process your request, try again later"
}

List all Business Numbers AI Tools

Open in ChatGPT

Open in ChatGPT to ask questions about this page

Open in Claude

Open in Claude to ask questions about this page

Copy as Markdown

Copy this page as markdown to use with AI assistants

View as Markdown

Open this page as markdown in a new tab

Get all business numbers across all businesses with optional filters.

Rate Limits

Threshold Limit (Number of API calls allowed within a minute) - 60 requests per minute
Lock Period (Wait time before consecutive API requests) - 5 minutes

OAuth Scope : ArattaiBusiness.phonenumbers.READ

Query Parameters

businesses

string

Comma-separated business IDs to filter (e.g. "123,456,789").

include_fields

string

Comma-separated list of additional fields to include.
Allowed values: miniapps: Include pinned miniapps for each business number (sorted by order).

Headers

Arattai-CompanyId

string

(Required)

The unique identifier of the company for this request.

Request Example

headers_data = Map();
headers_data.put("Arattai-CompanyId", "SOME_STRING_VALUE");
headers_data.put("Authorization", "Bearer REPLACE_BEARER_TOKEN");
response = invokeUrl
[
url: "https://business.arattai.in/api/v1/businessnumbers"
type: GET
headers: headers_data
connection: <connection_name>
];
info response;

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://business.arattai.in/api/v1/businessnumbers")
  .get()
  .addHeader("Arattai-CompanyId", "SOME_STRING_VALUE")
  .addHeader("Authorization", "Bearer REPLACE_BEARER_TOKEN")
  .build();

Response response = client.newCall(request).execute();

const options = {
  method: 'GET',
  headers: {
    'Arattai-CompanyId': 'SOME_STRING_VALUE',
    Authorization: 'Bearer REPLACE_BEARER_TOKEN'
  }
};

fetch('https://business.arattai.in/api/v1/businessnumbers', options)
  .then(response => response.json())
  .then(response => console.log(response))
  .catch(err => console.error(err));

import http.client

conn = http.client.HTTPSConnection("business.arattai.in")

headers = {
    'Arattai-CompanyId': "SOME_STRING_VALUE",
    'Authorization': "Bearer REPLACE_BEARER_TOKEN"
    }

conn.request("GET", "/api/v1/businessnumbers", headers=headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))

const http = require("https");

const options = {
  "method": "GET",
  "hostname": "business.arattai.in",
  "port": null,
  "path": "/api/v1/businessnumbers",
  "headers": {
    "Arattai-CompanyId": "SOME_STRING_VALUE",
    "Authorization": "Bearer REPLACE_BEARER_TOKEN"
  }
};

const req = http.request(options, function (res) {
  const chunks = [];

  res.on("data", function (chunk) {
    chunks.push(chunk);
  });

  res.on("end", function () {
    const body = Buffer.concat(chunks);
    console.log(body.toString());
  });
});

req.end();

var client = new RestClient("https://business.arattai.in/api/v1/businessnumbers");
var request = new RestRequest(Method.GET);
request.AddHeader("Arattai-CompanyId", "SOME_STRING_VALUE");
request.AddHeader("Authorization", "Bearer REPLACE_BEARER_TOKEN");
IRestResponse response = client.Execute(request);

var client = new HttpClient();
var request = new HttpRequestMessage
{
    Method = HttpMethod.Get,
    RequestUri = new Uri("https://business.arattai.in/api/v1/businessnumbers"),
    Headers =
    {
        { "Arattai-CompanyId", "SOME_STRING_VALUE" },
        { "Authorization", "Bearer REPLACE_BEARER_TOKEN" },
    },
};
using (var response = await client.SendAsync(request))
{
    response.EnsureSuccessStatusCode();
    var body = await response.Content.ReadAsStringAsync();
    Console.WriteLine(body);
}

package main

import (
	"fmt"
	"net/http"
	"io/ioutil"
)

func main() {

	url := "https://business.arattai.in/api/v1/businessnumbers"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Arattai-CompanyId", "SOME_STRING_VALUE")
	req.Header.Add("Authorization", "Bearer REPLACE_BEARER_TOKEN")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}

const data = null;

const xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://business.arattai.in/api/v1/businessnumbers");
xhr.setRequestHeader("Arattai-CompanyId", "SOME_STRING_VALUE");
xhr.setRequestHeader("Authorization", "Bearer REPLACE_BEARER_TOKEN");

xhr.send(data);

curl --request GET \
  --url https://business.arattai.in/api/v1/businessnumbers \
  --header 'Arattai-CompanyId: SOME_STRING_VALUE' \
  --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'

Response Example

{
    "url": "/api/v1/businessnumbers",
    "type": "businessnumbers",
    "data": [
        {
            "id": "501000000005013",
            "phonenumber": "9443789765",
            "phone_country_code": 91,
            "display_name": {
                "published_name": "BMW Motorrad",
                "status": "verified"
            },
            "business": {
                "id": "1K3M5X2",
                "name": "BMW",
                "status": "verified"
            }
        }
    ]
}

{
    "code": "invalid_input",
    "message": "Either the input stream or parameter is invalid or absent"
}

{
    "code": "invalid_oauthtoken",
    "message": "You are not authenticated to do this operation"
}

{
    "code": "invalid_method",
    "message": "Invalid method"
}

List Business Numbers for a Business AI Tools

Open in ChatGPT

Open in ChatGPT to ask questions about this page

Open in Claude

Open in Claude to ask questions about this page

Copy as Markdown

Copy this page as markdown to use with AI assistants

View as Markdown

Open this page as markdown in a new tab

Get all business numbers for a specific business.

Rate Limits

Threshold Limit (Number of API calls allowed within a minute) - 60 requests per minute
Lock Period (Wait time before consecutive API requests) - 5 minutes

OAuth Scope : ArattaiBusiness.phonenumbers.READ

Path Parameters

string

(Required)

Business ID.

Query Parameters

include_fields

string

Comma-separated list of additional fields to include.
Allowed values: miniapps: Include pinned miniapps for each business number (sorted by order).

Headers

Arattai-CompanyId

string

(Required)

The unique identifier of the company for this request.

Request Example

headers_data = Map();
headers_data.put("Arattai-CompanyId", "SOME_STRING_VALUE");
headers_data.put("Authorization", "Bearer REPLACE_BEARER_TOKEN");
response = invokeUrl
[
url: "https://business.arattai.in/api/v1/businesses/BUSINESS_NUMBER_ID/businessnumbers"
type: GET
headers: headers_data
connection: <connection_name>
];
info response;

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://business.arattai.in/api/v1/businesses/BUSINESS_NUMBER_ID/businessnumbers")
  .get()
  .addHeader("Arattai-CompanyId", "SOME_STRING_VALUE")
  .addHeader("Authorization", "Bearer REPLACE_BEARER_TOKEN")
  .build();

Response response = client.newCall(request).execute();

const options = {
  method: 'GET',
  headers: {
    'Arattai-CompanyId': 'SOME_STRING_VALUE',
    Authorization: 'Bearer REPLACE_BEARER_TOKEN'
  }
};

fetch('https://business.arattai.in/api/v1/businesses/BUSINESS_NUMBER_ID/businessnumbers', options)
  .then(response => response.json())
  .then(response => console.log(response))
  .catch(err => console.error(err));

import http.client

conn = http.client.HTTPSConnection("business.arattai.in")

headers = {
    'Arattai-CompanyId': "SOME_STRING_VALUE",
    'Authorization': "Bearer REPLACE_BEARER_TOKEN"
    }

conn.request("GET", "/api/v1/businesses/BUSINESS_NUMBER_ID/businessnumbers", headers=headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))

const http = require("https");

const options = {
  "method": "GET",
  "hostname": "business.arattai.in",
  "port": null,
  "path": "/api/v1/businesses/BUSINESS_NUMBER_ID/businessnumbers",
  "headers": {
    "Arattai-CompanyId": "SOME_STRING_VALUE",
    "Authorization": "Bearer REPLACE_BEARER_TOKEN"
  }
};

const req = http.request(options, function (res) {
  const chunks = [];

  res.on("data", function (chunk) {
    chunks.push(chunk);
  });

  res.on("end", function () {
    const body = Buffer.concat(chunks);
    console.log(body.toString());
  });
});

req.end();

var client = new RestClient("https://business.arattai.in/api/v1/businesses/BUSINESS_NUMBER_ID/businessnumbers");
var request = new RestRequest(Method.GET);
request.AddHeader("Arattai-CompanyId", "SOME_STRING_VALUE");
request.AddHeader("Authorization", "Bearer REPLACE_BEARER_TOKEN");
IRestResponse response = client.Execute(request);

var client = new HttpClient();
var request = new HttpRequestMessage
{
    Method = HttpMethod.Get,
    RequestUri = new Uri("https://business.arattai.in/api/v1/businesses/BUSINESS_NUMBER_ID/businessnumbers"),
    Headers =
    {
        { "Arattai-CompanyId", "SOME_STRING_VALUE" },
        { "Authorization", "Bearer REPLACE_BEARER_TOKEN" },
    },
};
using (var response = await client.SendAsync(request))
{
    response.EnsureSuccessStatusCode();
    var body = await response.Content.ReadAsStringAsync();
    Console.WriteLine(body);
}

package main

import (
	"fmt"
	"net/http"
	"io/ioutil"
)

func main() {

	url := "https://business.arattai.in/api/v1/businesses/BUSINESS_NUMBER_ID/businessnumbers"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Arattai-CompanyId", "SOME_STRING_VALUE")
	req.Header.Add("Authorization", "Bearer REPLACE_BEARER_TOKEN")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}

const data = null;

const xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://business.arattai.in/api/v1/businesses/BUSINESS_NUMBER_ID/businessnumbers");
xhr.setRequestHeader("Arattai-CompanyId", "SOME_STRING_VALUE");
xhr.setRequestHeader("Authorization", "Bearer REPLACE_BEARER_TOKEN");

xhr.send(data);

curl --request GET \
  --url https://business.arattai.in/api/v1/businesses/BUSINESS_NUMBER_ID/businessnumbers \
  --header 'Arattai-CompanyId: SOME_STRING_VALUE' \
  --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'

Response Example

{
    "url": "/api/v1/businesses/501000000003001/businessnumbers",
    "type": "businessnumbers",
    "data": [
        {
            "id": "501000000005013",
            "phonenumber": "9443789765",
            "phone_country_code": 91,
            "display_name": {
                "published_name": "BMW Motorrad",
                "status": "verified"
            },
            "business": {
                "id": "1K3M5X2",
                "name": "BMW",
                "status": "verified"
            }
        }
    ]
}

{
    "code": "invalid_input",
    "message": "Either the input stream or parameter is invalid or absent"
}

{
    "code": "invalid_oauthtoken",
    "message": "You are not authenticated to do this operation"
}

{
    "code": "invalid_method",
    "message": "Invalid method"
}

Upload Business Number Logo AI Tools

Open in ChatGPT

Open in ChatGPT to ask questions about this page

Open in Claude

Open in Claude to ask questions about this page

Copy as Markdown

Copy this page as markdown to use with AI assistants

View as Markdown

Open this page as markdown in a new tab

Upload a logo image for a business number. The uploaded logo is stored and a logo URL is returned, which can be used to download the logo via the GET /businessnumberlogo/{base64Encoded} endpoint.

⚠

NoteThere is no GET /businessnumbers/{id}/logo route. Always use the logo_url returned by the upload endpoint.

Rate Limits

Threshold Limit (Number of API calls allowed within a minute) - 10 requests per minute
Lock Period (Wait time before consecutive API requests) - 10 minutes

OAuth Scope : ArattaiBusiness.phonenumbers.CREATE

Arguments

file

binary

(Required)

Image file to upload. Maximum 10 MB. Supported formats - jpeg, jpg, png, avif, webp.

Path Parameters

string

(Required)

Business number ID.

Headers

Arattai-CompanyId

string

(Required)

The unique identifier of the company for this request.

Request Example

parameters_data = Map();
parameters_data.put("field1", "value1")
parameters_data.put("field2", "value2")
headers_data = Map();
headers_data.put("Arattai-CompanyId", "SOME_STRING_VALUE");
headers_data.put("Authorization", "Bearer REPLACE_BEARER_TOKEN");
response = invokeUrl
[
url: "https://business.arattai.in/api/v1/businessnumbers/BUSINESS_NUMBER_ID/logo"
type: POST
headers: headers_data
parameters: parameters_data
connection: <connection_name>
];
info response;

OkHttpClient client = new OkHttpClient();

MediaType mediaType = MediaType.parse("multipart/form-data; boundary=---011000010111000001101001");
RequestBody body = RequestBody.create(mediaType, "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"field1\"\r\n\r\nvalue1\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"field2\"\r\n\r\nvalue2\r\n-----011000010111000001101001--\r\n");
Request request = new Request.Builder()
  .url("https://business.arattai.in/api/v1/businessnumbers/BUSINESS_NUMBER_ID/logo")
  .post(body)
  .addHeader("Arattai-CompanyId", "SOME_STRING_VALUE")
  .addHeader("Authorization", "Bearer REPLACE_BEARER_TOKEN")
  .addHeader("content-type", "multipart/form-data; boundary=---011000010111000001101001")
  .build();

Response response = client.newCall(request).execute();

const form = new FormData();
form.append("field1", "value1");
form.append("field2", "value2");

const options = {
  method: 'POST',
  headers: {
    'Arattai-CompanyId': 'SOME_STRING_VALUE',
    Authorization: 'Bearer REPLACE_BEARER_TOKEN',
    'content-type': 'multipart/form-data; boundary=---011000010111000001101001'
  }
};

options.body = form;

fetch('https://business.arattai.in/api/v1/businessnumbers/BUSINESS_NUMBER_ID/logo', options)
  .then(response => response.json())
  .then(response => console.log(response))
  .catch(err => console.error(err));

import http.client

conn = http.client.HTTPSConnection("business.arattai.in")

payload = "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"field1\"\r\n\r\nvalue1\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"field2\"\r\n\r\nvalue2\r\n-----011000010111000001101001--\r\n"

headers = {
    'Arattai-CompanyId': "SOME_STRING_VALUE",
    'Authorization': "Bearer REPLACE_BEARER_TOKEN",
    'content-type': "multipart/form-data; boundary=---011000010111000001101001"
    }

conn.request("POST", "/api/v1/businessnumbers/BUSINESS_NUMBER_ID/logo", payload, headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))

const http = require("https");

const options = {
  "method": "POST",
  "hostname": "business.arattai.in",
  "port": null,
  "path": "/api/v1/businessnumbers/BUSINESS_NUMBER_ID/logo",
  "headers": {
    "Arattai-CompanyId": "SOME_STRING_VALUE",
    "Authorization": "Bearer REPLACE_BEARER_TOKEN",
    "content-type": "multipart/form-data; boundary=---011000010111000001101001"
  }
};

const req = http.request(options, function (res) {
  const chunks = [];

  res.on("data", function (chunk) {
    chunks.push(chunk);
  });

  res.on("end", function () {
    const body = Buffer.concat(chunks);
    console.log(body.toString());
  });
});

req.write("-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"field1\"\r\n\r\nvalue1\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"field2\"\r\n\r\nvalue2\r\n-----011000010111000001101001--\r\n");
req.end();

var client = new RestClient("https://business.arattai.in/api/v1/businessnumbers/BUSINESS_NUMBER_ID/logo");
var request = new RestRequest(Method.POST);
request.AddHeader("Arattai-CompanyId", "SOME_STRING_VALUE");
request.AddHeader("Authorization", "Bearer REPLACE_BEARER_TOKEN");
request.AddHeader("content-type", "multipart/form-data; boundary=---011000010111000001101001");
request.AddParameter("multipart/form-data; boundary=---011000010111000001101001", "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"field1\"\r\n\r\nvalue1\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"field2\"\r\n\r\nvalue2\r\n-----011000010111000001101001--\r\n", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);

var client = new HttpClient();
var request = new HttpRequestMessage
{
    Method = HttpMethod.Post,
    RequestUri = new Uri("https://business.arattai.in/api/v1/businessnumbers/BUSINESS_NUMBER_ID/logo"),
    Headers =
    {
        { "Arattai-CompanyId", "SOME_STRING_VALUE" },
        { "Authorization", "Bearer REPLACE_BEARER_TOKEN" },
    },
    Content = new MultipartFormDataContent
    {
        new StringContent("value1")
        {
            Headers =
            {
                ContentDisposition = new ContentDispositionHeaderValue("form-data")
                {
                    Name = "field1",
                }
            }
        },
        new StringContent("value2")
        {
            Headers =
            {
                ContentDisposition = new ContentDispositionHeaderValue("form-data")
                {
                    Name = "field2",
                }
            }
        },
    },
};
using (var response = await client.SendAsync(request))
{
    response.EnsureSuccessStatusCode();
    var body = await response.Content.ReadAsStringAsync();
    Console.WriteLine(body);
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io/ioutil"
)

func main() {

	url := "https://business.arattai.in/api/v1/businessnumbers/BUSINESS_NUMBER_ID/logo"

	payload := strings.NewReader("-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"field1\"\r\n\r\nvalue1\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"field2\"\r\n\r\nvalue2\r\n-----011000010111000001101001--\r\n")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Arattai-CompanyId", "SOME_STRING_VALUE")
	req.Header.Add("Authorization", "Bearer REPLACE_BEARER_TOKEN")
	req.Header.Add("content-type", "multipart/form-data; boundary=---011000010111000001101001")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}

const data = new FormData();
data.append("field1", "value1");
data.append("field2", "value2");

const xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("POST", "https://business.arattai.in/api/v1/businessnumbers/BUSINESS_NUMBER_ID/logo");
xhr.setRequestHeader("Arattai-CompanyId", "SOME_STRING_VALUE");
xhr.setRequestHeader("Authorization", "Bearer REPLACE_BEARER_TOKEN");

xhr.send(data);

curl --request POST \
  --url https://business.arattai.in/api/v1/businessnumbers/BUSINESS_NUMBER_ID/logo \
  --header 'Arattai-CompanyId: SOME_STRING_VALUE' \
  --header 'Authorization: Bearer REPLACE_BEARER_TOKEN' \
  --header 'content-type: multipart/form-data' \
  --form field1=value1 \
  --form field2=value2

{
    "file": "<binary image file>"
}

Response Example

{
    "logo_url": "/api/v1/businessnumberlogo/YWJjMTIzZGVmNDU2"
}

{
    "code": "invalid_file_type",
    "message": "The uploaded file type is not allowed"
}

{
    "code": "invalid_input",
    "message": "Either the input stream or parameter is invalid or absent"
}

{
    "code": "invalid_oauthtoken",
    "message": "You are not authenticated to do this operation"
}

{
    "code": "invalid_method",
    "message": "Invalid method"
}

{
    "code": "file_size_too_large",
    "message": "The uploaded file exceeds the maximum allowed size"
}

Delete Business Number Logo AI Tools

Open in ChatGPT

Open in ChatGPT to ask questions about this page

Open in Claude

Open in Claude to ask questions about this page

Copy as Markdown

Copy this page as markdown to use with AI assistants

View as Markdown

Open this page as markdown in a new tab

Remove the logo associated with a business number.

Rate Limits

Threshold Limit (Number of API calls allowed within a minute) - 10 requests per minute
Lock Period (Wait time before consecutive API requests) - 10 minutes

OAuth Scope : ArattaiBusiness.phonenumbers.DELETE

Path Parameters

string

(Required)

Business number ID.

Headers

Arattai-CompanyId

string

(Required)

The unique identifier of the company for this request.

Request Example

headers_data = Map();
headers_data.put("Arattai-CompanyId", "SOME_STRING_VALUE");
headers_data.put("Authorization", "Bearer REPLACE_BEARER_TOKEN");
response = invokeUrl
[
url: "https://business.arattai.in/api/v1/businessnumbers/BUSINESS_NUMBER_ID/logo"
type: DELETE
headers: headers_data
connection: <connection_name>
];
info response;

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://business.arattai.in/api/v1/businessnumbers/BUSINESS_NUMBER_ID/logo")
  .delete(null)
  .addHeader("Arattai-CompanyId", "SOME_STRING_VALUE")
  .addHeader("Authorization", "Bearer REPLACE_BEARER_TOKEN")
  .build();

Response response = client.newCall(request).execute();

const options = {
  method: 'DELETE',
  headers: {
    'Arattai-CompanyId': 'SOME_STRING_VALUE',
    Authorization: 'Bearer REPLACE_BEARER_TOKEN'
  }
};

fetch('https://business.arattai.in/api/v1/businessnumbers/BUSINESS_NUMBER_ID/logo', options)
  .then(response => response.json())
  .then(response => console.log(response))
  .catch(err => console.error(err));

import http.client

conn = http.client.HTTPSConnection("business.arattai.in")

headers = {
    'Arattai-CompanyId': "SOME_STRING_VALUE",
    'Authorization': "Bearer REPLACE_BEARER_TOKEN"
    }

conn.request("DELETE", "/api/v1/businessnumbers/BUSINESS_NUMBER_ID/logo", headers=headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))

const http = require("https");

const options = {
  "method": "DELETE",
  "hostname": "business.arattai.in",
  "port": null,
  "path": "/api/v1/businessnumbers/BUSINESS_NUMBER_ID/logo",
  "headers": {
    "Arattai-CompanyId": "SOME_STRING_VALUE",
    "Authorization": "Bearer REPLACE_BEARER_TOKEN"
  }
};

const req = http.request(options, function (res) {
  const chunks = [];

  res.on("data", function (chunk) {
    chunks.push(chunk);
  });

  res.on("end", function () {
    const body = Buffer.concat(chunks);
    console.log(body.toString());
  });
});

req.end();

var client = new RestClient("https://business.arattai.in/api/v1/businessnumbers/BUSINESS_NUMBER_ID/logo");
var request = new RestRequest(Method.DELETE);
request.AddHeader("Arattai-CompanyId", "SOME_STRING_VALUE");
request.AddHeader("Authorization", "Bearer REPLACE_BEARER_TOKEN");
IRestResponse response = client.Execute(request);

var client = new HttpClient();
var request = new HttpRequestMessage
{
    Method = HttpMethod.Delete,
    RequestUri = new Uri("https://business.arattai.in/api/v1/businessnumbers/BUSINESS_NUMBER_ID/logo"),
    Headers =
    {
        { "Arattai-CompanyId", "SOME_STRING_VALUE" },
        { "Authorization", "Bearer REPLACE_BEARER_TOKEN" },
    },
};
using (var response = await client.SendAsync(request))
{
    response.EnsureSuccessStatusCode();
    var body = await response.Content.ReadAsStringAsync();
    Console.WriteLine(body);
}

package main

import (
	"fmt"
	"net/http"
	"io/ioutil"
)

func main() {

	url := "https://business.arattai.in/api/v1/businessnumbers/BUSINESS_NUMBER_ID/logo"

	req, _ := http.NewRequest("DELETE", url, nil)

	req.Header.Add("Arattai-CompanyId", "SOME_STRING_VALUE")
	req.Header.Add("Authorization", "Bearer REPLACE_BEARER_TOKEN")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}

const data = null;

const xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("DELETE", "https://business.arattai.in/api/v1/businessnumbers/BUSINESS_NUMBER_ID/logo");
xhr.setRequestHeader("Arattai-CompanyId", "SOME_STRING_VALUE");
xhr.setRequestHeader("Authorization", "Bearer REPLACE_BEARER_TOKEN");

xhr.send(data);

curl --request DELETE \
  --url https://business.arattai.in/api/v1/businessnumbers/BUSINESS_NUMBER_ID/logo \
  --header 'Arattai-CompanyId: SOME_STRING_VALUE' \
  --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'

Response Example

{
    "code": "invalid_input",
    "message": "Either the input stream or parameter is invalid or absent"
}

{
    "code": "invalid_oauthtoken",
    "message": "You are not authenticated to do this operation"
}

{
    "code": "invalid_method",
    "message": "Invalid method"
}

Download Business Number Logo AI Tools

Open in ChatGPT

Open in ChatGPT to ask questions about this page

Open in Claude

Open in Claude to ask questions about this page

Copy as Markdown

Copy this page as markdown to use with AI assistants

View as Markdown

Open this page as markdown in a new tab

Download the business number logo as a binary image stream. The {base64Encoded} token is the path segment returned in the logo_url field of the POST /businessnumbers/{id}/logo response.

⚠

NoteArattai-CompanyId is not required for direct logo access. There is no GET /businessnumbers/{id}/logo convenience endpoint. Always use the logo_url returned by the upload endpoint.

Rate Limits

Threshold Limit (Number of API calls allowed within a minute) - 30 requests per minute
Lock Period (Wait time before consecutive API requests) - 5 minutes

- businessnumbers
OAuth Scope : ArattaiBusiness.phonenumbers.READ

Path Parameters

base64Encoded

string

(Required)

The base64-encoded token from the logo_url field returned by the upload logo endpoint.

Request Example

headers_data = Map();
headers_data.put("Authorization", "Bearer REPLACE_BEARER_TOKEN");
response = invokeUrl
[
url: "https://business.arattai.in/api/v1/businessnumberlogo/YWJjMTIzZGVmNDU2"
type: GET
headers: headers_data
connection: <connection_name>
];
info response;

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://business.arattai.in/api/v1/businessnumberlogo/YWJjMTIzZGVmNDU2")
  .get()
  .addHeader("Authorization", "Bearer REPLACE_BEARER_TOKEN")
  .build();

Response response = client.newCall(request).execute();

const options = {method: 'GET', headers: {Authorization: 'Bearer REPLACE_BEARER_TOKEN'}};

fetch('https://business.arattai.in/api/v1/businessnumberlogo/YWJjMTIzZGVmNDU2', options)
  .then(response => response.json())
  .then(response => console.log(response))
  .catch(err => console.error(err));

import http.client

conn = http.client.HTTPSConnection("business.arattai.in")

headers = { 'Authorization': "Bearer REPLACE_BEARER_TOKEN" }

conn.request("GET", "/api/v1/businessnumberlogo/YWJjMTIzZGVmNDU2", headers=headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))

const http = require("https");

const options = {
  "method": "GET",
  "hostname": "business.arattai.in",
  "port": null,
  "path": "/api/v1/businessnumberlogo/YWJjMTIzZGVmNDU2",
  "headers": {
    "Authorization": "Bearer REPLACE_BEARER_TOKEN"
  }
};

const req = http.request(options, function (res) {
  const chunks = [];

  res.on("data", function (chunk) {
    chunks.push(chunk);
  });

  res.on("end", function () {
    const body = Buffer.concat(chunks);
    console.log(body.toString());
  });
});

req.end();

var client = new RestClient("https://business.arattai.in/api/v1/businessnumberlogo/YWJjMTIzZGVmNDU2");
var request = new RestRequest(Method.GET);
request.AddHeader("Authorization", "Bearer REPLACE_BEARER_TOKEN");
IRestResponse response = client.Execute(request);

var client = new HttpClient();
var request = new HttpRequestMessage
{
    Method = HttpMethod.Get,
    RequestUri = new Uri("https://business.arattai.in/api/v1/businessnumberlogo/YWJjMTIzZGVmNDU2"),
    Headers =
    {
        { "Authorization", "Bearer REPLACE_BEARER_TOKEN" },
    },
};
using (var response = await client.SendAsync(request))
{
    response.EnsureSuccessStatusCode();
    var body = await response.Content.ReadAsStringAsync();
    Console.WriteLine(body);
}

package main

import (
	"fmt"
	"net/http"
	"io/ioutil"
)

func main() {

	url := "https://business.arattai.in/api/v1/businessnumberlogo/YWJjMTIzZGVmNDU2"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer REPLACE_BEARER_TOKEN")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}

const data = null;

const xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://business.arattai.in/api/v1/businessnumberlogo/YWJjMTIzZGVmNDU2");
xhr.setRequestHeader("Authorization", "Bearer REPLACE_BEARER_TOKEN");

xhr.send(data);

curl --request GET \
  --url https://business.arattai.in/api/v1/businessnumberlogo/YWJjMTIzZGVmNDU2 \
  --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'

Response Example

{
    "code": "invalid_input",
    "message": "Either the input stream or parameter is invalid or absent"
}

{
    "code": "invalid_oauthtoken",
    "message": "You are not authenticated to do this operation"
}

{
    "code": "not_found",
    "message": "The requested resource was not found"
}

{
    "code": "invalid_method",
    "message": "Invalid method"
}

Check Phone Number in Arattai AI Tools

Open in ChatGPT

Open in ChatGPT to ask questions about this page

Open in Claude

Open in Claude to ask questions about this page

Copy as Markdown

Copy this page as markdown to use with AI assistants

View as Markdown

Open this page as markdown in a new tab

Check if a phone number has an Arattai account. Used as the first step in the "Add Phone Number" flow to determine if the user already has an account before invoking OTP validation.

Path parameter format: countryCode-nationalNumber (e.g. 91-9876543210). No leading + sign.

Typical flow: Call this first to check for an existing Arattai account. Then call GET /phonenumbers/{phoneNumber} to check bot-member status. Proceed with OTP verification regardless.

Rate Limits

Threshold Limit (Number of API calls allowed within a minute) - 10 requests per minute
Lock Period (Wait time before consecutive API requests) - 10 minutes

OAuth Scope : ArattaiBusiness.phonenumbers.READ

Path Parameters

phoneNumber

string

(Required)

Phone number in countryCode-nationalNumber format (e.g. 91-9876543210). No leading + sign.

Headers

Arattai-CompanyId

string

(Required)

The unique identifier of the company for this request.

Request Example

headers_data = Map();
headers_data.put("Arattai-CompanyId", "SOME_STRING_VALUE");
headers_data.put("Authorization", "Bearer REPLACE_BEARER_TOKEN");
response = invokeUrl
[
url: "https://business.arattai.in/api/v1/arattaiphonenumbers/91-9876543210"
type: GET
headers: headers_data
connection: <connection_name>
];
info response;

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://business.arattai.in/api/v1/arattaiphonenumbers/91-9876543210")
  .get()
  .addHeader("Arattai-CompanyId", "SOME_STRING_VALUE")
  .addHeader("Authorization", "Bearer REPLACE_BEARER_TOKEN")
  .build();

Response response = client.newCall(request).execute();

const options = {
  method: 'GET',
  headers: {
    'Arattai-CompanyId': 'SOME_STRING_VALUE',
    Authorization: 'Bearer REPLACE_BEARER_TOKEN'
  }
};

fetch('https://business.arattai.in/api/v1/arattaiphonenumbers/91-9876543210', options)
  .then(response => response.json())
  .then(response => console.log(response))
  .catch(err => console.error(err));

import http.client

conn = http.client.HTTPSConnection("business.arattai.in")

headers = {
    'Arattai-CompanyId': "SOME_STRING_VALUE",
    'Authorization': "Bearer REPLACE_BEARER_TOKEN"
    }

conn.request("GET", "/api/v1/arattaiphonenumbers/91-9876543210", headers=headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))

const http = require("https");

const options = {
  "method": "GET",
  "hostname": "business.arattai.in",
  "port": null,
  "path": "/api/v1/arattaiphonenumbers/91-9876543210",
  "headers": {
    "Arattai-CompanyId": "SOME_STRING_VALUE",
    "Authorization": "Bearer REPLACE_BEARER_TOKEN"
  }
};

const req = http.request(options, function (res) {
  const chunks = [];

  res.on("data", function (chunk) {
    chunks.push(chunk);
  });

  res.on("end", function () {
    const body = Buffer.concat(chunks);
    console.log(body.toString());
  });
});

req.end();

var client = new RestClient("https://business.arattai.in/api/v1/arattaiphonenumbers/91-9876543210");
var request = new RestRequest(Method.GET);
request.AddHeader("Arattai-CompanyId", "SOME_STRING_VALUE");
request.AddHeader("Authorization", "Bearer REPLACE_BEARER_TOKEN");
IRestResponse response = client.Execute(request);

var client = new HttpClient();
var request = new HttpRequestMessage
{
    Method = HttpMethod.Get,
    RequestUri = new Uri("https://business.arattai.in/api/v1/arattaiphonenumbers/91-9876543210"),
    Headers =
    {
        { "Arattai-CompanyId", "SOME_STRING_VALUE" },
        { "Authorization", "Bearer REPLACE_BEARER_TOKEN" },
    },
};
using (var response = await client.SendAsync(request))
{
    response.EnsureSuccessStatusCode();
    var body = await response.Content.ReadAsStringAsync();
    Console.WriteLine(body);
}

package main

import (
	"fmt"
	"net/http"
	"io/ioutil"
)

func main() {

	url := "https://business.arattai.in/api/v1/arattaiphonenumbers/91-9876543210"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Arattai-CompanyId", "SOME_STRING_VALUE")
	req.Header.Add("Authorization", "Bearer REPLACE_BEARER_TOKEN")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}

const data = null;

const xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://business.arattai.in/api/v1/arattaiphonenumbers/91-9876543210");
xhr.setRequestHeader("Arattai-CompanyId", "SOME_STRING_VALUE");
xhr.setRequestHeader("Authorization", "Bearer REPLACE_BEARER_TOKEN");

xhr.send(data);

curl --request GET \
  --url https://business.arattai.in/api/v1/arattaiphonenumbers/91-9876543210 \
  --header 'Arattai-CompanyId: SOME_STRING_VALUE' \
  --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'

Response Example

{
    "zuid": "72816325",
    "registered": true,
    "type": "user",
    "linked": false
}

{
    "code": "invalid_input",
    "message": "Either the input stream or parameter is invalid or absent"
}

{
    "code": "invalid_oauthtoken",
    "message": "You are not authenticated to do this operation"
}

{
    "code": "invalid_method",
    "message": "Invalid method"
}

Check If This Number Is Already Registered AI Tools

Open in ChatGPT

Open in ChatGPT to ask questions about this page

Open in Claude

Open in Claude to ask questions about this page

Copy as Markdown

Copy this page as markdown to use with AI assistants

View as Markdown

Open this page as markdown in a new tab

Before adding a new business number, you can quickly check if it's already connected to an Arattai Business account or linked to another organization.

Path parameter format: countryCode-nationalNumber (e.g. 91-9876543210). No leading + sign.

Response codes:

200 with registered=true: This number is already linked to another organization.
200 with registered=false: Number has an Arattai account but is not yet linked to any organization.
204: Number has no Arattai account yet.

Response Fields

zuid: Unique identifier of the Arattai user account linked to this phone number.
zaaid: Unique identifier of the organization this phone number is linked to. Present only when registered is true.

Rate Limits

Threshold Limit (Number of API calls allowed within a minute) - 10 requests per minute
Lock Period (Wait time before consecutive API requests) - 10 minutes

OAuth Scope : ArattaiBusiness.phonenumbers.READ

Path Parameters

phoneNumber

string

(Required)

Phone number in countryCode-nationalNumber format (e.g. 91-9876543210). No leading + sign.

Headers

Arattai-CompanyId

string

(Required)

The unique identifier of the company for this request.

Request Example

headers_data = Map();
headers_data.put("Arattai-CompanyId", "SOME_STRING_VALUE");
headers_data.put("Authorization", "Bearer REPLACE_BEARER_TOKEN");
response = invokeUrl
[
url: "https://business.arattai.in/api/v1/phonenumbers/91-9876543210"
type: GET
headers: headers_data
connection: <connection_name>
];
info response;

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://business.arattai.in/api/v1/phonenumbers/91-9876543210")
  .get()
  .addHeader("Arattai-CompanyId", "SOME_STRING_VALUE")
  .addHeader("Authorization", "Bearer REPLACE_BEARER_TOKEN")
  .build();

Response response = client.newCall(request).execute();

const options = {
  method: 'GET',
  headers: {
    'Arattai-CompanyId': 'SOME_STRING_VALUE',
    Authorization: 'Bearer REPLACE_BEARER_TOKEN'
  }
};

fetch('https://business.arattai.in/api/v1/phonenumbers/91-9876543210', options)
  .then(response => response.json())
  .then(response => console.log(response))
  .catch(err => console.error(err));

import http.client

conn = http.client.HTTPSConnection("business.arattai.in")

headers = {
    'Arattai-CompanyId': "SOME_STRING_VALUE",
    'Authorization': "Bearer REPLACE_BEARER_TOKEN"
    }

conn.request("GET", "/api/v1/phonenumbers/91-9876543210", headers=headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))

const http = require("https");

const options = {
  "method": "GET",
  "hostname": "business.arattai.in",
  "port": null,
  "path": "/api/v1/phonenumbers/91-9876543210",
  "headers": {
    "Arattai-CompanyId": "SOME_STRING_VALUE",
    "Authorization": "Bearer REPLACE_BEARER_TOKEN"
  }
};

const req = http.request(options, function (res) {
  const chunks = [];

  res.on("data", function (chunk) {
    chunks.push(chunk);
  });

  res.on("end", function () {
    const body = Buffer.concat(chunks);
    console.log(body.toString());
  });
});

req.end();

var client = new RestClient("https://business.arattai.in/api/v1/phonenumbers/91-9876543210");
var request = new RestRequest(Method.GET);
request.AddHeader("Arattai-CompanyId", "SOME_STRING_VALUE");
request.AddHeader("Authorization", "Bearer REPLACE_BEARER_TOKEN");
IRestResponse response = client.Execute(request);

var client = new HttpClient();
var request = new HttpRequestMessage
{
    Method = HttpMethod.Get,
    RequestUri = new Uri("https://business.arattai.in/api/v1/phonenumbers/91-9876543210"),
    Headers =
    {
        { "Arattai-CompanyId", "SOME_STRING_VALUE" },
        { "Authorization", "Bearer REPLACE_BEARER_TOKEN" },
    },
};
using (var response = await client.SendAsync(request))
{
    response.EnsureSuccessStatusCode();
    var body = await response.Content.ReadAsStringAsync();
    Console.WriteLine(body);
}

package main

import (
	"fmt"
	"net/http"
	"io/ioutil"
)

func main() {

	url := "https://business.arattai.in/api/v1/phonenumbers/91-9876543210"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Arattai-CompanyId", "SOME_STRING_VALUE")
	req.Header.Add("Authorization", "Bearer REPLACE_BEARER_TOKEN")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}

const data = null;

const xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://business.arattai.in/api/v1/phonenumbers/91-9876543210");
xhr.setRequestHeader("Arattai-CompanyId", "SOME_STRING_VALUE");
xhr.setRequestHeader("Authorization", "Bearer REPLACE_BEARER_TOKEN");

xhr.send(data);

curl --request GET \
  --url https://business.arattai.in/api/v1/phonenumbers/91-9876543210 \
  --header 'Arattai-CompanyId: SOME_STRING_VALUE' \
  --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'

Response Example

{
    "zuid": "72816325",
    "registered": true,
    "zaaid": "501000000001001"
}

{
    "zuid": "72816325",
    "registered": false
}

{
    "code": "invalid_input",
    "message": "Either the input stream or parameter is invalid or absent"
}

{
    "code": "invalid_oauthtoken",
    "message": "You are not authenticated to do this operation"
}

{
    "code": "invalid_method",
    "message": "Invalid method"
}

Check Username Availability AI Tools

Open in ChatGPT

Open in ChatGPT to ask questions about this page

Open in Claude

Open in Claude to ask questions about this page

Copy as Markdown

Copy this page as markdown to use with AI assistants

View as Markdown

Open this page as markdown in a new tab

Check if a username is available before creating a business number. Username must be unique across Arattai.

Response codes:

200: Username is already taken. Cannot be used.
204: Username is available. Can be used.

Username rules: 3-50 characters. Alphanumeric, hyphens, and underscores allowed. Cannot start or end with a hyphen or underscore. No consecutive hyphens or underscores.

Rate Limits

Threshold Limit (Number of API calls allowed within a minute) - 10 requests per minute
Lock Period (Wait time before consecutive API requests) - 1 hour
Threshold Limit (Daily) - 100 requests per day
Lock Period (Daily lock) - 24 hours

OAuth Scope : ArattaiBusiness.phonenumbers.READ

Path Parameters

username

string

(Required)

Username to check. 3-50 characters. Alphanumeric, hyphens, and underscores allowed.

Headers

Arattai-CompanyId

string

(Required)

The unique identifier of the company for this request.

Request Example

headers_data = Map();
headers_data.put("Arattai-CompanyId", "SOME_STRING_VALUE");
headers_data.put("Authorization", "Bearer REPLACE_BEARER_TOKEN");
response = invokeUrl
[
url: "https://business.arattai.in/api/v1/usernames/ryanwestbusiness"
type: GET
headers: headers_data
connection: <connection_name>
];
info response;

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://business.arattai.in/api/v1/usernames/ryanwestbusiness")
  .get()
  .addHeader("Arattai-CompanyId", "SOME_STRING_VALUE")
  .addHeader("Authorization", "Bearer REPLACE_BEARER_TOKEN")
  .build();

Response response = client.newCall(request).execute();

const options = {
  method: 'GET',
  headers: {
    'Arattai-CompanyId': 'SOME_STRING_VALUE',
    Authorization: 'Bearer REPLACE_BEARER_TOKEN'
  }
};

fetch('https://business.arattai.in/api/v1/usernames/ryanwestbusiness', options)
  .then(response => response.json())
  .then(response => console.log(response))
  .catch(err => console.error(err));

import http.client

conn = http.client.HTTPSConnection("business.arattai.in")

headers = {
    'Arattai-CompanyId': "SOME_STRING_VALUE",
    'Authorization': "Bearer REPLACE_BEARER_TOKEN"
    }

conn.request("GET", "/api/v1/usernames/ryanwestbusiness", headers=headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))

const http = require("https");

const options = {
  "method": "GET",
  "hostname": "business.arattai.in",
  "port": null,
  "path": "/api/v1/usernames/ryanwestbusiness",
  "headers": {
    "Arattai-CompanyId": "SOME_STRING_VALUE",
    "Authorization": "Bearer REPLACE_BEARER_TOKEN"
  }
};

const req = http.request(options, function (res) {
  const chunks = [];

  res.on("data", function (chunk) {
    chunks.push(chunk);
  });

  res.on("end", function () {
    const body = Buffer.concat(chunks);
    console.log(body.toString());
  });
});

req.end();

var client = new RestClient("https://business.arattai.in/api/v1/usernames/ryanwestbusiness");
var request = new RestRequest(Method.GET);
request.AddHeader("Arattai-CompanyId", "SOME_STRING_VALUE");
request.AddHeader("Authorization", "Bearer REPLACE_BEARER_TOKEN");
IRestResponse response = client.Execute(request);

var client = new HttpClient();
var request = new HttpRequestMessage
{
    Method = HttpMethod.Get,
    RequestUri = new Uri("https://business.arattai.in/api/v1/usernames/ryanwestbusiness"),
    Headers =
    {
        { "Arattai-CompanyId", "SOME_STRING_VALUE" },
        { "Authorization", "Bearer REPLACE_BEARER_TOKEN" },
    },
};
using (var response = await client.SendAsync(request))
{
    response.EnsureSuccessStatusCode();
    var body = await response.Content.ReadAsStringAsync();
    Console.WriteLine(body);
}

package main

import (
	"fmt"
	"net/http"
	"io/ioutil"
)

func main() {

	url := "https://business.arattai.in/api/v1/usernames/ryanwestbusiness"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Arattai-CompanyId", "SOME_STRING_VALUE")
	req.Header.Add("Authorization", "Bearer REPLACE_BEARER_TOKEN")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}

const data = null;

const xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://business.arattai.in/api/v1/usernames/ryanwestbusiness");
xhr.setRequestHeader("Arattai-CompanyId", "SOME_STRING_VALUE");
xhr.setRequestHeader("Authorization", "Bearer REPLACE_BEARER_TOKEN");

xhr.send(data);

curl --request GET \
  --url https://business.arattai.in/api/v1/usernames/ryanwestbusiness \
  --header 'Arattai-CompanyId: SOME_STRING_VALUE' \
  --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'

Response Example

{...}

{
    "code": "invalid_input",
    "message": "Either the input stream or parameter is invalid or absent"
}

{
    "code": "invalid_oauthtoken",
    "message": "You are not authenticated to do this operation"
}

{
    "code": "invalid_method",
    "message": "Invalid method"
}

Upload Profile Picture AI Tools

Open in ChatGPT

Open in ChatGPT to ask questions about this page

Open in Claude

Open in Claude to ask questions about this page

Copy as Markdown

Copy this page as markdown to use with AI assistants

View as Markdown

Open this page as markdown in a new tab

Upload or replace the profile picture for a business number. The image is proxied directly to Arattai and stored there.

The response returns the URL of the uploaded profile picture resource.

Rate Limits

Threshold Limit (Number of API calls allowed within a minute) - 10 requests per minute
Lock Period (Wait time before consecutive API requests) - 10 minutes

OAuth Scope : ArattaiBusiness.phonenumbers.CREATE

Arguments

file

binary

(Required)

Image file to upload as the profile picture. Maximum 10 MB. Supported formats - jpeg, jpg, png, gif, avif, webp.

Path Parameters

string

(Required)

Business number ID.

Headers

Arattai-CompanyId

string

(Required)

The unique identifier of the company for this request.

Request Example

parameters_data = Map();
parameters_data.put("field1", "value1")
parameters_data.put("field2", "value2")
headers_data = Map();
headers_data.put("Arattai-CompanyId", "SOME_STRING_VALUE");
headers_data.put("Authorization", "Bearer REPLACE_BEARER_TOKEN");
response = invokeUrl
[
url: "https://business.arattai.in/api/v1/businessnumbers/BUSINESS_NUMBER_ID/profilepicture"
type: POST
headers: headers_data
parameters: parameters_data
connection: <connection_name>
];
info response;

OkHttpClient client = new OkHttpClient();

MediaType mediaType = MediaType.parse("multipart/form-data; boundary=---011000010111000001101001");
RequestBody body = RequestBody.create(mediaType, "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"field1\"\r\n\r\nvalue1\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"field2\"\r\n\r\nvalue2\r\n-----011000010111000001101001--\r\n");
Request request = new Request.Builder()
  .url("https://business.arattai.in/api/v1/businessnumbers/BUSINESS_NUMBER_ID/profilepicture")
  .post(body)
  .addHeader("Arattai-CompanyId", "SOME_STRING_VALUE")
  .addHeader("Authorization", "Bearer REPLACE_BEARER_TOKEN")
  .addHeader("content-type", "multipart/form-data; boundary=---011000010111000001101001")
  .build();

Response response = client.newCall(request).execute();

const form = new FormData();
form.append("field1", "value1");
form.append("field2", "value2");

const options = {
  method: 'POST',
  headers: {
    'Arattai-CompanyId': 'SOME_STRING_VALUE',
    Authorization: 'Bearer REPLACE_BEARER_TOKEN',
    'content-type': 'multipart/form-data; boundary=---011000010111000001101001'
  }
};

options.body = form;

fetch('https://business.arattai.in/api/v1/businessnumbers/BUSINESS_NUMBER_ID/profilepicture', options)
  .then(response => response.json())
  .then(response => console.log(response))
  .catch(err => console.error(err));

import http.client

conn = http.client.HTTPSConnection("business.arattai.in")

payload = "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"field1\"\r\n\r\nvalue1\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"field2\"\r\n\r\nvalue2\r\n-----011000010111000001101001--\r\n"

headers = {
    'Arattai-CompanyId': "SOME_STRING_VALUE",
    'Authorization': "Bearer REPLACE_BEARER_TOKEN",
    'content-type': "multipart/form-data; boundary=---011000010111000001101001"
    }

conn.request("POST", "/api/v1/businessnumbers/BUSINESS_NUMBER_ID/profilepicture", payload, headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))

const http = require("https");

const options = {
  "method": "POST",
  "hostname": "business.arattai.in",
  "port": null,
  "path": "/api/v1/businessnumbers/BUSINESS_NUMBER_ID/profilepicture",
  "headers": {
    "Arattai-CompanyId": "SOME_STRING_VALUE",
    "Authorization": "Bearer REPLACE_BEARER_TOKEN",
    "content-type": "multipart/form-data; boundary=---011000010111000001101001"
  }
};

const req = http.request(options, function (res) {
  const chunks = [];

  res.on("data", function (chunk) {
    chunks.push(chunk);
  });

  res.on("end", function () {
    const body = Buffer.concat(chunks);
    console.log(body.toString());
  });
});

req.write("-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"field1\"\r\n\r\nvalue1\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"field2\"\r\n\r\nvalue2\r\n-----011000010111000001101001--\r\n");
req.end();

var client = new RestClient("https://business.arattai.in/api/v1/businessnumbers/BUSINESS_NUMBER_ID/profilepicture");
var request = new RestRequest(Method.POST);
request.AddHeader("Arattai-CompanyId", "SOME_STRING_VALUE");
request.AddHeader("Authorization", "Bearer REPLACE_BEARER_TOKEN");
request.AddHeader("content-type", "multipart/form-data; boundary=---011000010111000001101001");
request.AddParameter("multipart/form-data; boundary=---011000010111000001101001", "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"field1\"\r\n\r\nvalue1\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"field2\"\r\n\r\nvalue2\r\n-----011000010111000001101001--\r\n", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);

var client = new HttpClient();
var request = new HttpRequestMessage
{
    Method = HttpMethod.Post,
    RequestUri = new Uri("https://business.arattai.in/api/v1/businessnumbers/BUSINESS_NUMBER_ID/profilepicture"),
    Headers =
    {
        { "Arattai-CompanyId", "SOME_STRING_VALUE" },
        { "Authorization", "Bearer REPLACE_BEARER_TOKEN" },
    },
    Content = new MultipartFormDataContent
    {
        new StringContent("value1")
        {
            Headers =
            {
                ContentDisposition = new ContentDispositionHeaderValue("form-data")
                {
                    Name = "field1",
                }
            }
        },
        new StringContent("value2")
        {
            Headers =
            {
                ContentDisposition = new ContentDispositionHeaderValue("form-data")
                {
                    Name = "field2",
                }
            }
        },
    },
};
using (var response = await client.SendAsync(request))
{
    response.EnsureSuccessStatusCode();
    var body = await response.Content.ReadAsStringAsync();
    Console.WriteLine(body);
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io/ioutil"
)

func main() {

	url := "https://business.arattai.in/api/v1/businessnumbers/BUSINESS_NUMBER_ID/profilepicture"

	payload := strings.NewReader("-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"field1\"\r\n\r\nvalue1\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"field2\"\r\n\r\nvalue2\r\n-----011000010111000001101001--\r\n")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Arattai-CompanyId", "SOME_STRING_VALUE")
	req.Header.Add("Authorization", "Bearer REPLACE_BEARER_TOKEN")
	req.Header.Add("content-type", "multipart/form-data; boundary=---011000010111000001101001")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}

const data = new FormData();
data.append("field1", "value1");
data.append("field2", "value2");

const xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("POST", "https://business.arattai.in/api/v1/businessnumbers/BUSINESS_NUMBER_ID/profilepicture");
xhr.setRequestHeader("Arattai-CompanyId", "SOME_STRING_VALUE");
xhr.setRequestHeader("Authorization", "Bearer REPLACE_BEARER_TOKEN");

xhr.send(data);

curl --request POST \
  --url https://business.arattai.in/api/v1/businessnumbers/BUSINESS_NUMBER_ID/profilepicture \
  --header 'Arattai-CompanyId: SOME_STRING_VALUE' \
  --header 'Authorization: Bearer REPLACE_BEARER_TOKEN' \
  --header 'content-type: multipart/form-data' \
  --form field1=value1 \
  --form field2=value2

{
    "file": "<binary image file>"
}

Response Example

{
    "url": "/api/v1/businessnumbers/501000000005013/profilepicture",
    "type": "cover_images",
    "data": [
        "Y292ZXJfaW1hZ2VfaWRzXzExOTY2NDAxN184NjU1MDA3X3Yx"
    ]
}

{
    "code": "invalid_input",
    "message": "Either the input stream or parameter is invalid or absent"
}

{
    "code": "invalid_oauthtoken",
    "message": "You are not authenticated to do this operation"
}

{
    "code": "not_found",
    "message": "The requested resource was not found"
}

{
    "code": "invalid_method",
    "message": "Invalid method"
}

Add Cover Images AI Tools

Open in ChatGPT

Open in ChatGPT to ask questions about this page

Open in Claude

Open in Claude to ask questions about this page

Copy as Markdown

Copy this page as markdown to use with AI assistants

View as Markdown

Open this page as markdown in a new tab

Upload one or more cover images (up to 10) for a business number. Each file is uploaded to Arattai in a single multipart request.

Download cover images via GET /operatormedia/{token} using the encoded IDs returned in the response data array.

Rate Limits

Threshold Limit (Number of API calls allowed within a minute) - 10 requests per minute
Lock Period (Wait time before consecutive API requests) - 10 minutes

OAuth Scope : ArattaiBusiness.phonenumbers.CREATE

Arguments

file

binary

(Required)

One or more image files to add as cover images. Maximum 10 MB each, up to 10 files per request. Supported formats - jpeg, jpg, png, gif, avif, webp.

Path Parameters

string

(Required)

Business number ID.

Headers

Arattai-CompanyId

string

(Required)

The unique identifier of the company for this request.

Request Example

parameters_data = Map();
parameters_data.put("field1", "value1")
parameters_data.put("field2", "value2")
headers_data = Map();
headers_data.put("Arattai-CompanyId", "SOME_STRING_VALUE");
headers_data.put("Authorization", "Bearer REPLACE_BEARER_TOKEN");
response = invokeUrl
[
url: "https://business.arattai.in/api/v1/businessnumbers/BUSINESS_NUMBER_ID/coverimages"
type: POST
headers: headers_data
parameters: parameters_data
connection: <connection_name>
];
info response;

OkHttpClient client = new OkHttpClient();

MediaType mediaType = MediaType.parse("multipart/form-data; boundary=---011000010111000001101001");
RequestBody body = RequestBody.create(mediaType, "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"field1\"\r\n\r\nvalue1\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"field2\"\r\n\r\nvalue2\r\n-----011000010111000001101001--\r\n");
Request request = new Request.Builder()
  .url("https://business.arattai.in/api/v1/businessnumbers/BUSINESS_NUMBER_ID/coverimages")
  .post(body)
  .addHeader("Arattai-CompanyId", "SOME_STRING_VALUE")
  .addHeader("Authorization", "Bearer REPLACE_BEARER_TOKEN")
  .addHeader("content-type", "multipart/form-data; boundary=---011000010111000001101001")
  .build();

Response response = client.newCall(request).execute();

const form = new FormData();
form.append("field1", "value1");
form.append("field2", "value2");

const options = {
  method: 'POST',
  headers: {
    'Arattai-CompanyId': 'SOME_STRING_VALUE',
    Authorization: 'Bearer REPLACE_BEARER_TOKEN',
    'content-type': 'multipart/form-data; boundary=---011000010111000001101001'
  }
};

options.body = form;

fetch('https://business.arattai.in/api/v1/businessnumbers/BUSINESS_NUMBER_ID/coverimages', options)
  .then(response => response.json())
  .then(response => console.log(response))
  .catch(err => console.error(err));

import http.client

conn = http.client.HTTPSConnection("business.arattai.in")

payload = "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"field1\"\r\n\r\nvalue1\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"field2\"\r\n\r\nvalue2\r\n-----011000010111000001101001--\r\n"

headers = {
    'Arattai-CompanyId': "SOME_STRING_VALUE",
    'Authorization': "Bearer REPLACE_BEARER_TOKEN",
    'content-type': "multipart/form-data; boundary=---011000010111000001101001"
    }

conn.request("POST", "/api/v1/businessnumbers/BUSINESS_NUMBER_ID/coverimages", payload, headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))

const http = require("https");

const options = {
  "method": "POST",
  "hostname": "business.arattai.in",
  "port": null,
  "path": "/api/v1/businessnumbers/BUSINESS_NUMBER_ID/coverimages",
  "headers": {
    "Arattai-CompanyId": "SOME_STRING_VALUE",
    "Authorization": "Bearer REPLACE_BEARER_TOKEN",
    "content-type": "multipart/form-data; boundary=---011000010111000001101001"
  }
};

const req = http.request(options, function (res) {
  const chunks = [];

  res.on("data", function (chunk) {
    chunks.push(chunk);
  });

  res.on("end", function () {
    const body = Buffer.concat(chunks);
    console.log(body.toString());
  });
});

req.write("-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"field1\"\r\n\r\nvalue1\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"field2\"\r\n\r\nvalue2\r\n-----011000010111000001101001--\r\n");
req.end();

var client = new RestClient("https://business.arattai.in/api/v1/businessnumbers/BUSINESS_NUMBER_ID/coverimages");
var request = new RestRequest(Method.POST);
request.AddHeader("Arattai-CompanyId", "SOME_STRING_VALUE");
request.AddHeader("Authorization", "Bearer REPLACE_BEARER_TOKEN");
request.AddHeader("content-type", "multipart/form-data; boundary=---011000010111000001101001");
request.AddParameter("multipart/form-data; boundary=---011000010111000001101001", "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"field1\"\r\n\r\nvalue1\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"field2\"\r\n\r\nvalue2\r\n-----011000010111000001101001--\r\n", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);

var client = new HttpClient();
var request = new HttpRequestMessage
{
    Method = HttpMethod.Post,
    RequestUri = new Uri("https://business.arattai.in/api/v1/businessnumbers/BUSINESS_NUMBER_ID/coverimages"),
    Headers =
    {
        { "Arattai-CompanyId", "SOME_STRING_VALUE" },
        { "Authorization", "Bearer REPLACE_BEARER_TOKEN" },
    },
    Content = new MultipartFormDataContent
    {
        new StringContent("value1")
        {
            Headers =
            {
                ContentDisposition = new ContentDispositionHeaderValue("form-data")
                {
                    Name = "field1",
                }
            }
        },
        new StringContent("value2")
        {
            Headers =
            {
                ContentDisposition = new ContentDispositionHeaderValue("form-data")
                {
                    Name = "field2",
                }
            }
        },
    },
};
using (var response = await client.SendAsync(request))
{
    response.EnsureSuccessStatusCode();
    var body = await response.Content.ReadAsStringAsync();
    Console.WriteLine(body);
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io/ioutil"
)

func main() {

	url := "https://business.arattai.in/api/v1/businessnumbers/BUSINESS_NUMBER_ID/coverimages"

	payload := strings.NewReader("-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"field1\"\r\n\r\nvalue1\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"field2\"\r\n\r\nvalue2\r\n-----011000010111000001101001--\r\n")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Arattai-CompanyId", "SOME_STRING_VALUE")
	req.Header.Add("Authorization", "Bearer REPLACE_BEARER_TOKEN")
	req.Header.Add("content-type", "multipart/form-data; boundary=---011000010111000001101001")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}

const data = new FormData();
data.append("field1", "value1");
data.append("field2", "value2");

const xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("POST", "https://business.arattai.in/api/v1/businessnumbers/BUSINESS_NUMBER_ID/coverimages");
xhr.setRequestHeader("Arattai-CompanyId", "SOME_STRING_VALUE");
xhr.setRequestHeader("Authorization", "Bearer REPLACE_BEARER_TOKEN");

xhr.send(data);

curl --request POST \
  --url https://business.arattai.in/api/v1/businessnumbers/BUSINESS_NUMBER_ID/coverimages \
  --header 'Arattai-CompanyId: SOME_STRING_VALUE' \
  --header 'Authorization: Bearer REPLACE_BEARER_TOKEN' \
  --header 'content-type: multipart/form-data' \
  --form field1=value1 \
  --form field2=value2

{
    "file": "<binary image file(s)>"
}

Response Example

{
    "url": "/api/v1/businessnumbers/501000000005013/coverimages",
    "type": "cover_images",
    "data": [
        "Y292ZXJfaW1hZ2VfaWRzXzExOTY2NDAxN184NjU1MDA3X3Yx"
    ]
}

{
    "code": "invalid_input",
    "message": "Either the input stream or parameter is invalid or absent"
}

{
    "code": "invalid_oauthtoken",
    "message": "You are not authenticated to do this operation"
}

{
    "code": "not_found",
    "message": "The requested resource was not found"
}

{
    "code": "invalid_method",
    "message": "Invalid method"
}

List Cover Image IDs AI Tools

Open in ChatGPT

Open in ChatGPT to ask questions about this page

Open in Claude

Open in Claude to ask questions about this page

Copy as Markdown

Copy this page as markdown to use with AI assistants

View as Markdown

Open this page as markdown in a new tab

Get the list of cover image IDs for a business number.

Download individual images via GET /operatormedia/{token} using the encoded IDs in the response.

Rate Limits

Threshold Limit (Number of API calls allowed within a minute) - 30 requests per minute
Lock Period (Wait time before consecutive API requests) - 10 minutes

OAuth Scope : ArattaiBusiness.phonenumbers.READ

Path Parameters

string

(Required)

Business number ID.

Headers

Arattai-CompanyId

string

(Required)

The unique identifier of the company for this request.

Request Example

headers_data = Map();
headers_data.put("Arattai-CompanyId", "SOME_STRING_VALUE");
headers_data.put("Authorization", "Bearer REPLACE_BEARER_TOKEN");
response = invokeUrl
[
url: "https://business.arattai.in/api/v1/businessnumbers/BUSINESS_NUMBER_ID/coverimages"
type: GET
headers: headers_data
connection: <connection_name>
];
info response;

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://business.arattai.in/api/v1/businessnumbers/BUSINESS_NUMBER_ID/coverimages")
  .get()
  .addHeader("Arattai-CompanyId", "SOME_STRING_VALUE")
  .addHeader("Authorization", "Bearer REPLACE_BEARER_TOKEN")
  .build();

Response response = client.newCall(request).execute();

const options = {
  method: 'GET',
  headers: {
    'Arattai-CompanyId': 'SOME_STRING_VALUE',
    Authorization: 'Bearer REPLACE_BEARER_TOKEN'
  }
};

fetch('https://business.arattai.in/api/v1/businessnumbers/BUSINESS_NUMBER_ID/coverimages', options)
  .then(response => response.json())
  .then(response => console.log(response))
  .catch(err => console.error(err));

import http.client

conn = http.client.HTTPSConnection("business.arattai.in")

headers = {
    'Arattai-CompanyId': "SOME_STRING_VALUE",
    'Authorization': "Bearer REPLACE_BEARER_TOKEN"
    }

conn.request("GET", "/api/v1/businessnumbers/BUSINESS_NUMBER_ID/coverimages", headers=headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))

const http = require("https");

const options = {
  "method": "GET",
  "hostname": "business.arattai.in",
  "port": null,
  "path": "/api/v1/businessnumbers/BUSINESS_NUMBER_ID/coverimages",
  "headers": {
    "Arattai-CompanyId": "SOME_STRING_VALUE",
    "Authorization": "Bearer REPLACE_BEARER_TOKEN"
  }
};

const req = http.request(options, function (res) {
  const chunks = [];

  res.on("data", function (chunk) {
    chunks.push(chunk);
  });

  res.on("end", function () {
    const body = Buffer.concat(chunks);
    console.log(body.toString());
  });
});

req.end();

var client = new RestClient("https://business.arattai.in/api/v1/businessnumbers/BUSINESS_NUMBER_ID/coverimages");
var request = new RestRequest(Method.GET);
request.AddHeader("Arattai-CompanyId", "SOME_STRING_VALUE");
request.AddHeader("Authorization", "Bearer REPLACE_BEARER_TOKEN");
IRestResponse response = client.Execute(request);

var client = new HttpClient();
var request = new HttpRequestMessage
{
    Method = HttpMethod.Get,
    RequestUri = new Uri("https://business.arattai.in/api/v1/businessnumbers/BUSINESS_NUMBER_ID/coverimages"),
    Headers =
    {
        { "Arattai-CompanyId", "SOME_STRING_VALUE" },
        { "Authorization", "Bearer REPLACE_BEARER_TOKEN" },
    },
};
using (var response = await client.SendAsync(request))
{
    response.EnsureSuccessStatusCode();
    var body = await response.Content.ReadAsStringAsync();
    Console.WriteLine(body);
}

package main

import (
	"fmt"
	"net/http"
	"io/ioutil"
)

func main() {

	url := "https://business.arattai.in/api/v1/businessnumbers/BUSINESS_NUMBER_ID/coverimages"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Arattai-CompanyId", "SOME_STRING_VALUE")
	req.Header.Add("Authorization", "Bearer REPLACE_BEARER_TOKEN")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}

const data = null;

const xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://business.arattai.in/api/v1/businessnumbers/BUSINESS_NUMBER_ID/coverimages");
xhr.setRequestHeader("Arattai-CompanyId", "SOME_STRING_VALUE");
xhr.setRequestHeader("Authorization", "Bearer REPLACE_BEARER_TOKEN");

xhr.send(data);

curl --request GET \
  --url https://business.arattai.in/api/v1/businessnumbers/BUSINESS_NUMBER_ID/coverimages \
  --header 'Arattai-CompanyId: SOME_STRING_VALUE' \
  --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'

Response Example

{
    "url": "/api/v1/businessnumbers/501000000005013/coverimages",
    "type": "cover_images",
    "data": {
        "zuid": "119664017",
        "ids": [
            "Y292ZXJfaW1hZ2VfaWRzXzExOTY2NDAxN183MTEyMDAwMDAwMDIwMDAxX3Yx"
        ]
    }
}

{
    "code": "invalid_oauthtoken",
    "message": "You are not authenticated to do this operation"
}

{
    "code": "not_found",
    "message": "The requested resource was not found"
}

{
    "code": "invalid_method",
    "message": "Invalid method"
}

Download a Cover Image or Profile Picture AI Tools

Open in ChatGPT

Open in ChatGPT to ask questions about this page

Open in Claude

Open in Claude to ask questions about this page

Copy as Markdown

Copy this page as markdown to use with AI assistants

View as Markdown

Open this page as markdown in a new tab

Download a single cover image (or profile picture) as a binary stream. Cover image and profile picture media are served by this shared route. The {token} is the encoded cover image or profile picture ID returned by the add or list endpoints.

Rate Limits

Threshold Limit (Number of API calls allowed within a minute) - 10 requests per minute
Lock Period (Wait time before consecutive API requests) - 10 minutes

OAuth Scope : ArattaiBusiness.phonenumbers.READ

Path Parameters

token

string

(Required)

Encoded cover image or profile picture media ID (from the add/list response data array).

Request Example

headers_data = Map();
headers_data.put("Authorization", "Bearer REPLACE_BEARER_TOKEN");
response = invokeUrl
[
url: "https://business.arattai.in/api/v1/operatormedia/Y292ZXJfaW1hZ2VfaWRzXzExOTY2NDAxN184NjU1MDA3X3Yx"
type: GET
headers: headers_data
connection: <connection_name>
];
info response;

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://business.arattai.in/api/v1/operatormedia/Y292ZXJfaW1hZ2VfaWRzXzExOTY2NDAxN184NjU1MDA3X3Yx")
  .get()
  .addHeader("Authorization", "Bearer REPLACE_BEARER_TOKEN")
  .build();

Response response = client.newCall(request).execute();

const options = {method: 'GET', headers: {Authorization: 'Bearer REPLACE_BEARER_TOKEN'}};

fetch('https://business.arattai.in/api/v1/operatormedia/Y292ZXJfaW1hZ2VfaWRzXzExOTY2NDAxN184NjU1MDA3X3Yx', options)
  .then(response => response.json())
  .then(response => console.log(response))
  .catch(err => console.error(err));

import http.client

conn = http.client.HTTPSConnection("business.arattai.in")

headers = { 'Authorization': "Bearer REPLACE_BEARER_TOKEN" }

conn.request("GET", "/api/v1/operatormedia/Y292ZXJfaW1hZ2VfaWRzXzExOTY2NDAxN184NjU1MDA3X3Yx", headers=headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))

const http = require("https");

const options = {
  "method": "GET",
  "hostname": "business.arattai.in",
  "port": null,
  "path": "/api/v1/operatormedia/Y292ZXJfaW1hZ2VfaWRzXzExOTY2NDAxN184NjU1MDA3X3Yx",
  "headers": {
    "Authorization": "Bearer REPLACE_BEARER_TOKEN"
  }
};

const req = http.request(options, function (res) {
  const chunks = [];

  res.on("data", function (chunk) {
    chunks.push(chunk);
  });

  res.on("end", function () {
    const body = Buffer.concat(chunks);
    console.log(body.toString());
  });
});

req.end();

var client = new RestClient("https://business.arattai.in/api/v1/operatormedia/Y292ZXJfaW1hZ2VfaWRzXzExOTY2NDAxN184NjU1MDA3X3Yx");
var request = new RestRequest(Method.GET);
request.AddHeader("Authorization", "Bearer REPLACE_BEARER_TOKEN");
IRestResponse response = client.Execute(request);

var client = new HttpClient();
var request = new HttpRequestMessage
{
    Method = HttpMethod.Get,
    RequestUri = new Uri("https://business.arattai.in/api/v1/operatormedia/Y292ZXJfaW1hZ2VfaWRzXzExOTY2NDAxN184NjU1MDA3X3Yx"),
    Headers =
    {
        { "Authorization", "Bearer REPLACE_BEARER_TOKEN" },
    },
};
using (var response = await client.SendAsync(request))
{
    response.EnsureSuccessStatusCode();
    var body = await response.Content.ReadAsStringAsync();
    Console.WriteLine(body);
}

package main

import (
	"fmt"
	"net/http"
	"io/ioutil"
)

func main() {

	url := "https://business.arattai.in/api/v1/operatormedia/Y292ZXJfaW1hZ2VfaWRzXzExOTY2NDAxN184NjU1MDA3X3Yx"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer REPLACE_BEARER_TOKEN")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}

const data = null;

const xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://business.arattai.in/api/v1/operatormedia/Y292ZXJfaW1hZ2VfaWRzXzExOTY2NDAxN184NjU1MDA3X3Yx");
xhr.setRequestHeader("Authorization", "Bearer REPLACE_BEARER_TOKEN");

xhr.send(data);

curl --request GET \
  --url https://business.arattai.in/api/v1/operatormedia/Y292ZXJfaW1hZ2VfaWRzXzExOTY2NDAxN184NjU1MDA3X3Yx \
  --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'

Response Example

{
    "code": "invalid_input",
    "message": "Either the input stream or parameter is invalid or absent"
}

{
    "code": "not_found",
    "message": "The requested resource was not found"
}

{
    "code": "invalid_method",
    "message": "Invalid method"
}

Delete a Cover Image AI Tools

Open in ChatGPT

Open in ChatGPT to ask questions about this page

Open in Claude

Open in Claude to ask questions about this page

Copy as Markdown

Copy this page as markdown to use with AI assistants

View as Markdown

Open this page as markdown in a new tab

Delete a single cover image by its encoded ID.

Rate Limits

Threshold Limit (Number of API calls allowed within a minute) - 10 requests per minute
Lock Period (Wait time before consecutive API requests) - 10 minutes

OAuth Scope : ArattaiBusiness.phonenumbers.DELETE

Path Parameters

string

(Required)

Business number ID.

encodedId

string

(Required)

Encoded cover image ID to delete (from the add/list response data array).

Headers

Arattai-CompanyId

string

(Required)

The unique identifier of the company for this request.

Request Example

headers_data = Map();
headers_data.put("Arattai-CompanyId", "SOME_STRING_VALUE");
headers_data.put("Authorization", "Bearer REPLACE_BEARER_TOKEN");
response = invokeUrl
[
url: "https://business.arattai.in/api/v1/businessnumbers/BUSINESS_NUMBER_ID/coverimages/Y292ZXJfaW1hZ2VfaWRzXzExOTY2NDAxN184NjU1MDA3X3Yx"
type: DELETE
headers: headers_data
connection: <connection_name>
];
info response;

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://business.arattai.in/api/v1/businessnumbers/BUSINESS_NUMBER_ID/coverimages/Y292ZXJfaW1hZ2VfaWRzXzExOTY2NDAxN184NjU1MDA3X3Yx")
  .delete(null)
  .addHeader("Arattai-CompanyId", "SOME_STRING_VALUE")
  .addHeader("Authorization", "Bearer REPLACE_BEARER_TOKEN")
  .build();

Response response = client.newCall(request).execute();

const options = {
  method: 'DELETE',
  headers: {
    'Arattai-CompanyId': 'SOME_STRING_VALUE',
    Authorization: 'Bearer REPLACE_BEARER_TOKEN'
  }
};

fetch('https://business.arattai.in/api/v1/businessnumbers/BUSINESS_NUMBER_ID/coverimages/Y292ZXJfaW1hZ2VfaWRzXzExOTY2NDAxN184NjU1MDA3X3Yx', options)
  .then(response => response.json())
  .then(response => console.log(response))
  .catch(err => console.error(err));

import http.client

conn = http.client.HTTPSConnection("business.arattai.in")

headers = {
    'Arattai-CompanyId': "SOME_STRING_VALUE",
    'Authorization': "Bearer REPLACE_BEARER_TOKEN"
    }

conn.request("DELETE", "/api/v1/businessnumbers/BUSINESS_NUMBER_ID/coverimages/Y292ZXJfaW1hZ2VfaWRzXzExOTY2NDAxN184NjU1MDA3X3Yx", headers=headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))

const http = require("https");

const options = {
  "method": "DELETE",
  "hostname": "business.arattai.in",
  "port": null,
  "path": "/api/v1/businessnumbers/BUSINESS_NUMBER_ID/coverimages/Y292ZXJfaW1hZ2VfaWRzXzExOTY2NDAxN184NjU1MDA3X3Yx",
  "headers": {
    "Arattai-CompanyId": "SOME_STRING_VALUE",
    "Authorization": "Bearer REPLACE_BEARER_TOKEN"
  }
};

const req = http.request(options, function (res) {
  const chunks = [];

  res.on("data", function (chunk) {
    chunks.push(chunk);
  });

  res.on("end", function () {
    const body = Buffer.concat(chunks);
    console.log(body.toString());
  });
});

req.end();

var client = new RestClient("https://business.arattai.in/api/v1/businessnumbers/BUSINESS_NUMBER_ID/coverimages/Y292ZXJfaW1hZ2VfaWRzXzExOTY2NDAxN184NjU1MDA3X3Yx");
var request = new RestRequest(Method.DELETE);
request.AddHeader("Arattai-CompanyId", "SOME_STRING_VALUE");
request.AddHeader("Authorization", "Bearer REPLACE_BEARER_TOKEN");
IRestResponse response = client.Execute(request);

var client = new HttpClient();
var request = new HttpRequestMessage
{
    Method = HttpMethod.Delete,
    RequestUri = new Uri("https://business.arattai.in/api/v1/businessnumbers/BUSINESS_NUMBER_ID/coverimages/Y292ZXJfaW1hZ2VfaWRzXzExOTY2NDAxN184NjU1MDA3X3Yx"),
    Headers =
    {
        { "Arattai-CompanyId", "SOME_STRING_VALUE" },
        { "Authorization", "Bearer REPLACE_BEARER_TOKEN" },
    },
};
using (var response = await client.SendAsync(request))
{
    response.EnsureSuccessStatusCode();
    var body = await response.Content.ReadAsStringAsync();
    Console.WriteLine(body);
}

package main

import (
	"fmt"
	"net/http"
	"io/ioutil"
)

func main() {

	url := "https://business.arattai.in/api/v1/businessnumbers/BUSINESS_NUMBER_ID/coverimages/Y292ZXJfaW1hZ2VfaWRzXzExOTY2NDAxN184NjU1MDA3X3Yx"

	req, _ := http.NewRequest("DELETE", url, nil)

	req.Header.Add("Arattai-CompanyId", "SOME_STRING_VALUE")
	req.Header.Add("Authorization", "Bearer REPLACE_BEARER_TOKEN")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}

const data = null;

const xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("DELETE", "https://business.arattai.in/api/v1/businessnumbers/BUSINESS_NUMBER_ID/coverimages/Y292ZXJfaW1hZ2VfaWRzXzExOTY2NDAxN184NjU1MDA3X3Yx");
xhr.setRequestHeader("Arattai-CompanyId", "SOME_STRING_VALUE");
xhr.setRequestHeader("Authorization", "Bearer REPLACE_BEARER_TOKEN");

xhr.send(data);

curl --request DELETE \
  --url https://business.arattai.in/api/v1/businessnumbers/BUSINESS_NUMBER_ID/coverimages/Y292ZXJfaW1hZ2VfaWRzXzExOTY2NDAxN184NjU1MDA3X3Yx \
  --header 'Arattai-CompanyId: SOME_STRING_VALUE' \
  --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'

Response Example

{
    "code": "invalid_input",
    "message": "Either the input stream or parameter is invalid or absent"
}

{
    "code": "invalid_oauthtoken",
    "message": "You are not authenticated to do this operation"
}

{
    "code": "not_found",
    "message": "The requested resource was not found"
}

{
    "code": "invalid_method",
    "message": "Invalid method"
}

Set Pinned Miniapps for a Number AI Tools

Open in ChatGPT

Open in ChatGPT to ask questions about this page

Open in Claude

Open in Claude to ask questions about this page

Copy as Markdown

Copy this page as markdown to use with AI assistants

View as Markdown

Open this page as markdown in a new tab

Set the list of miniapps pinned to a business number (replaces existing). Maximum 5 miniapps can be pinned to a number. Order is preserved from the array position.

To unpin all miniapps, send an empty array: {"ids": []}

Rate Limits

Threshold Limit (Number of API calls allowed within a minute) - 30 requests per minute
Lock Period (Wait time before consecutive API requests) - 10 minutes

OAuth Scope : ArattaiBusiness.phonenumbers.UPDATE

Arguments

ids

array

(Required)

Array of miniapp IDs to pin. Maximum 5. Send empty array to unpin all.

Path Parameters

string

(Required)

Business number ID.

Headers

Arattai-CompanyId

string

(Required)

The unique identifier of the company for this request.

Request Example

parameters_data='{"field1":"value1","field2":"value2"}';
headers_data = Map();
headers_data.put("Arattai-CompanyId", "SOME_STRING_VALUE");
headers_data.put("Authorization", "Bearer REPLACE_BEARER_TOKEN");
response = invokeUrl
[
url: "https://business.arattai.in/api/v1/businessnumbers/BUSINESS_NUMBER_ID/miniapps"
type: PUT
headers: headers_data
content-type: application/json
parameters: parameters_data
connection: <connection_name>
];
info response;

OkHttpClient client = new OkHttpClient();

MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{\"field1\":\"value1\",\"field2\":\"value2\"}");
Request request = new Request.Builder()
  .url("https://business.arattai.in/api/v1/businessnumbers/BUSINESS_NUMBER_ID/miniapps")
  .put(body)
  .addHeader("Arattai-CompanyId", "SOME_STRING_VALUE")
  .addHeader("Authorization", "Bearer REPLACE_BEARER_TOKEN")
  .addHeader("content-type", "application/json")
  .build();

Response response = client.newCall(request).execute();

const options = {
  method: 'PUT',
  headers: {
    'Arattai-CompanyId': 'SOME_STRING_VALUE',
    Authorization: 'Bearer REPLACE_BEARER_TOKEN',
    'content-type': 'application/json'
  },
  body: '{"field1":"value1","field2":"value2"}'
};

fetch('https://business.arattai.in/api/v1/businessnumbers/BUSINESS_NUMBER_ID/miniapps', options)
  .then(response => response.json())
  .then(response => console.log(response))
  .catch(err => console.error(err));

import http.client

conn = http.client.HTTPSConnection("business.arattai.in")

payload = "{\"field1\":\"value1\",\"field2\":\"value2\"}"

headers = {
    'Arattai-CompanyId': "SOME_STRING_VALUE",
    'Authorization': "Bearer REPLACE_BEARER_TOKEN",
    'content-type': "application/json"
    }

conn.request("PUT", "/api/v1/businessnumbers/BUSINESS_NUMBER_ID/miniapps", payload, headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))

const http = require("https");

const options = {
  "method": "PUT",
  "hostname": "business.arattai.in",
  "port": null,
  "path": "/api/v1/businessnumbers/BUSINESS_NUMBER_ID/miniapps",
  "headers": {
    "Arattai-CompanyId": "SOME_STRING_VALUE",
    "Authorization": "Bearer REPLACE_BEARER_TOKEN",
    "content-type": "application/json"
  }
};

const req = http.request(options, function (res) {
  const chunks = [];

  res.on("data", function (chunk) {
    chunks.push(chunk);
  });

  res.on("end", function () {
    const body = Buffer.concat(chunks);
    console.log(body.toString());
  });
});

req.write(JSON.stringify({field1: 'value1', field2: 'value2'}));
req.end();

var client = new RestClient("https://business.arattai.in/api/v1/businessnumbers/BUSINESS_NUMBER_ID/miniapps");
var request = new RestRequest(Method.PUT);
request.AddHeader("Arattai-CompanyId", "SOME_STRING_VALUE");
request.AddHeader("Authorization", "Bearer REPLACE_BEARER_TOKEN");
request.AddHeader("content-type", "application/json");
request.AddParameter("application/json", "{\"field1\":\"value1\",\"field2\":\"value2\"}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);

var client = new HttpClient();
var request = new HttpRequestMessage
{
    Method = HttpMethod.Put,
    RequestUri = new Uri("https://business.arattai.in/api/v1/businessnumbers/BUSINESS_NUMBER_ID/miniapps"),
    Headers =
    {
        { "Arattai-CompanyId", "SOME_STRING_VALUE" },
        { "Authorization", "Bearer REPLACE_BEARER_TOKEN" },
    },
    Content = new StringContent("{\"field1\":\"value1\",\"field2\":\"value2\"}")
    {
        Headers =
        {
            ContentType = new MediaTypeHeaderValue("application/json")
        }
    }
};
using (var response = await client.SendAsync(request))
{
    response.EnsureSuccessStatusCode();
    var body = await response.Content.ReadAsStringAsync();
    Console.WriteLine(body);
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io/ioutil"
)

func main() {

	url := "https://business.arattai.in/api/v1/businessnumbers/BUSINESS_NUMBER_ID/miniapps"

	payload := strings.NewReader("{\"field1\":\"value1\",\"field2\":\"value2\"}")

	req, _ := http.NewRequest("PUT", url, payload)

	req.Header.Add("Arattai-CompanyId", "SOME_STRING_VALUE")
	req.Header.Add("Authorization", "Bearer REPLACE_BEARER_TOKEN")
	req.Header.Add("content-type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}

const data = JSON.stringify({
  "field1": "value1",
  "field2": "value2"
});

const xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("PUT", "https://business.arattai.in/api/v1/businessnumbers/BUSINESS_NUMBER_ID/miniapps");
xhr.setRequestHeader("Arattai-CompanyId", "SOME_STRING_VALUE");
xhr.setRequestHeader("Authorization", "Bearer REPLACE_BEARER_TOKEN");
xhr.setRequestHeader("content-type", "application/json");

xhr.send(data);

curl --request PUT \
  --url https://business.arattai.in/api/v1/businessnumbers/BUSINESS_NUMBER_ID/miniapps \
  --header 'Arattai-CompanyId: SOME_STRING_VALUE' \
  --header 'Authorization: Bearer REPLACE_BEARER_TOKEN' \
  --header 'content-type: application/json' \
  --data '{"field1":"value1","field2":"value2"}'

{
    "ids": [
        501000000005001,
        501000000005002
    ]
}

{
    "ids": []
}

Response Example

{...}

{
    "code": "invalid_input",
    "message": "More than 5 miniapp IDs provided"
}

{
    "code": "invalid_oauthtoken",
    "message": "You are not authenticated to do this operation"
}

{
    "code": "not_found",
    "message": "The requested resource was not found"
}

{
    "code": "invalid_method",
    "message": "Invalid method"
}

Get Pinned Miniapps for a Number AI Tools

Open in ChatGPT

Open in ChatGPT to ask questions about this page

Open in Claude

Open in Claude to ask questions about this page

Copy as Markdown

Copy this page as markdown to use with AI assistants

View as Markdown

Open this page as markdown in a new tab

Get miniapps pinned to a specific business number, sorted by ORDER_INDEX.

Rate Limits

Threshold Limit (Number of API calls allowed within a minute) - 30 requests per minute
Lock Period (Wait time before consecutive API requests) - 10 minutes

OAuth Scope : ArattaiBusiness.phonenumbers.READ

Path Parameters

string

(Required)

Business number ID.

Headers

Arattai-CompanyId

string

(Required)

The unique identifier of the company for this request.

Request Example

headers_data = Map();
headers_data.put("Arattai-CompanyId", "SOME_STRING_VALUE");
headers_data.put("Authorization", "Bearer REPLACE_BEARER_TOKEN");
response = invokeUrl
[
url: "https://business.arattai.in/api/v1/businessnumbers/BUSINESS_NUMBER_ID/miniapps"
type: GET
headers: headers_data
connection: <connection_name>
];
info response;

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://business.arattai.in/api/v1/businessnumbers/BUSINESS_NUMBER_ID/miniapps")
  .get()
  .addHeader("Arattai-CompanyId", "SOME_STRING_VALUE")
  .addHeader("Authorization", "Bearer REPLACE_BEARER_TOKEN")
  .build();

Response response = client.newCall(request).execute();

const options = {
  method: 'GET',
  headers: {
    'Arattai-CompanyId': 'SOME_STRING_VALUE',
    Authorization: 'Bearer REPLACE_BEARER_TOKEN'
  }
};

fetch('https://business.arattai.in/api/v1/businessnumbers/BUSINESS_NUMBER_ID/miniapps', options)
  .then(response => response.json())
  .then(response => console.log(response))
  .catch(err => console.error(err));

import http.client

conn = http.client.HTTPSConnection("business.arattai.in")

headers = {
    'Arattai-CompanyId': "SOME_STRING_VALUE",
    'Authorization': "Bearer REPLACE_BEARER_TOKEN"
    }

conn.request("GET", "/api/v1/businessnumbers/BUSINESS_NUMBER_ID/miniapps", headers=headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))

const http = require("https");

const options = {
  "method": "GET",
  "hostname": "business.arattai.in",
  "port": null,
  "path": "/api/v1/businessnumbers/BUSINESS_NUMBER_ID/miniapps",
  "headers": {
    "Arattai-CompanyId": "SOME_STRING_VALUE",
    "Authorization": "Bearer REPLACE_BEARER_TOKEN"
  }
};

const req = http.request(options, function (res) {
  const chunks = [];

  res.on("data", function (chunk) {
    chunks.push(chunk);
  });

  res.on("end", function () {
    const body = Buffer.concat(chunks);
    console.log(body.toString());
  });
});

req.end();

var client = new RestClient("https://business.arattai.in/api/v1/businessnumbers/BUSINESS_NUMBER_ID/miniapps");
var request = new RestRequest(Method.GET);
request.AddHeader("Arattai-CompanyId", "SOME_STRING_VALUE");
request.AddHeader("Authorization", "Bearer REPLACE_BEARER_TOKEN");
IRestResponse response = client.Execute(request);

var client = new HttpClient();
var request = new HttpRequestMessage
{
    Method = HttpMethod.Get,
    RequestUri = new Uri("https://business.arattai.in/api/v1/businessnumbers/BUSINESS_NUMBER_ID/miniapps"),
    Headers =
    {
        { "Arattai-CompanyId", "SOME_STRING_VALUE" },
        { "Authorization", "Bearer REPLACE_BEARER_TOKEN" },
    },
};
using (var response = await client.SendAsync(request))
{
    response.EnsureSuccessStatusCode();
    var body = await response.Content.ReadAsStringAsync();
    Console.WriteLine(body);
}

package main

import (
	"fmt"
	"net/http"
	"io/ioutil"
)

func main() {

	url := "https://business.arattai.in/api/v1/businessnumbers/BUSINESS_NUMBER_ID/miniapps"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Arattai-CompanyId", "SOME_STRING_VALUE")
	req.Header.Add("Authorization", "Bearer REPLACE_BEARER_TOKEN")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}

const data = null;

const xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://business.arattai.in/api/v1/businessnumbers/BUSINESS_NUMBER_ID/miniapps");
xhr.setRequestHeader("Arattai-CompanyId", "SOME_STRING_VALUE");
xhr.setRequestHeader("Authorization", "Bearer REPLACE_BEARER_TOKEN");

xhr.send(data);

curl --request GET \
  --url https://business.arattai.in/api/v1/businessnumbers/BUSINESS_NUMBER_ID/miniapps \
  --header 'Arattai-CompanyId: SOME_STRING_VALUE' \
  --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'

Response Example

{
    "miniapps": [
        {
            "id": "501000000007001",
            "reference_id": "4XL880KFH7",
            "name": "Visit Store",
            "url": "https://example.com/store",
            "logo_url": "/api/v1/miniapplogo/c3RvcmUuLi4=",
            "published": true,
            "order": 1
        }
    ],
    "count": 1
}

{
    "code": "invalid_input",
    "message": "Either the input stream or parameter is invalid or absent"
}

{
    "code": "invalid_oauthtoken",
    "message": "You are not authenticated to do this operation"
}

{
    "code": "not_found",
    "message": "The requested resource was not found"
}

{
    "code": "invalid_method",
    "message": "Invalid method"
}

Reorder Pinned Miniapps AI Tools

Open in ChatGPT

Open in ChatGPT to ask questions about this page

Open in Claude

Open in Claude to ask questions about this page

Copy as Markdown

Copy this page as markdown to use with AI assistants

View as Markdown

Open this page as markdown in a new tab

Reorder existing pinned miniapps for a business number. Only changes ORDER_INDEX for existing mappings; does not add or remove miniapps.

Rate Limits

Threshold Limit (Number of API calls allowed within a minute) - 30 requests per minute
Lock Period (Wait time before consecutive API requests) - 10 minutes

OAuth Scope : ArattaiBusiness.phonenumbers.CREATE

Arguments

ids

array

(Required)

Ordered array of miniapp IDs. Order is applied to existing pinned miniapps only.

Path Parameters

string

(Required)

Business number ID.

Headers

Arattai-CompanyId

string

(Required)

The unique identifier of the company for this request.

Request Example

parameters_data='{"field1":"value1","field2":"value2"}';
headers_data = Map();
headers_data.put("Arattai-CompanyId", "SOME_STRING_VALUE");
headers_data.put("Authorization", "Bearer REPLACE_BEARER_TOKEN");
response = invokeUrl
[
url: "https://business.arattai.in/api/v1/businessnumbers/BUSINESS_NUMBER_ID/miniappsorder"
type: POST
headers: headers_data
content-type: application/json
parameters: parameters_data
connection: <connection_name>
];
info response;

OkHttpClient client = new OkHttpClient();

MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{\"field1\":\"value1\",\"field2\":\"value2\"}");
Request request = new Request.Builder()
  .url("https://business.arattai.in/api/v1/businessnumbers/BUSINESS_NUMBER_ID/miniappsorder")
  .post(body)
  .addHeader("Arattai-CompanyId", "SOME_STRING_VALUE")
  .addHeader("Authorization", "Bearer REPLACE_BEARER_TOKEN")
  .addHeader("content-type", "application/json")
  .build();

Response response = client.newCall(request).execute();

const options = {
  method: 'POST',
  headers: {
    'Arattai-CompanyId': 'SOME_STRING_VALUE',
    Authorization: 'Bearer REPLACE_BEARER_TOKEN',
    'content-type': 'application/json'
  },
  body: '{"field1":"value1","field2":"value2"}'
};

fetch('https://business.arattai.in/api/v1/businessnumbers/BUSINESS_NUMBER_ID/miniappsorder', options)
  .then(response => response.json())
  .then(response => console.log(response))
  .catch(err => console.error(err));

import http.client

conn = http.client.HTTPSConnection("business.arattai.in")

payload = "{\"field1\":\"value1\",\"field2\":\"value2\"}"

headers = {
    'Arattai-CompanyId': "SOME_STRING_VALUE",
    'Authorization': "Bearer REPLACE_BEARER_TOKEN",
    'content-type': "application/json"
    }

conn.request("POST", "/api/v1/businessnumbers/BUSINESS_NUMBER_ID/miniappsorder", payload, headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))

const http = require("https");

const options = {
  "method": "POST",
  "hostname": "business.arattai.in",
  "port": null,
  "path": "/api/v1/businessnumbers/BUSINESS_NUMBER_ID/miniappsorder",
  "headers": {
    "Arattai-CompanyId": "SOME_STRING_VALUE",
    "Authorization": "Bearer REPLACE_BEARER_TOKEN",
    "content-type": "application/json"
  }
};

const req = http.request(options, function (res) {
  const chunks = [];

  res.on("data", function (chunk) {
    chunks.push(chunk);
  });

  res.on("end", function () {
    const body = Buffer.concat(chunks);
    console.log(body.toString());
  });
});

req.write(JSON.stringify({field1: 'value1', field2: 'value2'}));
req.end();

var client = new RestClient("https://business.arattai.in/api/v1/businessnumbers/BUSINESS_NUMBER_ID/miniappsorder");
var request = new RestRequest(Method.POST);
request.AddHeader("Arattai-CompanyId", "SOME_STRING_VALUE");
request.AddHeader("Authorization", "Bearer REPLACE_BEARER_TOKEN");
request.AddHeader("content-type", "application/json");
request.AddParameter("application/json", "{\"field1\":\"value1\",\"field2\":\"value2\"}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);

var client = new HttpClient();
var request = new HttpRequestMessage
{
    Method = HttpMethod.Post,
    RequestUri = new Uri("https://business.arattai.in/api/v1/businessnumbers/BUSINESS_NUMBER_ID/miniappsorder"),
    Headers =
    {
        { "Arattai-CompanyId", "SOME_STRING_VALUE" },
        { "Authorization", "Bearer REPLACE_BEARER_TOKEN" },
    },
    Content = new StringContent("{\"field1\":\"value1\",\"field2\":\"value2\"}")
    {
        Headers =
        {
            ContentType = new MediaTypeHeaderValue("application/json")
        }
    }
};
using (var response = await client.SendAsync(request))
{
    response.EnsureSuccessStatusCode();
    var body = await response.Content.ReadAsStringAsync();
    Console.WriteLine(body);
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io/ioutil"
)

func main() {

	url := "https://business.arattai.in/api/v1/businessnumbers/BUSINESS_NUMBER_ID/miniappsorder"

	payload := strings.NewReader("{\"field1\":\"value1\",\"field2\":\"value2\"}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Arattai-CompanyId", "SOME_STRING_VALUE")
	req.Header.Add("Authorization", "Bearer REPLACE_BEARER_TOKEN")
	req.Header.Add("content-type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}

const data = JSON.stringify({
  "field1": "value1",
  "field2": "value2"
});

const xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("POST", "https://business.arattai.in/api/v1/businessnumbers/BUSINESS_NUMBER_ID/miniappsorder");
xhr.setRequestHeader("Arattai-CompanyId", "SOME_STRING_VALUE");
xhr.setRequestHeader("Authorization", "Bearer REPLACE_BEARER_TOKEN");
xhr.setRequestHeader("content-type", "application/json");

xhr.send(data);

curl --request POST \
  --url https://business.arattai.in/api/v1/businessnumbers/BUSINESS_NUMBER_ID/miniappsorder \
  --header 'Arattai-CompanyId: SOME_STRING_VALUE' \
  --header 'Authorization: Bearer REPLACE_BEARER_TOKEN' \
  --header 'content-type: application/json' \
  --data '{"field1":"value1","field2":"value2"}'

{
    "ids": [
        501000000005003,
        501000000005001,
        501000000005002
    ]
}

Response Example

{
    "code": "invalid_input",
    "message": "One or more miniapps are not pinned to this number"
}

{
    "code": "invalid_oauthtoken",
    "message": "You are not authenticated to do this operation"
}

{
    "code": "not_found",
    "message": "The requested resource was not found"
}

{
    "code": "invalid_method",
    "message": "Invalid method"
}

Get Number Summary AI Tools

Open in ChatGPT

Open in ChatGPT to ask questions about this page

Open in Claude

Open in Claude to ask questions about this page

Copy as Markdown

Copy this page as markdown to use with AI assistants

View as Markdown

Open this page as markdown in a new tab

Returns the total count of active (non-deleted) business numbers and a breakdown by business. Deleted numbers are excluded. Keys in by_business are business reference_id strings (base36). Businesses with zero active numbers are omitted.

Rate Limits

Threshold Limit (Number of API calls allowed within a minute) - 30 requests per minute
Lock Period (Wait time before consecutive API requests) - 10 minutes

OAuth Scope : ArattaiBusiness.phonenumbers.READ

Headers

Arattai-CompanyId

string

(Required)

The unique identifier of the company for this request.

Request Example

headers_data = Map();
headers_data.put("Arattai-CompanyId", "SOME_STRING_VALUE");
headers_data.put("Authorization", "Bearer REPLACE_BEARER_TOKEN");
response = invokeUrl
[
url: "https://business.arattai.in/api/v1/numbersummary"
type: GET
headers: headers_data
connection: <connection_name>
];
info response;

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://business.arattai.in/api/v1/numbersummary")
  .get()
  .addHeader("Arattai-CompanyId", "SOME_STRING_VALUE")
  .addHeader("Authorization", "Bearer REPLACE_BEARER_TOKEN")
  .build();

Response response = client.newCall(request).execute();

const options = {
  method: 'GET',
  headers: {
    'Arattai-CompanyId': 'SOME_STRING_VALUE',
    Authorization: 'Bearer REPLACE_BEARER_TOKEN'
  }
};

fetch('https://business.arattai.in/api/v1/numbersummary', options)
  .then(response => response.json())
  .then(response => console.log(response))
  .catch(err => console.error(err));

import http.client

conn = http.client.HTTPSConnection("business.arattai.in")

headers = {
    'Arattai-CompanyId': "SOME_STRING_VALUE",
    'Authorization': "Bearer REPLACE_BEARER_TOKEN"
    }

conn.request("GET", "/api/v1/numbersummary", headers=headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))

const http = require("https");

const options = {
  "method": "GET",
  "hostname": "business.arattai.in",
  "port": null,
  "path": "/api/v1/numbersummary",
  "headers": {
    "Arattai-CompanyId": "SOME_STRING_VALUE",
    "Authorization": "Bearer REPLACE_BEARER_TOKEN"
  }
};

const req = http.request(options, function (res) {
  const chunks = [];

  res.on("data", function (chunk) {
    chunks.push(chunk);
  });

  res.on("end", function () {
    const body = Buffer.concat(chunks);
    console.log(body.toString());
  });
});

req.end();

var client = new RestClient("https://business.arattai.in/api/v1/numbersummary");
var request = new RestRequest(Method.GET);
request.AddHeader("Arattai-CompanyId", "SOME_STRING_VALUE");
request.AddHeader("Authorization", "Bearer REPLACE_BEARER_TOKEN");
IRestResponse response = client.Execute(request);

var client = new HttpClient();
var request = new HttpRequestMessage
{
    Method = HttpMethod.Get,
    RequestUri = new Uri("https://business.arattai.in/api/v1/numbersummary"),
    Headers =
    {
        { "Arattai-CompanyId", "SOME_STRING_VALUE" },
        { "Authorization", "Bearer REPLACE_BEARER_TOKEN" },
    },
};
using (var response = await client.SendAsync(request))
{
    response.EnsureSuccessStatusCode();
    var body = await response.Content.ReadAsStringAsync();
    Console.WriteLine(body);
}

package main

import (
	"fmt"
	"net/http"
	"io/ioutil"
)

func main() {

	url := "https://business.arattai.in/api/v1/numbersummary"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Arattai-CompanyId", "SOME_STRING_VALUE")
	req.Header.Add("Authorization", "Bearer REPLACE_BEARER_TOKEN")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}

const data = null;

const xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://business.arattai.in/api/v1/numbersummary");
xhr.setRequestHeader("Arattai-CompanyId", "SOME_STRING_VALUE");
xhr.setRequestHeader("Authorization", "Bearer REPLACE_BEARER_TOKEN");

xhr.send(data);

curl --request GET \
  --url https://business.arattai.in/api/v1/numbersummary \
  --header 'Arattai-CompanyId: SOME_STRING_VALUE' \
  --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'

Response Example

{
    "url": "/api/v1/numbersummary",
    "data": {
        "total": 18,
        "by_business": {
            "4XL880KMF5": 5,
            "9QT221ZRP3": 13
        }
    }
}

{
    "code": "invalid_input",
    "message": "Either the input stream or parameter is invalid or absent"
}

{
    "code": "invalid_oauthtoken",
    "message": "You are not authenticated to do this operation"
}

{
    "code": "invalid_method",
    "message": "Invalid method"
}

Submit Display Name for Review AI Tools

Open in ChatGPT

Open in ChatGPT to ask questions about this page

Open in Claude

Open in Claude to ask questions about this page

Copy as Markdown

Copy this page as markdown to use with AI assistants

View as Markdown

Open this page as markdown in a new tab

Submit a new display name for admin review. The new name becomes the live display_name immediately, status is set to "in_progress", and the submission enters admin review asynchronously. The published_name is not touched; it is set only on admin approval.

⚠

NoteOnly one pending review is allowed at a time. Submitting while status is already "in_progress" returns 403 invalid_operation. This endpoint requires OAuth scope businesses (not phonenumbers).

Throttle: 10 requests per minute. 10-minute lockout after threshold is hit.

Rate Limits

Threshold Limit (Number of API calls allowed within a minute) - 10 requests per minute
Lock Period (Wait time before consecutive API requests) - 10 minutes

OAuth Scope : ArattaiBusiness.businesses.CREATE

Arguments

display_name

string

(Required)

Proposed new display name to submit for admin review. Maximum 100 characters.

Path Parameters

string

(Required)

Business number reference ID.

Headers

Arattai-CompanyId

string

(Required)

The unique identifier of the company for this request.

Request Example

parameters_data='{"field1":"value1","field2":"value2"}';
headers_data = Map();
headers_data.put("Arattai-CompanyId", "SOME_STRING_VALUE");
headers_data.put("Authorization", "Bearer REPLACE_BEARER_TOKEN");
response = invokeUrl
[
url: "https://business.arattai.in/api/v1/businessnumbers/BUSINESS_NUMBER_ID/displayname/submit"
type: POST
headers: headers_data
content-type: application/json
parameters: parameters_data
connection: <connection_name>
];
info response;

OkHttpClient client = new OkHttpClient();

MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{\"field1\":\"value1\",\"field2\":\"value2\"}");
Request request = new Request.Builder()
  .url("https://business.arattai.in/api/v1/businessnumbers/BUSINESS_NUMBER_ID/displayname/submit")
  .post(body)
  .addHeader("Arattai-CompanyId", "SOME_STRING_VALUE")
  .addHeader("Authorization", "Bearer REPLACE_BEARER_TOKEN")
  .addHeader("content-type", "application/json")
  .build();

Response response = client.newCall(request).execute();

const options = {
  method: 'POST',
  headers: {
    'Arattai-CompanyId': 'SOME_STRING_VALUE',
    Authorization: 'Bearer REPLACE_BEARER_TOKEN',
    'content-type': 'application/json'
  },
  body: '{"field1":"value1","field2":"value2"}'
};

fetch('https://business.arattai.in/api/v1/businessnumbers/BUSINESS_NUMBER_ID/displayname/submit', options)
  .then(response => response.json())
  .then(response => console.log(response))
  .catch(err => console.error(err));

import http.client

conn = http.client.HTTPSConnection("business.arattai.in")

payload = "{\"field1\":\"value1\",\"field2\":\"value2\"}"

headers = {
    'Arattai-CompanyId': "SOME_STRING_VALUE",
    'Authorization': "Bearer REPLACE_BEARER_TOKEN",
    'content-type': "application/json"
    }

conn.request("POST", "/api/v1/businessnumbers/BUSINESS_NUMBER_ID/displayname/submit", payload, headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))

const http = require("https");

const options = {
  "method": "POST",
  "hostname": "business.arattai.in",
  "port": null,
  "path": "/api/v1/businessnumbers/BUSINESS_NUMBER_ID/displayname/submit",
  "headers": {
    "Arattai-CompanyId": "SOME_STRING_VALUE",
    "Authorization": "Bearer REPLACE_BEARER_TOKEN",
    "content-type": "application/json"
  }
};

const req = http.request(options, function (res) {
  const chunks = [];

  res.on("data", function (chunk) {
    chunks.push(chunk);
  });

  res.on("end", function () {
    const body = Buffer.concat(chunks);
    console.log(body.toString());
  });
});

req.write(JSON.stringify({field1: 'value1', field2: 'value2'}));
req.end();

var client = new RestClient("https://business.arattai.in/api/v1/businessnumbers/BUSINESS_NUMBER_ID/displayname/submit");
var request = new RestRequest(Method.POST);
request.AddHeader("Arattai-CompanyId", "SOME_STRING_VALUE");
request.AddHeader("Authorization", "Bearer REPLACE_BEARER_TOKEN");
request.AddHeader("content-type", "application/json");
request.AddParameter("application/json", "{\"field1\":\"value1\",\"field2\":\"value2\"}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);

var client = new HttpClient();
var request = new HttpRequestMessage
{
    Method = HttpMethod.Post,
    RequestUri = new Uri("https://business.arattai.in/api/v1/businessnumbers/BUSINESS_NUMBER_ID/displayname/submit"),
    Headers =
    {
        { "Arattai-CompanyId", "SOME_STRING_VALUE" },
        { "Authorization", "Bearer REPLACE_BEARER_TOKEN" },
    },
    Content = new StringContent("{\"field1\":\"value1\",\"field2\":\"value2\"}")
    {
        Headers =
        {
            ContentType = new MediaTypeHeaderValue("application/json")
        }
    }
};
using (var response = await client.SendAsync(request))
{
    response.EnsureSuccessStatusCode();
    var body = await response.Content.ReadAsStringAsync();
    Console.WriteLine(body);
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io/ioutil"
)

func main() {

	url := "https://business.arattai.in/api/v1/businessnumbers/BUSINESS_NUMBER_ID/displayname/submit"

	payload := strings.NewReader("{\"field1\":\"value1\",\"field2\":\"value2\"}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Arattai-CompanyId", "SOME_STRING_VALUE")
	req.Header.Add("Authorization", "Bearer REPLACE_BEARER_TOKEN")
	req.Header.Add("content-type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}

const data = JSON.stringify({
  "field1": "value1",
  "field2": "value2"
});

const xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("POST", "https://business.arattai.in/api/v1/businessnumbers/BUSINESS_NUMBER_ID/displayname/submit");
xhr.setRequestHeader("Arattai-CompanyId", "SOME_STRING_VALUE");
xhr.setRequestHeader("Authorization", "Bearer REPLACE_BEARER_TOKEN");
xhr.setRequestHeader("content-type", "application/json");

xhr.send(data);

curl --request POST \
  --url https://business.arattai.in/api/v1/businessnumbers/BUSINESS_NUMBER_ID/displayname/submit \
  --header 'Arattai-CompanyId: SOME_STRING_VALUE' \
  --header 'Authorization: Bearer REPLACE_BEARER_TOKEN' \
  --header 'content-type: application/json' \
  --data '{"field1":"value1","field2":"value2"}'

{
    "display_name": "Northbrook Support"
}

Response Example

{
    "code": "invalid_input",
    "message": "display_name is required"
}

{
    "code": "invalid_oauthtoken",
    "message": "You are not authenticated to do this operation"
}

{
    "code": "invalid_operation",
    "message": "This action is not allowed"
}

{
    "code": "not_found",
    "message": "The requested resource was not found"
}

{
    "code": "invalid_method",
    "message": "Invalid method"
}

{
    "code": "too_many_requests",
    "message": "You have reached the maximum number of requests"
}

Revoke Display Name Review AI Tools

Open in ChatGPT

Open in ChatGPT to ask questions about this page

Open in Claude

Open in Claude to ask questions about this page

Copy as Markdown

Copy this page as markdown to use with AI assistants

View as Markdown

Open this page as markdown in a new tab

Withdraw a pending display name review. Resets status to "unverified". display_name and published_name are left unchanged; the submitted name stays live.

Only allowed when status is "in_progress". Otherwise returns 400 invalid_operation.

⚠

NoteThis endpoint requires OAuth scope businesses (not phonenumbers). The {id} is the business number reference_id.

Throttle: 10 requests per minute. 10-minute lockout after threshold is hit.

Rate Limits

Threshold Limit (Number of API calls allowed within a minute) - 10 requests per minute
Lock Period (Wait time before consecutive API requests) - 10 minutes

OAuth Scope : ArattaiBusiness.businesses.CREATE

Path Parameters

string

(Required)

Business number reference ID.

Headers

Arattai-CompanyId

string

(Required)

The unique identifier of the company for this request.

Request Example

headers_data = Map();
headers_data.put("Arattai-CompanyId", "SOME_STRING_VALUE");
headers_data.put("Authorization", "Bearer REPLACE_BEARER_TOKEN");
response = invokeUrl
[
url: "https://business.arattai.in/api/v1/businessnumbers/BUSINESS_NUMBER_ID/displayname/revoke"
type: POST
headers: headers_data
connection: <connection_name>
];
info response;

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://business.arattai.in/api/v1/businessnumbers/BUSINESS_NUMBER_ID/displayname/revoke")
  .post(null)
  .addHeader("Arattai-CompanyId", "SOME_STRING_VALUE")
  .addHeader("Authorization", "Bearer REPLACE_BEARER_TOKEN")
  .build();

Response response = client.newCall(request).execute();

const options = {
  method: 'POST',
  headers: {
    'Arattai-CompanyId': 'SOME_STRING_VALUE',
    Authorization: 'Bearer REPLACE_BEARER_TOKEN'
  }
};

fetch('https://business.arattai.in/api/v1/businessnumbers/BUSINESS_NUMBER_ID/displayname/revoke', options)
  .then(response => response.json())
  .then(response => console.log(response))
  .catch(err => console.error(err));

import http.client

conn = http.client.HTTPSConnection("business.arattai.in")

headers = {
    'Arattai-CompanyId': "SOME_STRING_VALUE",
    'Authorization': "Bearer REPLACE_BEARER_TOKEN"
    }

conn.request("POST", "/api/v1/businessnumbers/BUSINESS_NUMBER_ID/displayname/revoke", headers=headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))

const http = require("https");

const options = {
  "method": "POST",
  "hostname": "business.arattai.in",
  "port": null,
  "path": "/api/v1/businessnumbers/BUSINESS_NUMBER_ID/displayname/revoke",
  "headers": {
    "Arattai-CompanyId": "SOME_STRING_VALUE",
    "Authorization": "Bearer REPLACE_BEARER_TOKEN"
  }
};

const req = http.request(options, function (res) {
  const chunks = [];

  res.on("data", function (chunk) {
    chunks.push(chunk);
  });

  res.on("end", function () {
    const body = Buffer.concat(chunks);
    console.log(body.toString());
  });
});

req.end();

var client = new RestClient("https://business.arattai.in/api/v1/businessnumbers/BUSINESS_NUMBER_ID/displayname/revoke");
var request = new RestRequest(Method.POST);
request.AddHeader("Arattai-CompanyId", "SOME_STRING_VALUE");
request.AddHeader("Authorization", "Bearer REPLACE_BEARER_TOKEN");
IRestResponse response = client.Execute(request);

var client = new HttpClient();
var request = new HttpRequestMessage
{
    Method = HttpMethod.Post,
    RequestUri = new Uri("https://business.arattai.in/api/v1/businessnumbers/BUSINESS_NUMBER_ID/displayname/revoke"),
    Headers =
    {
        { "Arattai-CompanyId", "SOME_STRING_VALUE" },
        { "Authorization", "Bearer REPLACE_BEARER_TOKEN" },
    },
};
using (var response = await client.SendAsync(request))
{
    response.EnsureSuccessStatusCode();
    var body = await response.Content.ReadAsStringAsync();
    Console.WriteLine(body);
}

package main

import (
	"fmt"
	"net/http"
	"io/ioutil"
)

func main() {

	url := "https://business.arattai.in/api/v1/businessnumbers/BUSINESS_NUMBER_ID/displayname/revoke"

	req, _ := http.NewRequest("POST", url, nil)

	req.Header.Add("Arattai-CompanyId", "SOME_STRING_VALUE")
	req.Header.Add("Authorization", "Bearer REPLACE_BEARER_TOKEN")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}

const data = null;

const xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("POST", "https://business.arattai.in/api/v1/businessnumbers/BUSINESS_NUMBER_ID/displayname/revoke");
xhr.setRequestHeader("Arattai-CompanyId", "SOME_STRING_VALUE");
xhr.setRequestHeader("Authorization", "Bearer REPLACE_BEARER_TOKEN");

xhr.send(data);

curl --request POST \
  --url https://business.arattai.in/api/v1/businessnumbers/BUSINESS_NUMBER_ID/displayname/revoke \
  --header 'Arattai-CompanyId: SOME_STRING_VALUE' \
  --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'

Response Example

{
    "code": "invalid_input",
    "message": "Either the input stream or parameter is invalid or absent"
}

{
    "code": "invalid_oauthtoken",
    "message": "You are not authenticated to do this operation"
}

{
    "code": "invalid_operation",
    "message": "This action is not allowed"
}

{
    "code": "not_found",
    "message": "The requested resource was not found"
}

{
    "code": "invalid_method",
    "message": "Invalid method"
}

{
    "code": "too_many_requests",
    "message": "You have reached the maximum number of requests"
}

Business Numbers AI Tools Open in ChatGPT Open in ChatGPT to ask questions about this page Open in Claude Open in Claude to ask questions about this page Copy as Markdown Copy this page as markdown to use with AI assistants View as Markdown Open this page as markdown in a new tab

Attribute

Update a Business Number AI Tools Open in ChatGPT Open in ChatGPT to ask questions about this page Open in Claude Open in Claude to ask questions about this page Copy as Markdown Copy this page as markdown to use with AI assistants View as Markdown Open this page as markdown in a new tab

Arguments

Path Parameters

Headers

Get a Business Number AI Tools Open in ChatGPT Open in ChatGPT to ask questions about this page Open in Claude Open in Claude to ask questions about this page Copy as Markdown Copy this page as markdown to use with AI assistants View as Markdown Open this page as markdown in a new tab

Path Parameters

Query Parameters

Headers

Delete a Business Number AI Tools Open in ChatGPT Open in ChatGPT to ask questions about this page Open in Claude Open in Claude to ask questions about this page Copy as Markdown Copy this page as markdown to use with AI assistants View as Markdown Open this page as markdown in a new tab

Path Parameters

Headers

List all Business Numbers AI Tools Open in ChatGPT Open in ChatGPT to ask questions about this page Open in Claude Open in Claude to ask questions about this page Copy as Markdown Copy this page as markdown to use with AI assistants View as Markdown Open this page as markdown in a new tab

Query Parameters

Headers

Path Parameters

Query Parameters

Headers

Upload Business Number Logo AI Tools Open in ChatGPT Open in ChatGPT to ask questions about this page Open in Claude Open in Claude to ask questions about this page Copy as Markdown Copy this page as markdown to use with AI assistants View as Markdown Open this page as markdown in a new tab

Arguments

Path Parameters

Headers

Delete Business Number Logo AI Tools Open in ChatGPT Open in ChatGPT to ask questions about this page Open in Claude Open in Claude to ask questions about this page Copy as Markdown Copy this page as markdown to use with AI assistants View as Markdown Open this page as markdown in a new tab

Path Parameters

Headers

Download Business Number Logo AI Tools Open in ChatGPT Open in ChatGPT to ask questions about this page Open in Claude Open in Claude to ask questions about this page Copy as Markdown Copy this page as markdown to use with AI assistants View as Markdown Open this page as markdown in a new tab

Path Parameters

Check Phone Number in Arattai AI Tools Open in ChatGPT Open in ChatGPT to ask questions about this page Open in Claude Open in Claude to ask questions about this page Copy as Markdown Copy this page as markdown to use with AI assistants View as Markdown Open this page as markdown in a new tab

Path Parameters

Headers

Path Parameters

Headers

Check Username Availability AI Tools Open in ChatGPT Open in ChatGPT to ask questions about this page Open in Claude Open in Claude to ask questions about this page Copy as Markdown Copy this page as markdown to use with AI assistants View as Markdown Open this page as markdown in a new tab

Path Parameters

Headers

Upload Profile Picture AI Tools Open in ChatGPT Open in ChatGPT to ask questions about this page Open in Claude Open in Claude to ask questions about this page Copy as Markdown Copy this page as markdown to use with AI assistants View as Markdown Open this page as markdown in a new tab

Arguments

Path Parameters

Headers

Add Cover Images AI Tools Open in ChatGPT Open in ChatGPT to ask questions about this page Open in Claude Open in Claude to ask questions about this page Copy as Markdown Copy this page as markdown to use with AI assistants View as Markdown Open this page as markdown in a new tab

Arguments

Path Parameters

Headers

List Cover Image IDs AI Tools Open in ChatGPT Open in ChatGPT to ask questions about this page Open in Claude Open in Claude to ask questions about this page Copy as Markdown Copy this page as markdown to use with AI assistants View as Markdown Open this page as markdown in a new tab

Path Parameters

Headers

Path Parameters

Delete a Cover Image AI Tools Open in ChatGPT Open in ChatGPT to ask questions about this page Open in Claude Open in Claude to ask questions about this page Copy as Markdown Copy this page as markdown to use with AI assistants View as Markdown Open this page as markdown in a new tab

Path Parameters

Headers

Set Pinned Miniapps for a Number AI Tools Open in ChatGPT Open in ChatGPT to ask questions about this page Open in Claude Open in Claude to ask questions about this page Copy as Markdown Copy this page as markdown to use with AI assistants View as Markdown Open this page as markdown in a new tab

Arguments

Path Parameters

Headers

Get Pinned Miniapps for a Number AI Tools Open in ChatGPT Open in ChatGPT to ask questions about this page Open in Claude Open in Claude to ask questions about this page Copy as Markdown Copy this page as markdown to use with AI assistants View as Markdown Open this page as markdown in a new tab

Path Parameters

Headers

Reorder Pinned Miniapps AI Tools Open in ChatGPT Open in ChatGPT to ask questions about this page Open in Claude Open in Claude to ask questions about this page Copy as Markdown Copy this page as markdown to use with AI assistants View as Markdown Open this page as markdown in a new tab

Arguments

Path Parameters

Headers

Get Number Summary AI Tools Open in ChatGPT Open in ChatGPT to ask questions about this page Open in Claude Open in Claude to ask questions about this page Copy as Markdown Copy this page as markdown to use with AI assistants View as Markdown Open this page as markdown in a new tab

Headers

Submit Display Name for Review AI Tools Open in ChatGPT Open in ChatGPT to ask questions about this page Open in Claude Open in Claude to ask questions about this page Copy as Markdown Copy this page as markdown to use with AI assistants View as Markdown Open this page as markdown in a new tab

Arguments

Path Parameters

Headers

Revoke Display Name Review AI Tools Open in ChatGPT Open in ChatGPT to ask questions about this page Open in Claude Open in Claude to ask questions about this page Copy as Markdown Copy this page as markdown to use with AI assistants View as Markdown Open this page as markdown in a new tab

Path Parameters

Headers

Business Numbers AI Tools

Open in ChatGPT

Open in ChatGPT to ask questions about this page

Open in Claude

Open in Claude to ask questions about this page

Copy as Markdown

Copy this page as markdown to use with AI assistants

View as Markdown

Open this page as markdown in a new tab

Update a Business Number AI Tools

Open in ChatGPT

Open in ChatGPT to ask questions about this page

Open in Claude

Open in Claude to ask questions about this page

Copy as Markdown

Copy this page as markdown to use with AI assistants

View as Markdown

Open this page as markdown in a new tab

Get a Business Number AI Tools

Open in ChatGPT

Open in ChatGPT to ask questions about this page

Open in Claude

Open in Claude to ask questions about this page

Copy as Markdown

Copy this page as markdown to use with AI assistants

View as Markdown

Open this page as markdown in a new tab

Delete a Business Number AI Tools

Open in ChatGPT

Open in ChatGPT to ask questions about this page

Open in Claude

Open in Claude to ask questions about this page

Copy as Markdown

Copy this page as markdown to use with AI assistants

View as Markdown

Open this page as markdown in a new tab

List all Business Numbers AI Tools

Open in ChatGPT

Open in ChatGPT to ask questions about this page

Open in Claude

Open in Claude to ask questions about this page

Copy as Markdown

Copy this page as markdown to use with AI assistants

View as Markdown

Open this page as markdown in a new tab

Upload Business Number Logo AI Tools

Open in ChatGPT

Open in ChatGPT to ask questions about this page

Open in Claude

Open in Claude to ask questions about this page

Copy as Markdown

Copy this page as markdown to use with AI assistants

View as Markdown

Open this page as markdown in a new tab

Delete Business Number Logo AI Tools

Open in ChatGPT

Open in ChatGPT to ask questions about this page

Open in Claude

Open in Claude to ask questions about this page

Copy as Markdown

Copy this page as markdown to use with AI assistants

View as Markdown

Open this page as markdown in a new tab

Check Username Availability AI Tools

Open in ChatGPT

Open in ChatGPT to ask questions about this page

Open in Claude

Open in Claude to ask questions about this page

Copy as Markdown

Copy this page as markdown to use with AI assistants

View as Markdown

Open this page as markdown in a new tab

Upload Profile Picture AI Tools

Open in ChatGPT

Open in ChatGPT to ask questions about this page

Open in Claude

Open in Claude to ask questions about this page

Copy as Markdown

Copy this page as markdown to use with AI assistants

View as Markdown

Open this page as markdown in a new tab

Add Cover Images AI Tools

Open in ChatGPT

Open in ChatGPT to ask questions about this page

Open in Claude

Open in Claude to ask questions about this page

Copy as Markdown

Copy this page as markdown to use with AI assistants

View as Markdown

Open this page as markdown in a new tab

List Cover Image IDs AI Tools

Open in ChatGPT

Open in ChatGPT to ask questions about this page

Open in Claude

Open in Claude to ask questions about this page

Copy as Markdown

Copy this page as markdown to use with AI assistants

View as Markdown

Open this page as markdown in a new tab

Delete a Cover Image AI Tools

Open in ChatGPT

Open in ChatGPT to ask questions about this page

Open in Claude

Open in Claude to ask questions about this page

Copy as Markdown

Copy this page as markdown to use with AI assistants

View as Markdown

Open this page as markdown in a new tab

Reorder Pinned Miniapps AI Tools

Open in ChatGPT

Open in ChatGPT to ask questions about this page

Open in Claude

Open in Claude to ask questions about this page

Copy as Markdown

Copy this page as markdown to use with AI assistants

View as Markdown

Open this page as markdown in a new tab

Get Number Summary AI Tools

Open in ChatGPT

Open in ChatGPT to ask questions about this page

Open in Claude

Open in Claude to ask questions about this page

Copy as Markdown

Copy this page as markdown to use with AI assistants

View as Markdown

Open this page as markdown in a new tab

Revoke Display Name Review AI Tools

Open in ChatGPT

Open in ChatGPT to ask questions about this page

Open in Claude

Open in Claude to ask questions about this page

Copy as Markdown

Copy this page as markdown to use with AI assistants

View as Markdown

Open this page as markdown in a new tab