API reference › Assignments › Cancel, change and reassign
Send a message related to an assignment
POST /v1/assignment/send-message
- Scope
assignments:write
Allows user to send messages or notifications related to a specific assignment to multiple recipient types (scheduler, client, consumer).
Parameters
None of its own.
Every call also sends Authorization and X-Tenant-ID; see Getting started.
Request body required
| Field | Type | Description |
|---|---|---|
scheduler | boolean or null | Whether to send the message to the scheduler Example |
client | boolean | Whether to send the message to the client Example |
consumer | boolean | Whether to send the message to the consumer Example |
subject required | string | Subject of the message Example |
message required | string | Body of the message Example |
assignmentId required | string | Unique ID of the assignment Example |
type | string | Indicates the type of user who is sending the message (e.g., scheduler, client, consumer) Example |
Example
{
"scheduler": true,
"client": true,
"consumer": true,
"subject": "Send message for testing",
"message": "Lorem ipsum dolor sit amet consectetur adipisicing elit.",
"assignmentId": "ASG-J5A17Q-C1",
"type": "consumer"
}Example request
curl -X POST "https://api.fetchfido.ai/v1/assignment/send-message" \
-H "Authorization: Bearer $FIDO_API_KEY" \
-H "X-Tenant-ID: $FIDO_TENANT_ID" \
-H "Content-Type: application/json" \
-d '{"scheduler":true,"client":true,"consumer":true,"subject":"Send message for testing","message":"Lorem ipsum dolor sit amet consectetur adipisicing elit.","assignmentId":"ASG-J5A17Q-C1","type":"consumer"}'Try it
Responses
200 Message sent successfully
Message sent successfully
{
"success": true,
"message": "Message sent successfully"
}Response fields (2)
| Field | Type | Description |
|---|---|---|
success | boolean | Example |
message | string | Example |
401 Not signed in
Unauthorized - Authentication required
{
"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
Forbidden — a client, consumer or service provider who is not attached to this assignment/shift. The message is generic on purpose, so the response can't be used to tell a real id apart from one belonging to someone else.
{
"success": false,
"message": "You don't have permission to access this endpoint. This API key is missing the 'assignments:write' 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 error
{
"success": false,
"message": "Validation failed",
"errors": {
"message": [
"The message field is required."
]
}
}Response fields (3)
| Field | Type | Description |
|---|---|---|
success | boolean | Example |
message | string | Example |
errors | object |
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: |
500 Server error
Internal Server Error
{
"success": false,
"message": "Failed to send message"
}Response fields (2)
| Field | Type | Description |
|---|---|---|
success | boolean | Example |
message | string | Example |