Skip to main content
POST
/
v1
/
customers
/
{id}
Update a customer
curl --request POST \
  --url https://api.yorlet.com/v1/customers/{id} \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "email": "[email protected]",
  "address": {
    "line1": "<string>",
    "line2": "<string>",
    "city": "<string>",
    "country": "<string>",
    "postal_code": "<string>",
    "state": "<string>"
  },
  "description": "<string>",
  "invoice_prefix": "<string>",
  "invoicing": {
    "arrears_emails": true,
    "email_cc": [
      "<string>"
    ],
    "email_to": "<string>"
  },
  "legal": {
    "first_name": "<string>",
    "last_name": "<string>"
  },
  "metadata": {},
  "name": "<string>",
  "next_invoice_sequence": 123,
  "phone": "<string>",
  "archived": true
}
'
import requests

url = "https://api.yorlet.com/v1/customers/{id}"

payload = {
    "email": "[email protected]",
    "address": {
        "line1": "<string>",
        "line2": "<string>",
        "city": "<string>",
        "country": "<string>",
        "postal_code": "<string>",
        "state": "<string>"
    },
    "description": "<string>",
    "invoice_prefix": "<string>",
    "invoicing": {
        "arrears_emails": True,
        "email_cc": ["<string>"],
        "email_to": "<string>"
    },
    "legal": {
        "first_name": "<string>",
        "last_name": "<string>"
    },
    "metadata": {},
    "name": "<string>",
    "next_invoice_sequence": 123,
    "phone": "<string>",
    "archived": True
}
headers = {
    "Authorization": "<api-key>",
    "Content-Type": "application/json"
}

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

print(response.text)
const options = {
  method: 'POST',
  headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    email: '[email protected]',
    address: {
      line1: '<string>',
      line2: '<string>',
      city: '<string>',
      country: '<string>',
      postal_code: '<string>',
      state: '<string>'
    },
    description: '<string>',
    invoice_prefix: '<string>',
    invoicing: {arrears_emails: true, email_cc: ['<string>'], email_to: '<string>'},
    legal: {first_name: '<string>', last_name: '<string>'},
    metadata: {},
    name: '<string>',
    next_invoice_sequence: 123,
    phone: '<string>',
    archived: true
  })
};

fetch('https://api.yorlet.com/v1/customers/{id}', 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.yorlet.com/v1/customers/{id}",
  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([
    'email' => '[email protected]',
    'address' => [
        'line1' => '<string>',
        'line2' => '<string>',
        'city' => '<string>',
        'country' => '<string>',
        'postal_code' => '<string>',
        'state' => '<string>'
    ],
    'description' => '<string>',
    'invoice_prefix' => '<string>',
    'invoicing' => [
        'arrears_emails' => true,
        'email_cc' => [
                '<string>'
        ],
        'email_to' => '<string>'
    ],
    'legal' => [
        'first_name' => '<string>',
        'last_name' => '<string>'
    ],
    'metadata' => [
        
    ],
    'name' => '<string>',
    'next_invoice_sequence' => 123,
    'phone' => '<string>',
    'archived' => true
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: <api-key>",
    "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.yorlet.com/v1/customers/{id}"

	payload := strings.NewReader("{\n  \"email\": \"[email protected]\",\n  \"address\": {\n    \"line1\": \"<string>\",\n    \"line2\": \"<string>\",\n    \"city\": \"<string>\",\n    \"country\": \"<string>\",\n    \"postal_code\": \"<string>\",\n    \"state\": \"<string>\"\n  },\n  \"description\": \"<string>\",\n  \"invoice_prefix\": \"<string>\",\n  \"invoicing\": {\n    \"arrears_emails\": true,\n    \"email_cc\": [\n      \"<string>\"\n    ],\n    \"email_to\": \"<string>\"\n  },\n  \"legal\": {\n    \"first_name\": \"<string>\",\n    \"last_name\": \"<string>\"\n  },\n  \"metadata\": {},\n  \"name\": \"<string>\",\n  \"next_invoice_sequence\": 123,\n  \"phone\": \"<string>\",\n  \"archived\": true\n}")

	req, _ := http.NewRequest("POST", 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))

}
HttpResponse<String> response = Unirest.post("https://api.yorlet.com/v1/customers/{id}")
  .header("Authorization", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"email\": \"[email protected]\",\n  \"address\": {\n    \"line1\": \"<string>\",\n    \"line2\": \"<string>\",\n    \"city\": \"<string>\",\n    \"country\": \"<string>\",\n    \"postal_code\": \"<string>\",\n    \"state\": \"<string>\"\n  },\n  \"description\": \"<string>\",\n  \"invoice_prefix\": \"<string>\",\n  \"invoicing\": {\n    \"arrears_emails\": true,\n    \"email_cc\": [\n      \"<string>\"\n    ],\n    \"email_to\": \"<string>\"\n  },\n  \"legal\": {\n    \"first_name\": \"<string>\",\n    \"last_name\": \"<string>\"\n  },\n  \"metadata\": {},\n  \"name\": \"<string>\",\n  \"next_invoice_sequence\": 123,\n  \"phone\": \"<string>\",\n  \"archived\": true\n}")
  .asString();
require 'uri'
require 'net/http'

url = URI("https://api.yorlet.com/v1/customers/{id}")

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"email\": \"[email protected]\",\n  \"address\": {\n    \"line1\": \"<string>\",\n    \"line2\": \"<string>\",\n    \"city\": \"<string>\",\n    \"country\": \"<string>\",\n    \"postal_code\": \"<string>\",\n    \"state\": \"<string>\"\n  },\n  \"description\": \"<string>\",\n  \"invoice_prefix\": \"<string>\",\n  \"invoicing\": {\n    \"arrears_emails\": true,\n    \"email_cc\": [\n      \"<string>\"\n    ],\n    \"email_to\": \"<string>\"\n  },\n  \"legal\": {\n    \"first_name\": \"<string>\",\n    \"last_name\": \"<string>\"\n  },\n  \"metadata\": {},\n  \"name\": \"<string>\",\n  \"next_invoice_sequence\": 123,\n  \"phone\": \"<string>\",\n  \"archived\": true\n}"

response = http.request(request)
puts response.read_body
{
  "id": "<string>",
  "created": 123,
  "object": "customer",
  "address": {
    "line1": "<string>",
    "line2": "<string>",
    "city": "<string>",
    "country": "<string>",
    "postal_code": "<string>",
    "state": "<string>"
  },
  "default_payment_method": "<string>",
  "delinquent": true,
  "description": "<string>",
  "email": "[email protected]",
  "invoice_prefix": "<string>",
  "invoicing": {
    "arrears_emails": true,
    "email_cc": [
      "[email protected]"
    ],
    "email_to": "[email protected]"
  },
  "legal": {
    "dob": {
      "day": 16,
      "month": 6,
      "year": 5949
    },
    "first_name": "<string>",
    "last_name": "<string>"
  },
  "name": "<string>",
  "phone": "<string>",
  "radar": {
    "message": "<string>",
    "reason": "<string>",
    "risk_level": "<string>"
  },
  "account": "<string>",
  "deleted": false,
  "metadata": {}
}

Authorizations

​
Authorization
string
header
required

API Key authentication. Use "Bearer YOUR_API_KEY".

Path Parameters

​
id
string
required

The id identifier.

Body

application/json
​
email
string<email>

The customer's email address.

​
address
object

The customer's address.

​
description
string

An arbitrary description attached to the customer.

​
invoice_prefix
string

The prefix for the customer used to generate unique invoice numbers.

​
invoicing
object

Invoicing preferences for the customer.

​
legal
object

Legal information about the customer.

​
metadata
object | null

Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.

​
name
string

The customer's full name.

​
next_invoice_sequence
integer

The sequence to be used for the next invoice issued to this customer.

​
phone
string

The customer's phone number.

​
archived
boolean

Whether the customer is archived.

Response

200 - application/json

Returns the customer object if the update succeeded.

​
id
string
required

Unique identifier for the object.

​
created
number
required

Time at which the object was created. Measured in seconds since the Unix epoch.

​
object
enum<string>
required
Available options:
customer
​
address
object
required

The customer's address.

​
default_payment_method
required

ID of the default payment method for the customer.

​
delinquent
boolean
required

Whether the customer has any unpaid or past-due invoices.

​
description
string | null
required

An arbitrary description attached to the customer.

​
email
string<email>
required

The customer's email address.

​
invoice_prefix
string
required

The prefix for the customer used to generate unique invoice numbers.

​
invoicing
object
required

Invoicing preferences for the customer.

​
legal
object
required

Legal information about the customer.

​
name
string | null
required

The customer's full name.

​
phone
string | null
required

The customer's phone number.

​
radar
object
required

Radar's risk assessment of the customer.

​
account
string

The account that the object belongs to. Only returned if the request is made with a valid Yorlet-Context header.

​
deleted
boolean
default:false

Only returned if the object has been deleted.

​
metadata
object | null

Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.