---
title: "Set the payout email"
method: PATCH
path: "/affiliate/payout-email/"
tags: ["affiliate"]
---

# Set the payout email

`PATCH /affiliate/payout-email/`

## Request

- Base URL: `https://api.getoneprofile.ai` (the document declares no server; this is the origin it was published from)
- URL: `https://api.getoneprofile.ai/affiliate/payout-email/`
- Auth: one of:
  - API key in header `X-API-Key`
  - HTTP bearer

Set the PayPal account payouts are sent to. Every change restarts the destination hold: a payout will not use an email set within the last few days. Requires a signed-in user, because this is where the money goes, so an API key is not enough.

## Request body

- PayoutEmailUpdateSchema: The PayPal account payouts are sent to.
  - `email` string, email, required: The PayPal account email.

## Response `200`

Successful Response

- AffiliateProfileReadSchema: The caller's own standing in the affiliate program.
  - `contact_email` string, required
  - `created_at` string, date-time, required
  - `display_name` string, required
  - `id` string, uuid, required
  - `identity_verified_at` string, date-time, nullable, required
  - `paypal_email` string, nullable, required
  - `paypal_email_confirmed_at` string, date-time, nullable, required
  - `status` 'active' | 'suspended' | 'banned', required: Whether an affiliate may earn and be paid.

## Other responses

- `401`: Unauthorized
- `403`: Forbidden
- `404`: Not enrolled.
- `422`: Invalid request made to the API.
- `500`: Internal server error.
- `502`: Bad gateway error.
- `503`: Service unavailable.

---

[API](https://skmtc.dev/getoneprofile/apis/api-reference-oneprofile.md) · [All operations](https://skmtc.dev/getoneprofile/apis/api-reference-oneprofile/llms.txt) · [OpenAPI document](https://skmtc.dev/getoneprofile/apis/api-reference-oneprofile/revisions/4a6bd71e3f02?raw)