Skip to main content
PATCH
/
beneficiaries
/
{public_id}
cURL
curl --request PATCH \
  --url https://sandbox.withclasp.com/beneficiaries/{public_id} \
  --header 'Content-Type: application/json' \
  --data '
{
  "full_name": "<string>",
  "dob": "2023-12-25",
  "member_relationship": "spouse",
  "member": "<string>",
  "tin": "<string>",
  "address": {
    "line1": "<string>",
    "city": "<string>",
    "state": "AL",
    "zip_code": "<string>",
    "line2": "<string>"
  },
  "phone_number": "<string>"
}
'
{
  "id": "<string>",
  "full_name": "<string>",
  "member_relationship": "spouse",
  "member": "<string>",
  "tin_last_four": "<string>",
  "address": {
    "line1": "<string>",
    "city": "<string>",
    "state": "AL",
    "zip_code": "<string>",
    "line2": "<string>"
  },
  "phone_number": "<string>",
  "dob": "2023-12-25"
}

Path Parameters

​
public_id
string
required

Body

application/json
​
full_name
string
Maximum string length: 255
​
dob
string<date> | null
​
member_relationship
enum<string>
  • spouse - Spouse
  • child - Child
  • parent - Parent
  • sibling - Sibling
  • friend - Friend
  • trust - Trust
  • organization - Organization
  • estate - Estate
Available options:
spouse,
child,
parent,
sibling,
friend,
trust,
organization,
estate
​
member
string
​
tin
string
Pattern: \d{9}
​
address
object
​
phone_number
string
Maximum string length: 10

Response

200 - application/json
​
id
string
required
Pattern: ^[-a-zA-Z0-9_]+$
​
full_name
string
required
Maximum string length: 255
​
member_relationship
enum<string>
required
  • spouse - Spouse
  • child - Child
  • parent - Parent
  • sibling - Sibling
  • friend - Friend
  • trust - Trust
  • organization - Organization
  • estate - Estate
Available options:
spouse,
child,
parent,
sibling,
friend,
trust,
organization,
estate
​
member
string
required
​
tin_last_four
string
required
​
address
object
required
​
phone_number
string
required
Maximum string length: 10
​
dob
string<date> | null