Create Sheets Spreadsheet
curl --request POST \
--url https://api.example.com/api/v1/integrations/{connection_id}/sheets/spreadsheets \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <api-key>' \
--data '
{
"title": "<string>",
"headers": [
"<string>"
],
"sheet_name": ""
}
'import requests
url = "https://api.example.com/api/v1/integrations/{connection_id}/sheets/spreadsheets"
payload = {
"title": "<string>",
"headers": ["<string>"],
"sheet_name": ""
}
headers = {
"X-API-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({title: '<string>', headers: ['<string>'], sheet_name: ''})
};
fetch('https://api.example.com/api/v1/integrations/{connection_id}/sheets/spreadsheets', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.example.com/api/v1/integrations/{connection_id}/sheets/spreadsheets",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'title' => '<string>',
'headers' => [
'<string>'
],
'sheet_name' => ''
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-API-Key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.example.com/api/v1/integrations/{connection_id}/sheets/spreadsheets"
payload := strings.NewReader("{\n \"title\": \"<string>\",\n \"headers\": [\n \"<string>\"\n ],\n \"sheet_name\": \"\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-API-Key", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.example.com/api/v1/integrations/{connection_id}/sheets/spreadsheets")
.header("X-API-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"title\": \"<string>\",\n \"headers\": [\n \"<string>\"\n ],\n \"sheet_name\": \"\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/api/v1/integrations/{connection_id}/sheets/spreadsheets")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"title\": \"<string>\",\n \"headers\": [\n \"<string>\"\n ],\n \"sheet_name\": \"\"\n}"
response = http.request(request)
puts response.read_body{
"sheets": [
"<string>"
],
"sheet_name": "",
"columns": [
"<string>"
],
"title": "",
"spreadsheet_id": "",
"preview_header": [
"<string>"
],
"preview_rows": [
[
"<string>"
]
],
"row_count": 123,
"url": ""
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>"
}
]
}Integrations
Create Sheets Spreadsheet
Create a spreadsheet with a header row, for “new spreadsheet for this agent”.
Only for a connection signed in with the drive.file grant: the app may
create files there and reach them without the Picker. A service account
would create the file in its own Drive, where the customer never sees it,
and an older whole-Sheets sign-in is asked to sign in again anyway.
POST
/
api
/
v1
/
integrations
/
{connection_id}
/
sheets
/
spreadsheets
Create Sheets Spreadsheet
curl --request POST \
--url https://api.example.com/api/v1/integrations/{connection_id}/sheets/spreadsheets \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <api-key>' \
--data '
{
"title": "<string>",
"headers": [
"<string>"
],
"sheet_name": ""
}
'import requests
url = "https://api.example.com/api/v1/integrations/{connection_id}/sheets/spreadsheets"
payload = {
"title": "<string>",
"headers": ["<string>"],
"sheet_name": ""
}
headers = {
"X-API-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({title: '<string>', headers: ['<string>'], sheet_name: ''})
};
fetch('https://api.example.com/api/v1/integrations/{connection_id}/sheets/spreadsheets', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.example.com/api/v1/integrations/{connection_id}/sheets/spreadsheets",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'title' => '<string>',
'headers' => [
'<string>'
],
'sheet_name' => ''
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-API-Key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.example.com/api/v1/integrations/{connection_id}/sheets/spreadsheets"
payload := strings.NewReader("{\n \"title\": \"<string>\",\n \"headers\": [\n \"<string>\"\n ],\n \"sheet_name\": \"\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-API-Key", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.example.com/api/v1/integrations/{connection_id}/sheets/spreadsheets")
.header("X-API-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"title\": \"<string>\",\n \"headers\": [\n \"<string>\"\n ],\n \"sheet_name\": \"\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/api/v1/integrations/{connection_id}/sheets/spreadsheets")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"title\": \"<string>\",\n \"headers\": [\n \"<string>\"\n ],\n \"sheet_name\": \"\"\n}"
response = http.request(request)
puts response.read_body{
"sheets": [
"<string>"
],
"sheet_name": "",
"columns": [
"<string>"
],
"title": "",
"spreadsheet_id": "",
"preview_header": [
"<string>"
],
"preview_rows": [
[
"<string>"
]
],
"row_count": 123,
"url": ""
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>"
}
]
}Authorizations
Your organization's API key (account in the bottom-left of the dashboard → Brosbots API).
Path Parameters
Body
application/json