Message the provider
POST /v1/handshakes/{id}/notify
- Scope
handshakes:edit- Roles
- admin, scheduler
Sends an in-app notification and optionally a custom email. Supply message, or both emailSubject and emailMessage — the email pair must be sent together.
Parameters
Path parameters
| Name | Type | Description |
|---|---|---|
id required | string | Handshake ID. |
Every call also sends Authorization and X-Tenant-ID; see Getting started.
Request body required
| Field | Type | Description |
|---|---|---|
message | string or null | In-app message. Required unless an email subject and body are supplied. max length 2000. Example |
emailSubject | string or null | Required when emailMessage is present. max length 255. |
emailMessage | string or null | Required when emailSubject is present. max length 5000. Example |
Example
{
"message": "Request processed successfully.",
"emailSubject": "string",
"emailMessage": "Request processed successfully."
}Example request
curl -X POST "https://api.fetchfido.ai/v1/handshakes/{id}/notify" \
-H "Authorization: Bearer $FIDO_API_KEY" \
-H "X-Tenant-ID: $FIDO_TENANT_ID" \
-H "Content-Type: application/json" \
-d '{"message":"Request processed successfully.","emailSubject":"string","emailMessage":"Request processed successfully."}'Try it
Responses
200 Notification sent successfully
Notification sent successfully.
{
"success": true,
"message": "Notification sent successfully."
}Response fields (2)
| Field | Type | Description |
|---|---|---|
success | boolean | Example |
message | string | Example |
401 Not signed in
Missing, invalid or expired API key.
{
"success": false,
"message": "Invalid API key. Org and user tier keys must send an X-Tenant-ID header naming the organization the key was issued for.",
"errors": null,
"code": "API_KEY_MISSING"
}Response fields (4)
| Field | Type | Description |
|---|---|---|
success | boolean | Example |
message | string | Example |
errors | any or null | Null on this status. |
code | string | Machine-readable reason, for branching on in client code. One of: |
403 Not allowed
Scope, tenant, IP allow-list or RBAC check failed.
{
"success": false,
"message": "You don't have permission to access this endpoint. This API key is missing the 'handshakes:edit' scope.",
"errors": null,
"code": ""
}Response fields (4)
| Field | Type | Description |
|---|---|---|
success | boolean | Example |
message | string | Example |
errors | any or null | Null on this status. |
code | string | Always empty on this status. Example |
422 Validation failed
Validation failed.
{
"success": false,
"message": "Unable to save. Please check the highlighted fields",
"errors": null,
"code": ""
}Response fields (4)
| Field | Type | Description |
|---|---|---|
success | boolean | Example |
message | string | Example |
errors | any or null | Details when the handler has them — a field-keyed object, a single string, or null. |
code | string | Empty unless the handler sets one. Example |
429 Too many requests
Rate limit exceeded. See Retry-After.
{
"success": false,
"message": "You've exceeded this API key's rate limit of 120 requests per minute. Try again in 37 seconds.",
"errors": null,
"code": "RATE_LIMITED"
}Response fields (4)
| Field | Type | Description |
|---|---|---|
success | boolean | Example |
message | string | Example |
errors | any or null | Null on this status. |
code | string | Machine-readable reason, for branching on in client code. One of: |