Skip to main content
PUT
/
shippo-accounts
/
{ShippoAccountId}
Python
import shippo
from shippo.models import components

s = shippo.Shippo(
    api_key_header='ShippoToken <API_TOKEN>',
    shippo_api_version='2018-02-08',
)


res = s.shippo_accounts.update(shippo_account_id='<id>', shippo_account_update_request=components.ShippoAccountUpdateRequest(
    email='hippo@shippo.com',
    first_name='Shippo',
    last_name='Meister',
    company_name='Acme',
))

if res is not None:
    # handle response
    pass
import { Shippo } from "shippo";

const shippo = new Shippo({
apiKeyHeader: "ShippoToken <API_TOKEN>",
shippoApiVersion: "2018-02-08",
});

async function run() {
const result = await shippo.shippoAccounts.update("<id>", {
email: "hippo@shippo.com",
firstName: "Shippo",
lastName: "Meister",
companyName: "Acme",
});

// Handle the result
console.log(result);
}

run();
using Shippo;
using Shippo.Models.Components;

var sdk = new ShippoSDK(
apiKeyHeader: "ShippoToken <API_TOKEN>",
shippoApiVersion: "2018-02-08"
);

var res = await sdk.ShippoAccounts.UpdateAsync(
shippoAccountId: "<id>",
shippoApiVersion: "2018-02-08",
shippoAccountUpdateRequest: new ShippoAccountUpdateRequest() {
Email = "hippo@shippo.com",
FirstName = "Shippo",
LastName = "Meister",
CompanyName = "Acme",
}
);

// handle response
declare(strict_types=1);

require 'vendor/autoload.php';

use Shippo\API;
use Shippo\API\Models\Components;

$sdk = API\Shippo::builder()
->setSecurity(
'ShippoToken <API_TOKEN>'
)
->setShippoApiVersion('2018-02-08')
->build();

$shippoAccountUpdateRequest = new Components\ShippoAccountUpdateRequest(
email: 'hippo@shippo.com',
firstName: 'Shippo',
lastName: 'Meister',
companyName: 'Acme',
);

$response = $sdk->shippoAccounts->update(
shippoAccountId: '<id>',
shippoApiVersion: '2018-02-08',
shippoAccountUpdateRequest: $shippoAccountUpdateRequest

);

if ($response->shippoAccount !== null) {
// handle response
}
package hello.world;

import com.goshippo.shippo_sdk.Shippo;
import com.goshippo.shippo_sdk.models.components.ShippoAccountUpdateRequest;
import com.goshippo.shippo_sdk.models.operations.UpdateShippoAccountResponse;
import java.lang.Exception;

public class Application {

public static void main(String[] args) throws Exception {

Shippo sdk = Shippo.builder()
.apiKeyHeader("ShippoToken <API_TOKEN>")
.shippoApiVersion("2018-02-08")
.build();

UpdateShippoAccountResponse res = sdk.shippoAccounts().update()
.shippoAccountId("<id>")
.shippoApiVersion("2018-02-08")
.shippoAccountUpdateRequest(ShippoAccountUpdateRequest.builder()
.email("hippo@shippo.com")
.firstName("Shippo")
.lastName("Meister")
.companyName("Acme")
.build())
.call();

if (res.shippoAccount().isPresent()) {
// handle response
}
}
}
curl --request PUT \
--url https://api.goshippo.com/shippo-accounts/{ShippoAccountId} \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '
{
"email": "hippo@shippo.com",
"first_name": "Shippo",
"last_name": "Meister",
"company_name": "Acme"
}
'
const options = {
method: 'PUT',
headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
email: 'hippo@shippo.com',
first_name: 'Shippo',
last_name: 'Meister',
company_name: 'Acme'
})
};

fetch('https://api.goshippo.com/shippo-accounts/{ShippoAccountId}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));
package main

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

func main() {

url := "https://api.goshippo.com/shippo-accounts/{ShippoAccountId}"

payload := strings.NewReader("{\n \"email\": \"hippo@shippo.com\",\n \"first_name\": \"Shippo\",\n \"last_name\": \"Meister\",\n \"company_name\": \"Acme\"\n}")

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

req.Header.Add("Authorization", "<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))

}
require 'uri'
require 'net/http'

url = URI("https://api.goshippo.com/shippo-accounts/{ShippoAccountId}")

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

request = Net::HTTP::Put.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"email\": \"hippo@shippo.com\",\n \"first_name\": \"Shippo\",\n \"last_name\": \"Meister\",\n \"company_name\": \"Acme\"\n}"

response = http.request(request)
puts response.read_body
{
  "email": "hippo@shippo.com",
  "first_name": "Shippo",
  "last_name": "Meister",
  "company_name": "Acme",
  "object_created": "2023-11-07T05:31:56Z",
  "object_id": "adcfdddf8ec64b84ad22772bce3ea37a",
  "object_updated": "2023-11-07T05:31:56Z"
}
{}

Authorizations

Authorization
string
header
default:ShippoToken
required

API key authentication using the ShippoToken scheme. Format: Authorization: ShippoToken <API_TOKEN> Example: Authorization: ShippoToken shippo_live_abc123

Headers

SHIPPO-API-VERSION
string
default:2018-02-08

Optional string used to pick a non-default API version to use. See our API version guide.

Example:

"2018-02-08"

Path Parameters

ShippoAccountId
string
required

Object ID of the ShippoAccount

Body

application/json
email
string
required
Example:

"hippo@shippo.com"

first_name
string
required
Example:

"Shippo"

last_name
string
required
Example:

"Meister"

company_name
string
required
Example:

"Acme"

Response

Shippo account

email
string
required
Example:

"hippo@shippo.com"

first_name
string
required
Example:

"Shippo"

last_name
string
required
Example:

"Meister"

company_name
string
Example:

"Acme"

object_created
string<date-time>
object_id
string
Example:

"adcfdddf8ec64b84ad22772bce3ea37a"

object_updated
string<date-time>