Update a payer
curl --request PATCH \
--url https://api.withacclaim.com/v1/payers/{payer_id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"given_name": "<string>",
"family_name": "<string>",
"middle_name": "<string>",
"name": "<string>",
"company_name": "<string>",
"email": "jsmith@example.com",
"phone": "<string>",
"tax_id": "<string>",
"identifier": "<string>",
"metadata": {
"custom_field": "value",
"source": "api"
}
}
'import requests
url = "https://api.withacclaim.com/v1/payers/{payer_id}"
payload = {
"given_name": "<string>",
"family_name": "<string>",
"middle_name": "<string>",
"name": "<string>",
"company_name": "<string>",
"email": "jsmith@example.com",
"phone": "<string>",
"tax_id": "<string>",
"identifier": "<string>",
"metadata": {
"custom_field": "value",
"source": "api"
}
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
given_name: '<string>',
family_name: '<string>',
middle_name: '<string>',
name: '<string>',
company_name: '<string>',
email: 'jsmith@example.com',
phone: '<string>',
tax_id: '<string>',
identifier: '<string>',
metadata: {custom_field: 'value', source: 'api'}
})
};
fetch('https://api.withacclaim.com/v1/payers/{payer_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.withacclaim.com/v1/payers/{payer_id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'given_name' => '<string>',
'family_name' => '<string>',
'middle_name' => '<string>',
'name' => '<string>',
'company_name' => '<string>',
'email' => 'jsmith@example.com',
'phone' => '<string>',
'tax_id' => '<string>',
'identifier' => '<string>',
'metadata' => [
'custom_field' => 'value',
'source' => 'api'
]
]),
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.withacclaim.com/v1/payers/{payer_id}"
payload := strings.NewReader("{\n \"given_name\": \"<string>\",\n \"family_name\": \"<string>\",\n \"middle_name\": \"<string>\",\n \"name\": \"<string>\",\n \"company_name\": \"<string>\",\n \"email\": \"jsmith@example.com\",\n \"phone\": \"<string>\",\n \"tax_id\": \"<string>\",\n \"identifier\": \"<string>\",\n \"metadata\": {\n \"custom_field\": \"value\",\n \"source\": \"api\"\n }\n}")
req, _ := http.NewRequest("PATCH", 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.patch("https://api.withacclaim.com/v1/payers/{payer_id}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"given_name\": \"<string>\",\n \"family_name\": \"<string>\",\n \"middle_name\": \"<string>\",\n \"name\": \"<string>\",\n \"company_name\": \"<string>\",\n \"email\": \"jsmith@example.com\",\n \"phone\": \"<string>\",\n \"tax_id\": \"<string>\",\n \"identifier\": \"<string>\",\n \"metadata\": {\n \"custom_field\": \"value\",\n \"source\": \"api\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.withacclaim.com/v1/payers/{payer_id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"given_name\": \"<string>\",\n \"family_name\": \"<string>\",\n \"middle_name\": \"<string>\",\n \"name\": \"<string>\",\n \"company_name\": \"<string>\",\n \"email\": \"jsmith@example.com\",\n \"phone\": \"<string>\",\n \"tax_id\": \"<string>\",\n \"identifier\": \"<string>\",\n \"metadata\": {\n \"custom_field\": \"value\",\n \"source\": \"api\"\n }\n}"
response = http.request(request)
puts response.read_body{
"id": "pyr_AbC123XyZ",
"identifier": "PAYER-2025-001",
"name": "John Doe",
"given_name": "John",
"family_name": "Doe",
"middle_name": "<string>",
"company_name": "Acme Corp",
"email": "john.doe@example.com",
"phone": "+15551234567",
"tax_id": "12-3456789",
"address": {
"country": "US",
"address1": "123 Main St",
"address2": "Suite 100",
"city": "New York",
"state": "NY",
"postal_code": "10001"
},
"metadata": {
"custom_field": "value",
"source": "api"
},
"created_at": "2025-10-08T18:20:31Z",
"updated_at": "2025-10-08T18:25:00Z"
}{
"error": {
"code": "invalid_request",
"message": "Missing required field: amount",
"details": {},
"request_id": "req_7lYt4o2x"
}
}Payers
Update a payer
PATCH
/
payers
/
{payer_id}
Update a payer
curl --request PATCH \
--url https://api.withacclaim.com/v1/payers/{payer_id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"given_name": "<string>",
"family_name": "<string>",
"middle_name": "<string>",
"name": "<string>",
"company_name": "<string>",
"email": "jsmith@example.com",
"phone": "<string>",
"tax_id": "<string>",
"identifier": "<string>",
"metadata": {
"custom_field": "value",
"source": "api"
}
}
'import requests
url = "https://api.withacclaim.com/v1/payers/{payer_id}"
payload = {
"given_name": "<string>",
"family_name": "<string>",
"middle_name": "<string>",
"name": "<string>",
"company_name": "<string>",
"email": "jsmith@example.com",
"phone": "<string>",
"tax_id": "<string>",
"identifier": "<string>",
"metadata": {
"custom_field": "value",
"source": "api"
}
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
given_name: '<string>',
family_name: '<string>',
middle_name: '<string>',
name: '<string>',
company_name: '<string>',
email: 'jsmith@example.com',
phone: '<string>',
tax_id: '<string>',
identifier: '<string>',
metadata: {custom_field: 'value', source: 'api'}
})
};
fetch('https://api.withacclaim.com/v1/payers/{payer_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.withacclaim.com/v1/payers/{payer_id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'given_name' => '<string>',
'family_name' => '<string>',
'middle_name' => '<string>',
'name' => '<string>',
'company_name' => '<string>',
'email' => 'jsmith@example.com',
'phone' => '<string>',
'tax_id' => '<string>',
'identifier' => '<string>',
'metadata' => [
'custom_field' => 'value',
'source' => 'api'
]
]),
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.withacclaim.com/v1/payers/{payer_id}"
payload := strings.NewReader("{\n \"given_name\": \"<string>\",\n \"family_name\": \"<string>\",\n \"middle_name\": \"<string>\",\n \"name\": \"<string>\",\n \"company_name\": \"<string>\",\n \"email\": \"jsmith@example.com\",\n \"phone\": \"<string>\",\n \"tax_id\": \"<string>\",\n \"identifier\": \"<string>\",\n \"metadata\": {\n \"custom_field\": \"value\",\n \"source\": \"api\"\n }\n}")
req, _ := http.NewRequest("PATCH", 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.patch("https://api.withacclaim.com/v1/payers/{payer_id}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"given_name\": \"<string>\",\n \"family_name\": \"<string>\",\n \"middle_name\": \"<string>\",\n \"name\": \"<string>\",\n \"company_name\": \"<string>\",\n \"email\": \"jsmith@example.com\",\n \"phone\": \"<string>\",\n \"tax_id\": \"<string>\",\n \"identifier\": \"<string>\",\n \"metadata\": {\n \"custom_field\": \"value\",\n \"source\": \"api\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.withacclaim.com/v1/payers/{payer_id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"given_name\": \"<string>\",\n \"family_name\": \"<string>\",\n \"middle_name\": \"<string>\",\n \"name\": \"<string>\",\n \"company_name\": \"<string>\",\n \"email\": \"jsmith@example.com\",\n \"phone\": \"<string>\",\n \"tax_id\": \"<string>\",\n \"identifier\": \"<string>\",\n \"metadata\": {\n \"custom_field\": \"value\",\n \"source\": \"api\"\n }\n}"
response = http.request(request)
puts response.read_body{
"id": "pyr_AbC123XyZ",
"identifier": "PAYER-2025-001",
"name": "John Doe",
"given_name": "John",
"family_name": "Doe",
"middle_name": "<string>",
"company_name": "Acme Corp",
"email": "john.doe@example.com",
"phone": "+15551234567",
"tax_id": "12-3456789",
"address": {
"country": "US",
"address1": "123 Main St",
"address2": "Suite 100",
"city": "New York",
"state": "NY",
"postal_code": "10001"
},
"metadata": {
"custom_field": "value",
"source": "api"
},
"created_at": "2025-10-08T18:20:31Z",
"updated_at": "2025-10-08T18:25:00Z"
}{
"error": {
"code": "invalid_request",
"message": "Missing required field: amount",
"details": {},
"request_id": "req_7lYt4o2x"
}
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
ID of the payer.
Body
application/json
Required string length:
1 - 255Required string length:
1 - 255Required string length:
1 - 255Full name (overrides given_name/family_name if provided)
Required string length:
1 - 255Required string length:
1 - 255E.164 formatted phone number
Required string length:
1 - 50Required string length:
1 - 100Show child attributes
Show child attributes
Optional metadata as key-value pairs
Example:
{ "custom_field": "value", "source": "api" }
Response
Updated payer.
Example:
"pyr_AbC123XyZ"
Example:
"PAYER-2025-001"
Full name for individual or business name
Example:
"John Doe"
Example:
"John"
Example:
"Doe"
Example:
"Acme Corp"
Example:
"john.doe@example.com"
E.164 formatted phone number
Example:
"+15551234567"
Tax identification number
Example:
"12-3456789"
Show child attributes
Show child attributes
Optional metadata as key-value pairs
Example:
{ "custom_field": "value", "source": "api" }
Example:
"2025-10-08T18:20:31Z"
Example:
"2025-10-08T18:25:00Z"
Last modified on July 8, 2026
⌘I