API reference › Assignments › Cancel, change and reassign

Reassign an assignment

POST /v1/assignment/re-assign

Scope
assignments:edit
Roles
admin, scheduler

Reassigns an assignment to a new service provider with optional priority and reason.

Parameters

None of its own.

Every call also sends Authorization and X-Tenant-ID; see Getting started.

Request body required

FieldTypeDescription
assignmentId requiredstring

Example ASG-LVMXVD.

newAssigneeobject
newAssignee.id requiredstring

Example SPR-JVI5GD.

newAssignee.labelstring

Example Demo User.

priorityobject
priority.idinteger

Example 1.

priority.labelstring

Example HIGH.

reassignmentReasonstring or null

Example Demo reason.

Example

JSON
{
  "assignmentId": "ASG-LVMXVD",
  "newAssignee": {
    "id": "SPR-JVI5GD",
    "label": "Demo User"
  },
  "priority": {
    "id": 1,
    "label": "HIGH"
  },
  "reassignmentReason": "Demo reason"
}

Example request

Shell
curl -X POST "https://api.fetchfido.ai/v1/assignment/re-assign" \
  -H "Authorization: Bearer $FIDO_API_KEY" \
  -H "X-Tenant-ID: $FIDO_TENANT_ID" \
  -H "Content-Type: application/json" \
  -d '{"assignmentId":"ASG-LVMXVD","newAssignee":{"id":"SPR-JVI5GD","label":"Demo User"},"priority":{"id":1,"label":"HIGH"},"reassignmentReason":"Demo reason"}'

Try it

Responses

200 Assignment reassigned successfully

Assignment reassigned successfully

JSON
{
  "success": true,
  "message": "Assignment reassigned successfully.",
  "data": {}
}
Response fields (3)
FieldTypeDescription
successboolean

Example true.

messagestring

Example Assignment reassigned successfully..

dataobject or null
401 Not signed in

Missing, invalid or expired API key.

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

Scope, tenant, IP allow-list or RBAC check failed.

JSON
{
  "success": false,
  "message": "You don't have permission to access this endpoint. This API key is missing the 'assignments:edit' 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:edit' scope..

errorsany or null

Null on this status.

codestring

Always empty on this status.

Example .

422 Validation failed

Validation error

JSON
{
  "message": "Validation failed.",
  "errors": {
    "assignmentId": [
      "The selected assignment does not exist."
    ]
  }
}
Response fields (2)
FieldTypeDescription
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

Unexpected server error

JSON
{
  "message": "Assignment reassignment failed.",
  "errors": "An unexpected error occurred — please try again."
}
Response fields (2)
FieldTypeDescription
messagestring

Example Assignment reassignment failed..

errorsstring or null

Null in production. The exception message only when the application runs with debug on.

Example An unexpected error occurred — please try again..