Update assignment

PATCH /api/v1/advisory-firms/{firm_id}/users/{user_id}/assignments/{assignment_id}

Update engagement metadata on an assignment.

Operation ID: update_assignment_api_v1_advisory_firms__firm_id__users__user_id__assignments__assignment_id__patch · View as markdown · OpenAPI slice

Authentication

Bearer token authentication. Pass your DayZero API token in the Authorization header and the target business UUID in x-business-id.

Parameters

Path

firm_id string required
user_id string required
assignment_id string required

Request body

Schema: UpdateStaffAssignmentRequest

engagement_type string
start_date string
end_date string
notes string

Responses

200 Successful Response

Schema: StaffAssignmentResponse

id string required
user_id string required
business_id string required
firm_id string required
assigned_by string required
engagement_type string
start_date string
end_date string
notes string
created_at string · date-time required
updated_at string · date-time required

400 Bad Request - Invalid input

401 Unauthorized - Authentication required

403 Forbidden - Insufficient permissions

404 Not Found - Resource does not exist

422 Validation Error

Schema: HTTPValidationError

detail array · ValidationError ValidationError

5 fields

loc array · string | integer required
msg string required
type string required
input object
ctx object

Code samples

PATCH /api/v1/advisory-firms/{firm_id}/users/{user_id}/assignments/{assignment_id}

bash

curl -X PATCH 'https://api.ondayzero.com/api/v1/advisory-firms/{firm_id}/users/{user_id}/assignments/{assignment_id}' \
  -H 'Authorization: Bearer dz_your_token' \
  -H 'x-business-id: YOUR_BUSINESS_ID' \
  -H 'Content-Type: application/json' \
  -d '{
  "engagement_type": "string",
  "start_date": "string",
  "end_date": "string",
  "notes": "string"
}'

javascript

const response = await fetch('https://api.ondayzero.com/api/v1/advisory-firms/{firm_id}/users/{user_id}/assignments/{assignment_id}', {
  method: 'PATCH',
  headers: {
    Authorization: 'Bearer dz_your_token',
    'x-business-id': 'YOUR_BUSINESS_ID',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
  "engagement_type": "string",
  "start_date": "string",
  "end_date": "string",
  "notes": "string"
}),
});
const data = await response.json();

python

import httpx

headers = {
    "Authorization": "Bearer dz_your_token",
    "x-business-id": "YOUR_BUSINESS_ID",
}

payload = {
  "engagement_type": "string",
  "start_date": "string",
  "end_date": "string",
  "notes": "string"
}

response = httpx.patch("https://api.ondayzero.com/api/v1/advisory-firms/{firm_id}/users/{user_id}/assignments/{assignment_id}", headers=headers, json=payload)
data = response.json()