Send portal reminders in bulk
curl --request POST \
--url https://api.trycomp.ai/v1/people/send-reminders \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <api-key>' \
--data '
{
"memberIds": [
"mem_abc123",
"mem_def456"
]
}
'const options = {
method: 'POST',
headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({memberIds: ['mem_abc123', 'mem_def456']})
};
fetch('https://api.trycomp.ai/v1/people/send-reminders', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.trycomp.ai/v1/people/send-reminders"
payload = { "memberIds": ["mem_abc123", "mem_def456"] }
headers = {
"X-API-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)People
Send portal reminders in bulk | Comp AI API
Emails a reminder to each listed member with outstanding policy acknowledgments or unfinished training. Omit memberIds entirely to cover the whole.
POST
/
v1
/
people
/
send-reminders
Send portal reminders in bulk
curl --request POST \
--url https://api.trycomp.ai/v1/people/send-reminders \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <api-key>' \
--data '
{
"memberIds": [
"mem_abc123",
"mem_def456"
]
}
'const options = {
method: 'POST',
headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({memberIds: ['mem_abc123', 'mem_def456']})
};
fetch('https://api.trycomp.ai/v1/people/send-reminders', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.trycomp.ai/v1/people/send-reminders"
payload = { "memberIds": ["mem_abc123", "mem_def456"] }
headers = {
"X-API-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)Authorizations
API key for authentication
Body
application/json
Which members to remind; omit to cover the whole organization
Members to remind. Omit to remind everyone in the organization who has outstanding portal work. Members who owe nothing are skipped either way.
Example:
["mem_abc123", "mem_def456"]
Response
201 - undefined
Was this page helpful?

