Adds a location to a client. - Gorelo Documentation

POST

clients

{clientId}

locations

Adds a location to a client.

curl --request POST \
  --url https://api.usw.gorelo.io/v1/clients/{clientId}/locations \
  --header 'Content-Type: application/json-patch+json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "Name": "Branch Office",
  "PhoneCountryCode": "NZ",
  "Phone": "09 123 4567",
  "PhoneExt": "<string>",
  "Address1": "12 Queen Street",
  "Address2": "<string>",
  "City": "Auckland",
  "State": "<string>",
  "Country": "New Zealand",
  "PostalCode": "1010",
  "TimeZone": "Pacific/Auckland",
  "PrimaryContactId": 123,
  "BillingContactIds": [
    123
  ],
  "IsDefault": true,
  "IsDefaultBilling": true
}
'

import requests

url = "https://api.usw.gorelo.io/v1/clients/{clientId}/locations"

payload = {
    "Name": "Branch Office",
    "PhoneCountryCode": "NZ",
    "Phone": "09 123 4567",
    "PhoneExt": "<string>",
    "Address1": "12 Queen Street",
    "Address2": "<string>",
    "City": "Auckland",
    "State": "<string>",
    "Country": "New Zealand",
    "PostalCode": "1010",
    "TimeZone": "Pacific/Auckland",
    "PrimaryContactId": 123,
    "BillingContactIds": [123],
    "IsDefault": True,
    "IsDefaultBilling": True
}
headers = {
    "X-API-Key": "<api-key>",
    "Content-Type": "application/json-patch+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-patch+json'},
  body: JSON.stringify({
    Name: 'Branch Office',
    PhoneCountryCode: 'NZ',
    Phone: '09 123 4567',
    PhoneExt: '<string>',
    Address1: '12 Queen Street',
    Address2: '<string>',
    City: 'Auckland',
    State: '<string>',
    Country: 'New Zealand',
    PostalCode: '1010',
    TimeZone: 'Pacific/Auckland',
    PrimaryContactId: 123,
    BillingContactIds: [123],
    IsDefault: true,
    IsDefaultBilling: true
  })
};

fetch('https://api.usw.gorelo.io/v1/clients/{clientId}/locations', 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.usw.gorelo.io/v1/clients/{clientId}/locations",
  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([
    'Name' => 'Branch Office',
    'PhoneCountryCode' => 'NZ',
    'Phone' => '09 123 4567',
    'PhoneExt' => '<string>',
    'Address1' => '12 Queen Street',
    'Address2' => '<string>',
    'City' => 'Auckland',
    'State' => '<string>',
    'Country' => 'New Zealand',
    'PostalCode' => '1010',
    'TimeZone' => 'Pacific/Auckland',
    'PrimaryContactId' => 123,
    'BillingContactIds' => [
        123
    ],
    'IsDefault' => true,
    'IsDefaultBilling' => true
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json-patch+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.usw.gorelo.io/v1/clients/{clientId}/locations"

	payload := strings.NewReader("{\n  \"Name\": \"Branch Office\",\n  \"PhoneCountryCode\": \"NZ\",\n  \"Phone\": \"09 123 4567\",\n  \"PhoneExt\": \"<string>\",\n  \"Address1\": \"12 Queen Street\",\n  \"Address2\": \"<string>\",\n  \"City\": \"Auckland\",\n  \"State\": \"<string>\",\n  \"Country\": \"New Zealand\",\n  \"PostalCode\": \"1010\",\n  \"TimeZone\": \"Pacific/Auckland\",\n  \"PrimaryContactId\": 123,\n  \"BillingContactIds\": [\n    123\n  ],\n  \"IsDefault\": true,\n  \"IsDefaultBilling\": true\n}")

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

	req.Header.Add("X-API-Key", "<api-key>")
	req.Header.Add("Content-Type", "application/json-patch+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.usw.gorelo.io/v1/clients/{clientId}/locations")
  .header("X-API-Key", "<api-key>")
  .header("Content-Type", "application/json-patch+json")
  .body("{\n  \"Name\": \"Branch Office\",\n  \"PhoneCountryCode\": \"NZ\",\n  \"Phone\": \"09 123 4567\",\n  \"PhoneExt\": \"<string>\",\n  \"Address1\": \"12 Queen Street\",\n  \"Address2\": \"<string>\",\n  \"City\": \"Auckland\",\n  \"State\": \"<string>\",\n  \"Country\": \"New Zealand\",\n  \"PostalCode\": \"1010\",\n  \"TimeZone\": \"Pacific/Auckland\",\n  \"PrimaryContactId\": 123,\n  \"BillingContactIds\": [\n    123\n  ],\n  \"IsDefault\": true,\n  \"IsDefaultBilling\": true\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.usw.gorelo.io/v1/clients/{clientId}/locations")

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-patch+json'
request.body = "{\n  \"Name\": \"Branch Office\",\n  \"PhoneCountryCode\": \"NZ\",\n  \"Phone\": \"09 123 4567\",\n  \"PhoneExt\": \"<string>\",\n  \"Address1\": \"12 Queen Street\",\n  \"Address2\": \"<string>\",\n  \"City\": \"Auckland\",\n  \"State\": \"<string>\",\n  \"Country\": \"New Zealand\",\n  \"PostalCode\": \"1010\",\n  \"TimeZone\": \"Pacific/Auckland\",\n  \"PrimaryContactId\": 123,\n  \"BillingContactIds\": [\n    123\n  ],\n  \"IsDefault\": true,\n  \"IsDefaultBilling\": true\n}"

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

{
  "StatusCode": 100,
  "IsSuccess": true,
  "Data": {
    "Id": 123,
    "Name": "<string>",
    "ClientId": 123,
    "CreatedOn": "2023-11-07T05:31:56Z",
    "UpdatedOn": "2023-11-07T05:31:56Z",
    "PrimaryContactId": 123,
    "PhoneCountryCode": "<string>",
    "Phone": "<string>",
    "PhoneExt": "<string>",
    "BillingContactIds": "<string>",
    "Address1": "<string>",
    "Address2": "<string>",
    "City": "<string>",
    "State": "<string>",
    "Country": "<string>",
    "PostalCode": "<string>",
    "GeoLocationLatitude": 123,
    "GeoLocationLongitude": 123,
    "TimeZone": "<string>",
    "IsDefault": true,
    "IsDefaultBilling": true
  },
  "DataContext": null,
  "Notifications": [
    {
      "Code": "070101",
      "Message": "<string>",
      "PropertyName": "<string>",
      "ActionHint": "<string>",
      "DocUrl": "<string>"
    }
  ]
}

{
  "StatusCode": 100,
  "IsSuccess": true,
  "Data": null,
  "DataContext": {
    "TraceId": "<string>"
  },
  "Notifications": [
    {
      "Code": "070101",
      "Message": "<string>",
      "PropertyName": "<string>",
      "ActionHint": "<string>",
      "DocUrl": "<string>"
    }
  ]
}

{
  "StatusCode": 100,
  "IsSuccess": true,
  "Data": null,
  "DataContext": {
    "TraceId": "<string>"
  },
  "Notifications": [
    {
      "Code": "070101",
      "Message": "<string>",
      "PropertyName": "<string>",
      "ActionHint": "<string>",
      "DocUrl": "<string>"
    }
  ]
}

{
  "StatusCode": 100,
  "IsSuccess": true,
  "Data": null,
  "DataContext": {
    "TraceId": "<string>"
  },
  "Notifications": [
    {
      "Code": "070101",
      "Message": "<string>",
      "PropertyName": "<string>",
      "ActionHint": "<string>",
      "DocUrl": "<string>"
    }
  ]
}

{
  "StatusCode": 100,
  "IsSuccess": true,
  "Data": null,
  "DataContext": {
    "TraceId": "<string>"
  },
  "Notifications": [
    {
      "Code": "070101",
      "Message": "<string>",
      "PropertyName": "<string>",
      "ActionHint": "<string>",
      "DocUrl": "<string>"
    }
  ]
}

{
  "StatusCode": 100,
  "IsSuccess": true,
  "Data": null,
  "DataContext": {
    "TraceId": "<string>"
  },
  "Notifications": [
    {
      "Code": "070101",
      "Message": "<string>",
      "PropertyName": "<string>",
      "ActionHint": "<string>",
      "DocUrl": "<string>"
    }
  ]
}

Autorizações

X-API-Key

string

header

obrigatório

Your Gorelo API key. See Generate API key. If your data is hosted in Australia, click the base URL at the top of this page and select https://api.aue.gorelo.io.

Parâmetros de caminho

clientId

integer<int64>

obrigatório

Client to add the location to.

Corpo

Location details.

Request body for adding a location to a client. The client is taken from the route.

Name

string | null

Location display name. Required, cannot be blank. Maximum 150 characters.

Exemplo:

"Branch Office"

PhoneCountryCode

string | null

Phone ISO 3166-1 alpha-2 region code (e.g. NZ, US). Required when Phone is sent. Maximum 25 characters.

Exemplo:

"NZ"

Phone

string | null

Phone number, as dialled within its country, e.g. 09 123 4567 for NZ; an international +64 9 123 4567 is accepted too. A number sent without its leading 0 is stored with it. Maximum 15 characters.

Exemplo:

"09 123 4567"

PhoneExt

string | null

Phone extension. Maximum 5 characters.

Address1

string | null

Address line 1. Maximum 150 characters.

Exemplo:

"12 Queen Street"

Address2

string | null

Address line 2. Maximum 150 characters.

City

string | null

City. Maximum 100 characters.

Exemplo:

"Auckland"

State

string | null

State / province. Maximum 100 characters.

Country

string | null

Country. Maximum 100 characters.

Exemplo:

"New Zealand"

PostalCode

string | null

Postal / ZIP code. Maximum 10 characters.

Exemplo:

"1010"

TimeZone

string | null

IANA time zone identifier for the location (e.g. Pacific/Auckland). Maximum 200 characters.

Exemplo:

"Pacific/Auckland"

PrimaryContactId

integer<int64> | null

The location's primary contact: an active contact of this client (from GET /v1/contacts?clientIds=).

BillingContactIds

integer<int64>[] | null

The location's billing contacts: active contacts of this client. At most 100; a repeated id is stored once.

IsDefault

boolean | null

Make this the client's default location. The client's current default stops being the default. Defaults to false.

IsDefaultBilling

boolean | null

Make this the client's default billing location, whose address invoices and a linked accounting system use. The current default billing location stops being it. Defaults to false.

Resposta

StatusCode

enum<integer>

Opções disponíveis:

100,

101,

102,

103,

200,

201,

202,

203,

204,

205,

206,

207,

208,

226,

300,

301,

302,

303,

304,

305,

306,

307,

308,

400,

401,

402,

403,

404,

405,

406,

407,

408,

409,

410,

411,

412,

413,

414,

415,

416,

417,

421,

422,

423,

424,

426,

428,

429,

431,

451,

500,

501,

502,

503,

504,

505,

506,

507,

508,

510,

511

IsSuccess

boolean

Data

object

A client location. Timestamps are UTC.

Show child attributes

DataContext

object | null

Exemplo:

null

Notifications

object[]

Show child attributes

⌘I

Adds a location to a client.

curl --request POST \
  --url https://api.usw.gorelo.io/v1/clients/{clientId}/locations \
  --header 'Content-Type: application/json-patch+json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "Name": "Branch Office",
  "PhoneCountryCode": "NZ",
  "Phone": "09 123 4567",
  "PhoneExt": "<string>",
  "Address1": "12 Queen Street",
  "Address2": "<string>",
  "City": "Auckland",
  "State": "<string>",
  "Country": "New Zealand",
  "PostalCode": "1010",
  "TimeZone": "Pacific/Auckland",
  "PrimaryContactId": 123,
  "BillingContactIds": [
    123
  ],
  "IsDefault": true,
  "IsDefaultBilling": true
}
'

import requests

url = "https://api.usw.gorelo.io/v1/clients/{clientId}/locations"

payload = {
    "Name": "Branch Office",
    "PhoneCountryCode": "NZ",
    "Phone": "09 123 4567",
    "PhoneExt": "<string>",
    "Address1": "12 Queen Street",
    "Address2": "<string>",
    "City": "Auckland",
    "State": "<string>",
    "Country": "New Zealand",
    "PostalCode": "1010",
    "TimeZone": "Pacific/Auckland",
    "PrimaryContactId": 123,
    "BillingContactIds": [123],
    "IsDefault": True,
    "IsDefaultBilling": True
}
headers = {
    "X-API-Key": "<api-key>",
    "Content-Type": "application/json-patch+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-patch+json'},
  body: JSON.stringify({
    Name: 'Branch Office',
    PhoneCountryCode: 'NZ',
    Phone: '09 123 4567',
    PhoneExt: '<string>',
    Address1: '12 Queen Street',
    Address2: '<string>',
    City: 'Auckland',
    State: '<string>',
    Country: 'New Zealand',
    PostalCode: '1010',
    TimeZone: 'Pacific/Auckland',
    PrimaryContactId: 123,
    BillingContactIds: [123],
    IsDefault: true,
    IsDefaultBilling: true
  })
};

fetch('https://api.usw.gorelo.io/v1/clients/{clientId}/locations', 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.usw.gorelo.io/v1/clients/{clientId}/locations",
  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([
    'Name' => 'Branch Office',
    'PhoneCountryCode' => 'NZ',
    'Phone' => '09 123 4567',
    'PhoneExt' => '<string>',
    'Address1' => '12 Queen Street',
    'Address2' => '<string>',
    'City' => 'Auckland',
    'State' => '<string>',
    'Country' => 'New Zealand',
    'PostalCode' => '1010',
    'TimeZone' => 'Pacific/Auckland',
    'PrimaryContactId' => 123,
    'BillingContactIds' => [
        123
    ],
    'IsDefault' => true,
    'IsDefaultBilling' => true
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json-patch+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.usw.gorelo.io/v1/clients/{clientId}/locations"

	payload := strings.NewReader("{\n  \"Name\": \"Branch Office\",\n  \"PhoneCountryCode\": \"NZ\",\n  \"Phone\": \"09 123 4567\",\n  \"PhoneExt\": \"<string>\",\n  \"Address1\": \"12 Queen Street\",\n  \"Address2\": \"<string>\",\n  \"City\": \"Auckland\",\n  \"State\": \"<string>\",\n  \"Country\": \"New Zealand\",\n  \"PostalCode\": \"1010\",\n  \"TimeZone\": \"Pacific/Auckland\",\n  \"PrimaryContactId\": 123,\n  \"BillingContactIds\": [\n    123\n  ],\n  \"IsDefault\": true,\n  \"IsDefaultBilling\": true\n}")

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

	req.Header.Add("X-API-Key", "<api-key>")
	req.Header.Add("Content-Type", "application/json-patch+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.usw.gorelo.io/v1/clients/{clientId}/locations")
  .header("X-API-Key", "<api-key>")
  .header("Content-Type", "application/json-patch+json")
  .body("{\n  \"Name\": \"Branch Office\",\n  \"PhoneCountryCode\": \"NZ\",\n  \"Phone\": \"09 123 4567\",\n  \"PhoneExt\": \"<string>\",\n  \"Address1\": \"12 Queen Street\",\n  \"Address2\": \"<string>\",\n  \"City\": \"Auckland\",\n  \"State\": \"<string>\",\n  \"Country\": \"New Zealand\",\n  \"PostalCode\": \"1010\",\n  \"TimeZone\": \"Pacific/Auckland\",\n  \"PrimaryContactId\": 123,\n  \"BillingContactIds\": [\n    123\n  ],\n  \"IsDefault\": true,\n  \"IsDefaultBilling\": true\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.usw.gorelo.io/v1/clients/{clientId}/locations")

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-patch+json'
request.body = "{\n  \"Name\": \"Branch Office\",\n  \"PhoneCountryCode\": \"NZ\",\n  \"Phone\": \"09 123 4567\",\n  \"PhoneExt\": \"<string>\",\n  \"Address1\": \"12 Queen Street\",\n  \"Address2\": \"<string>\",\n  \"City\": \"Auckland\",\n  \"State\": \"<string>\",\n  \"Country\": \"New Zealand\",\n  \"PostalCode\": \"1010\",\n  \"TimeZone\": \"Pacific/Auckland\",\n  \"PrimaryContactId\": 123,\n  \"BillingContactIds\": [\n    123\n  ],\n  \"IsDefault\": true,\n  \"IsDefaultBilling\": true\n}"

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

{
  "StatusCode": 100,
  "IsSuccess": true,
  "Data": {
    "Id": 123,
    "Name": "<string>",
    "ClientId": 123,
    "CreatedOn": "2023-11-07T05:31:56Z",
    "UpdatedOn": "2023-11-07T05:31:56Z",
    "PrimaryContactId": 123,
    "PhoneCountryCode": "<string>",
    "Phone": "<string>",
    "PhoneExt": "<string>",
    "BillingContactIds": "<string>",
    "Address1": "<string>",
    "Address2": "<string>",
    "City": "<string>",
    "State": "<string>",
    "Country": "<string>",
    "PostalCode": "<string>",
    "GeoLocationLatitude": 123,
    "GeoLocationLongitude": 123,
    "TimeZone": "<string>",
    "IsDefault": true,
    "IsDefaultBilling": true
  },
  "DataContext": null,
  "Notifications": [
    {
      "Code": "070101",
      "Message": "<string>",
      "PropertyName": "<string>",
      "ActionHint": "<string>",
      "DocUrl": "<string>"
    }
  ]
}

{
  "StatusCode": 100,
  "IsSuccess": true,
  "Data": null,
  "DataContext": {
    "TraceId": "<string>"
  },
  "Notifications": [
    {
      "Code": "070101",
      "Message": "<string>",
      "PropertyName": "<string>",
      "ActionHint": "<string>",
      "DocUrl": "<string>"
    }
  ]
}

{
  "StatusCode": 100,
  "IsSuccess": true,
  "Data": null,
  "DataContext": {
    "TraceId": "<string>"
  },
  "Notifications": [
    {
      "Code": "070101",
      "Message": "<string>",
      "PropertyName": "<string>",
      "ActionHint": "<string>",
      "DocUrl": "<string>"
    }
  ]
}

{
  "StatusCode": 100,
  "IsSuccess": true,
  "Data": null,
  "DataContext": {
    "TraceId": "<string>"
  },
  "Notifications": [
    {
      "Code": "070101",
      "Message": "<string>",
      "PropertyName": "<string>",
      "ActionHint": "<string>",
      "DocUrl": "<string>"
    }
  ]
}

{
  "StatusCode": 100,
  "IsSuccess": true,
  "Data": null,
  "DataContext": {
    "TraceId": "<string>"
  },
  "Notifications": [
    {
      "Code": "070101",
      "Message": "<string>",
      "PropertyName": "<string>",
      "ActionHint": "<string>",
      "DocUrl": "<string>"
    }
  ]
}

{
  "StatusCode": 100,
  "IsSuccess": true,
  "Data": null,
  "DataContext": {
    "TraceId": "<string>"
  },
  "Notifications": [
    {
      "Code": "070101",
      "Message": "<string>",
      "PropertyName": "<string>",
      "ActionHint": "<string>",
      "DocUrl": "<string>"
    }
  ]
}