Skip to main content
POST
/
entities
/
name-request
Submit Name Change Request
curl --request POST \
  --url https://api.geogen.io/v1/entities/name-request \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "entityId": "abc123def456",
  "suggestedName": "Correct Company Name",
  "reason": "The current name has a typo"
}
'
import requests

url = "https://api.geogen.io/v1/entities/name-request"

payload = {
"entityId": "abc123def456",
"suggestedName": "Correct Company Name",
"reason": "The current name has a typo"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)
const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
entityId: 'abc123def456',
suggestedName: 'Correct Company Name',
reason: 'The current name has a typo'
})
};

fetch('https://api.geogen.io/v1/entities/name-request', 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.geogen.io/v1/entities/name-request",
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([
'entityId' => 'abc123def456',
'suggestedName' => 'Correct Company Name',
'reason' => 'The current name has a typo'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
package main

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

func main() {

url := "https://api.geogen.io/v1/entities/name-request"

payload := strings.NewReader("{\n \"entityId\": \"abc123def456\",\n \"suggestedName\": \"Correct Company Name\",\n \"reason\": \"The current name has a typo\"\n}")

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

req.Header.Add("Authorization", "Bearer <token>")
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.geogen.io/v1/entities/name-request")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"entityId\": \"abc123def456\",\n \"suggestedName\": \"Correct Company Name\",\n \"reason\": \"The current name has a typo\"\n}")
.asString();
require 'uri'
require 'net/http'

url = URI("https://api.geogen.io/v1/entities/name-request")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"entityId\": \"abc123def456\",\n \"suggestedName\": \"Correct Company Name\",\n \"reason\": \"The current name has a typo\"\n}"

response = http.request(request)
puts response.read_body
{
  "success": true,
  "message": "<string>"
}
{
"error": "<string>"
}
{
"error": "<string>"
}
{
"error": "<string>"
}

Authorizations

Authorization
string
header
required

API key authentication. Format: Bearer wsk_your_api_key

Body

application/json
entityId
string
required

The ID of the entity to request a name change for

suggestedName
string
required

The suggested correct name

reason
string

Optional reason for the name change

Response

Request submitted successfully

success
boolean
message
string