Sentra
Recipients

Update recipient

Updates an existing recipient

PUT
/recipients/{id}
X-API-KEY<token>

API key for authentication (prefix: sk_dev_ for development, sk_live_ for production)

In: header

Path Parameters

idstring

Recipient ID

Formatuuid
firstName?string
Lengthlength <= 35
middleName?string
Lengthlength <= 35
lastName?string
Lengthlength <= 35
businessName?string
Lengthlength <= 35
entityType?string
Value in"INDIVIDUAL" | "BUSINESS"
type?string
Value in"FIRST_PARTY" | "THIRD_PARTY"
email?string
Formatemail
taxIdentificationNumber?string
Lengthlength <= 50
address?

Response Body

application/json

application/json

application/json

application/json

application/json

curl -X PUT "https://api.sentra.xyz/api/v1/recipients/497f6eca-6276-4993-bfeb-53cbbbba6f08" \  -H "Content-Type: application/json" \  -d '{}'
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "firstName": "string",
  "middleName": "string",
  "lastName": "string",
  "businessName": "string",
  "entityType": "INDIVIDUAL",
  "type": "FIRST_PARTY",
  "email": "user@example.com",
  "taxIdentificationNumber": "string",
  "address": {
    "addressLine1": "string",
    "addressLine2": "string",
    "city": "string",
    "state": "string",
    "postalCode": "string",
    "countryCode": "string"
  },
  "createdAt": "2019-08-24T14:15:22Z",
  "updatedAt": "2019-08-24T14:15:22Z"
}
{
  "message": "Validation failed",
  "statusCode": 400,
  "details": {
    "field": "email",
    "message": "Invalid email format"
  }
}
{
  "message": "Unauthorized",
  "statusCode": 401
}
{
  "message": "Resource not found",
  "statusCode": 404
}
{
  "message": "Internal server error",
  "statusCode": 500
}