Recomly APIEndpoints
Update advocate
Update an advocate's contact information or notification preference.
PATCH /api/app/campaigns/{campaignId}/advocates/{advocateId}
Updates an advocate's name, email, phone, or notification preference. All fields are optional — include only the ones you want to change. At least one field is required.
Request
See API Basics for required headers.
Body
| Field | Type | Description |
|---|---|---|
name | string | Advocate's full name. Max 100 characters. |
email | string | null | Email address. Pass null to remove. The advocate must still have at least one of email or phone after the update. |
phone | string | null | US phone number in E.164 format. Pass null to remove. |
notificationPreference | "email" | "sms" | "both" | Preferred notification channel. Must be consistent with which contact fields are present. |
Sample request
curl -X PATCH https://api.recomly.com/api/app/campaigns/c7a3f1d2-84b0-4e9a-bcd2-1f3e5a7c9012/advocates/e9c5a3b1-72d4-4f8e-ace5-3g5h7i9j0123 \
-H "Authorization: Bearer rk_live_abc123:def456" \
-H "Content-Type: application/json" \
-d '{
"phone": "+12125550199",
"notificationPreference": "both"
}'Sample response
Status: 200 OK
{
"advocate": {
"advocateId": "e9c5a3b1-72d4-4f8e-ace5-3g5h7i9j0123",
"campaignId": "c7a3f1d2-84b0-4e9a-bcd2-1f3e5a7c9012",
"orgId": "a1b2c3d4-0000-4000-8000-e5f6a7b8c9d0",
"name": "Jane Smith",
"email": "jane@example.com",
"phone": "+12125550199",
"notificationPreference": "both",
"referralCode": "a1b2c3d4",
"portalToken": "7f3a1d2e4b5c6f8a9e0d1b2c3f4a5e6b7c8d9e0f1a2b3c4d5e6f7a8b9c0d1e2f",
"creditBalanceCents": 2500,
"enrolledAt": "2026-04-04T15:00:00.000Z"
}
}Error responses
See API Basics for standard status codes and error response format.