Skip to main content
Update recipient

Authorizations

X-API-Key
string
header
required

Your Swipelux API key. Obtain this from the Swipelux Dashboard.

Headers

Idempotency-Key
string
required

Required for effectful v3 requests (POST, PATCH, PUT, DELETE). Reuse the same key with the same body to replay the cached response.

Required string length: 1 - 255

Path Parameters

customerId
string
required
recipientId
string
required

Body

application/json
relationship
enum<string>
Available options:
employee,
contractor,
vendor,
subsidiary,
merchant,
customer,
landlord,
family,
other
firstName
string
Minimum string length: 1
lastName
string
Minimum string length: 1
companyName
string
Minimum string length: 1
businessIndustry
string

6-digit NAICS code used for provider-backed ACH readiness checks on business recipients.

Required string length: 6
Pattern: ^\d{6}$
email
string<email>
phone
string
address
object
label
string
Maximum string length: 255
metadata
object

Response

Recipient updated

data
object
required