Skip to main content
PUT
Create or replace a Party

Authorizations

Authorization
string
header
required

Integration-owned environment-specific API key. Never paste a production key into documentation tools.

Path Parameters

clientCode
string
required

Stable non-sensitive Client code authorized by the Integration grant.

Pattern: ^[A-Za-z0-9_-]{1,128}$
externalPartyId
string
required

Caller-assigned, opaque identifier for this Party's source-system record. It is stable when Party details change and is never a PayPathIQ ID, member or account number, or contact detail.

Pattern: ^[A-Za-z0-9_-]{1,128}$

Body

application/json

Maximum uncompressed request body size: 256 KiB.

name
object
required
type
string
required
Allowed value: "person"
sourceReference
string
Required string length: 1 - 200
addresses
object[]

At most one address may be primary.

Maximum array length: 3
emails
object[]

At most one email may be primary.

Maximum array length: 5
phones
object[]

At most one phone number may be primary.

Maximum array length: 5
safetyAssertions
object[]

At most one assertion per type; ordering is semantically irrelevant.

Maximum array length: 5

Response

Party replaced, or request was an identical safe retry.

name
object
required
type
string
required
Allowed value: "person"
externalPartyId
string
required

Caller-assigned, opaque identifier for this Party's source-system record. It is not a PayPathIQ ID, customer or member number, loan or account number, or contact detail. Keep it stable when Party details change.

Pattern: ^[A-Za-z0-9_-]{1,128}$
updatedAt
string<date-time>
required
Pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$
sourceReference
string
Required string length: 1 - 200
addresses
object[]

At most one address may be primary.

Maximum array length: 3
emails
object[]

At most one email may be primary.

Maximum array length: 5
phones
object[]

At most one phone number may be primary.

Maximum array length: 5
safetyAssertions
object[]

At most one assertion per type; ordering is semantically irrelevant.

Maximum array length: 5