Link Search Menu Expand Document

Profile

A profile represents a Centrapay user’s attributes.

Contents

Models

Profile

Optional Fields

Field Type Description
givenName String First name.
familyName String Last name.
featureUpdates Boolean Whether a user would like to receive emails for feature updates.
marketingUpdates Boolean Whether a user would like to receive emails for marketing updates.
email String Email address.

Operations

Updating a user profile EXPERIMENTAL

Update a user’s mutable attributes. At least one field must be provided in the request.

POST /api/me/profile/update

curl -X POST https://service.centrapay.com/api/me/profile/update \
  -H "Authorization: $jwt" \
  -H "Content-Type: application/json" \
  -d '{
    "givenName": "John",
    "familyName": "Doe",
    "featureUpdates": false,
    "marketingUpdates": true,
    "email": "john.doe@centrapay.com"
  }'

Example response payload

{
  "givenName": "John",
  "familyName": "Doe",
  "featureUpdates": false,
  "marketingUpdates": true,
  "email": "john.doe@centrapay.com"
}