Send a teammate a password recovery email

Requires current owner/admin authority and matching verified requester identity. Sends only to the target's Auth email using a server-selected redirect. Never changes or returns the existing password, a recovery token, or a recovery link. The retired path /api/workspace-members/reset-password returns 410 and sends nothing.

POST

https://api.channelautomation.com/api/workspace-members/request-recovery

Authorization

BearerAuth
HTTP Bearer (JWT)
required

Request body JSON required

workspace_id
string
required
target_user_id
string
required
requester_user_id
string
required

Returns

200

Recovery request accepted by provider; inbox delivery is not confirmed

JSON

success
optional
boolean
data
optional
object
- recoveryEmailRequested
  optional
  boolean
}

400

Invalid request

401

Invalid or missing verified identity

403

Current authority denied

404

Workspace or member not found

409

Target has no recovery email

429

Recovery email rate limit reached

500

Recovery request failed

502

Auth provider rejected the recovery request

503

Authority verification unavailable

Send a teammate a password recovery email

curl --request POST \
  --url https://api.channelautomation.com/api/workspace-members/request-recovery \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "workspace_id": "string",
  "target_user_id": "string",
  "requester_user_id": "string"
}
'

const url = 'https://api.channelautomation.com/api/workspace-members/request-recovery';
const options = {
  method: 'POST',
  headers: {'Content-Type': 'application/json', Authorization: 'Bearer <token>'},
  body: JSON.stringify({workspace_id: 'string', target_user_id: 'string', requester_user_id: 'string'})
};

fetch(url, options)
  .then(res => res.json())
  .then(json => console.log(json))
  .catch(err => console.error(err));

import requests

url = "https://api.channelautomation.com/api/workspace-members/request-recovery"

payload = {
    "workspace_id": "string",
    "target_user_id": "string",
    "requester_user_id": "string"
}
headers = {
    "Content-Type": "application/json",
    "Authorization": "Bearer <token>"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

Response example

{
  "success": true,
  "data": {
    "recoveryEmailRequested": true
  }
}