Update a Recipient

patch https://connect.sandbox.plastiq.com/api/recipients/{id}

Path Params

uuid

required

The ID of the Recipient

Body Params

Recipient to create

businessName

string

businessAddress

object

contact

object

payer

object

metadata

object

Additional Recipient information to support operational requirements

Headers

Trace-Id

string

A valid UUID (V4) for tracing requests. Will be returned as a header. If not present or invalid, a generated UUID will be returned.

End-User-Agent

string

A string representing the User Agent of the end user. Recommended for compliance. Required only when the request is not coming from the end user's browser.

End-User-Ip

string

The IP address of the end user. Recommended for compliance.

End-User-OS

string

The Operating System of the end user. Recommended for compliance.

End-User-Device-Id

string

A unique identifier for the end user's device. Recommended for compliance.

End-User-Device-Manufacturer

string

The manufacturer of the device used by the end user. Recommended for compliance.

End-User-Device-Model

string

The device model used by the end user. Recommended for compliance.

Responses

Language

Credentials

Bearer

token

URL


xxxxxxxxxx
1
curl --request PATCH \
2
     --url https://connect.sandbox.plastiq.com/api/recipients/id \
3
     --header 'accept: application/json' \
4
     --header 'content-type: application/json'

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Recipient updated successfully

400Bad Request

401Unauthorized

403Forbidden

404Not found

500Internal Server Error