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

FieldTypeDescription
schedulerboolean or null

Whether to send the message to the scheduler

Example true.

clientboolean

Whether to send the message to the client

Example true.

consumerboolean

Whether to send the message to the consumer

Example true.

subject requiredstring

Subject of the message

Example Send message for testing.

message requiredstring

Body of the message

Example Lorem ipsum dolor sit amet consectetur adipisicing elit..

assignmentId requiredstring

Unique ID of the assignment

Example ASG-J5A17Q-C1.

typestring

Indicates the type of user who is sending the message (e.g., scheduler, client, consumer)

Example consumer.

Example

JSON
{
  "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

Shell
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

JSON
{
  "success": true,
  "message": "Message sent successfully"
}
Response fields (2)
FieldTypeDescription
successboolean

Example true.

messagestring

Example Message sent successfully.

401 Not signed in

Unauthorized - Authentication required

JSON
{
  "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)
FieldTypeDescription
successboolean

Example false.

messagestring

Example Invalid API key. Org and user tier keys must send an X-Tenant-ID header naming the organization the key was issued for..

errorsany or null

Null on this status.

codestring

Machine-readable reason, for branching on in client code.

One of: API_KEY_MISSING, API_KEY_INVALID, API_KEY_EXPIRED. Example API_KEY_MISSING.

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.

JSON
{
  "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)
FieldTypeDescription
successboolean

Example false.

messagestring

Example You don't have permission to access this endpoint. This API key is missing the 'assignments:write' scope..

errorsany or null

Null on this status.

codestring

Always empty on this status.

Example .

422 Validation failed

Validation error

JSON
{
  "success": false,
  "message": "Validation failed",
  "errors": {
    "message": [
      "The message field is required."
    ]
  }
}
Response fields (3)
FieldTypeDescription
successboolean

Example false.

messagestring

Example Validation failed.

errorsobject
429 Too many requests

Rate limit exceeded. See Retry-After.

JSON
{
  "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)
FieldTypeDescription
successboolean

Example false.

messagestring

Example You've exceeded this API key's rate limit of 120 requests per minute. Try again in 37 seconds..

errorsany or null

Null on this status.

codestring

Machine-readable reason, for branching on in client code.

One of: RATE_LIMITED. Example RATE_LIMITED.

500 Server error

Internal Server Error

JSON
{
  "success": false,
  "message": "Failed to send message"
}
Response fields (2)
FieldTypeDescription
successboolean

Example false.

messagestring

Example Failed to send message.