curl --request PATCH \
--url https://api.zivio.net/api/v4/projects/{id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'zivio-tenant-id: <api-key>' \
--data '
{
"project": {
"title": "Updated Project Title"
}
}
'{
"id": 101,
"title": "Website Redesign Project",
"description": "Complete redesign of corporate website with modern UX",
"state": "pending",
"additional_notes": "Additional information and context for this record.",
"skill_category": {
"id": 101,
"name": "Acme Corporation",
"code": "Example code",
"slug": "Example slug",
"precedence": 101,
"parent_id": 501,
"parent_name": "Example parent_name",
"parent_slug": "Example parent_slug"
},
"skill_subcategory": {
"id": 101,
"name": "Acme Corporation",
"code": "Example code",
"slug": "Example slug",
"precedence": 101,
"parent_id": 501,
"parent_name": "Example parent_name",
"parent_slug": "Example parent_slug"
},
"skill_category_tier3": {
"id": 101,
"name": "Acme Corporation",
"code": "Example code",
"slug": "Example slug",
"precedence": 101,
"parent_id": 501,
"parent_name": "Example parent_name",
"parent_slug": "Example parent_slug"
},
"skills": [
{
"id": 101,
"name": "Acme Corporation",
"slug": "Example slug"
},
{
"id": 102,
"name": "Global Services Ltd",
"slug": "Example slug"
}
],
"talent_pool_id": 501,
"type": "standard",
"posting_type": "public",
"bids_count": 5,
"submission_deadline": "2024-01-16T10:30:00+00:00",
"submission_deadline_time_zone": "Europe/London",
"ccy": "GBP",
"fee_methodology": "supplier_absorbed",
"fee_schedule_id": 501,
"award_type": "competition",
"risk_level_id": 501,
"is_template": false,
"quality_score_allocation_percentage": 50,
"cost_score_allocation_percentage": 50,
"award_suppliers": [
"direct",
"panel"
],
"approved": true,
"submitted_at": "2024-01-16T10:30:00+00:00",
"approved_at": "2024-01-16T10:30:00+00:00",
"hired_at": "2024-01-16T10:30:00+00:00",
"start_date": "2024-03-08",
"due_on": "2024-01-16",
"original_due_on": "2024-01-16",
"ended_at": "2024-01-16T10:30:00+00:00",
"closed_at": "2024-01-16T10:30:00+00:00",
"auto_close_at": "2024-01-16T10:30:00+00:00",
"halted_comment": null,
"cancellation_reason_id": 501,
"cancellation_other_reason": null,
"cancelled_by": {
"id": 101,
"first_name": "Demo",
"last_name": "User",
"email": "user1@example.com",
"org_id": 501,
"org_name": "Acme Corporation"
},
"cancelled_at": "2024-01-16T10:30:00+00:00",
"completed_by": {
"id": 101,
"first_name": "Demo",
"last_name": "User",
"email": "user1@example.com",
"org_id": 501,
"org_name": "Acme Corporation"
},
"closed_by": {
"id": 101,
"first_name": "Demo",
"last_name": "User",
"email": "user1@example.com",
"org_id": 501,
"org_name": "Acme Corporation"
},
"visibility": "visible",
"bafo_submission_deadline": "2024-01-16T10:30:00+00:00",
"bid_round": 101,
"original_project_id": 501,
"location": {
"type": "location",
"label": "London, UK"
},
"target_cost": {
"cents": 150000,
"currency": "GBP"
},
"budget": {
"cents": 150000,
"currency": "GBP"
},
"original_budget": {
"cents": 150000,
"currency": "GBP"
},
"rate": {
"cents": 150000,
"currency": "GBP"
},
"original_rate": {
"cents": 150000,
"currency": "GBP"
},
"fee": "1500.00",
"markup": "1500.00",
"estimated_savings": {
"cents": 150000,
"currency": "GBP"
},
"projected_recognized_savings": {
"cents": 150000,
"currency": "GBP"
},
"payment_terms_in_days": 30,
"client_payment_terms_in_days": 30,
"permit_supplier_defined_milestones": null,
"supplier_defined_milestones": null,
"client_defined_milestones_mandatory": null,
"invoices_cis": null,
"cis_end_user_client": null,
"is_child": false,
"is_parent": false,
"custom_fields": {
"department": "Engineering",
"priority": "high",
"cost_code": "CC-001"
},
"badges": [
"urgent",
"featured"
],
"project_screening_questions": [
{
"question": "Years of experience?",
"required": true
},
{
"question": "Available start date?",
"required": false
}
],
"client": {
"id": 101,
"first_name": "Demo",
"last_name": "User",
"email": "user1@example.com",
"org_id": 501,
"org_name": "Acme Corporation"
},
"administrator": {
"id": 101,
"first_name": "Demo",
"last_name": "User",
"email": "user1@example.com",
"org_id": 501,
"org_name": "Acme Corporation"
},
"client_org": {
"id": 101,
"name": "Acme Corporation",
"is_external_client": true
},
"cost_centers": [
{
"cost_center_id": 501,
"allocation_percentage": "1500.00",
"name": "Acme Corporation",
"code": null,
"admin_custom_fields": null,
"project_id": 501
},
{
"cost_center_id": 502,
"allocation_percentage": "1500.00",
"name": "Global Services Ltd",
"code": null,
"admin_custom_fields": null,
"project_id": 502
}
],
"milestones": [
{
"id": 101,
"title": "Website Redesign Project",
"status": "submitted",
"client_suggested": false,
"close_project": false,
"comments": "Additional information and context for this record.",
"details": "Additional information and context for this record.",
"due_on": "2024-01-16",
"project_summary": "Website Redesign Project - Complete redesign of corporate website with modern UX",
"mandatory": false,
"notes": "Additional information and context for this record.",
"original_id": 501,
"original_rate": {
"cents": 150000,
"currency": "GBP"
},
"purchase_order_line_id": 501,
"rate": {
"cents": 150000,
"currency": "GBP"
},
"submitted_at": "2024-01-16T10:30:00+00:00",
"interim_valuation_date": "2024-01-16T10:30:00+00:00",
"tiered_markup_fee": {
"cents": 150000,
"currency": "GBP"
},
"children": [
201,
202
],
"parents": [
201,
202
],
"custom_fields": {
"department": "Engineering",
"priority": "high",
"cost_code": "CC-001"
},
"created_at": "2024-01-16T10:30:00+00:00",
"updated_at": "2024-01-16T10:30:00+00:00",
"project_id": 501,
"final_claim": "false",
"delivered_on": "2024-01-16",
"approved_by": {
"id": 101,
"first_name": "Demo",
"last_name": "User",
"email": "user1@example.com",
"org_id": 501,
"org_name": "Acme Corporation"
},
"rejected_by": {
"id": 101,
"first_name": "Demo",
"last_name": "User",
"email": "user1@example.com",
"org_id": 501,
"org_name": "Acme Corporation"
},
"level_1_approved_by": {
"id": 101,
"first_name": "Demo",
"last_name": "User",
"email": "user1@example.com",
"org_id": 501,
"org_name": "Acme Corporation"
}
},
{
"id": 102,
"title": "Mobile App Development",
"status": "approved",
"client_suggested": false,
"close_project": false,
"comments": "Additional information and context for this record.",
"details": "Additional information and context for this record.",
"due_on": "2024-01-17",
"project_summary": "Website Redesign Project - Complete redesign of corporate website with modern UX",
"mandatory": false,
"notes": "Additional information and context for this record.",
"original_id": 502,
"original_rate": {
"cents": 300000,
"currency": "GBP"
},
"purchase_order_line_id": 502,
"rate": {
"cents": 300000,
"currency": "GBP"
},
"submitted_at": "2024-01-17T10:30:00+00:00",
"interim_valuation_date": "2024-01-17T10:30:00+00:00",
"tiered_markup_fee": {
"cents": 300000,
"currency": "GBP"
},
"children": [
202,
203
],
"parents": [
202,
203
],
"custom_fields": {
"department": "Engineering",
"priority": "high",
"cost_code": "CC-001"
},
"created_at": "2024-01-17T10:30:00+00:00",
"updated_at": "2024-01-17T10:30:00+00:00",
"project_id": 502,
"final_claim": "true",
"delivered_on": "2024-01-17",
"approved_by": {
"id": 102,
"first_name": "Jane",
"last_name": "Smith",
"email": "user2@example.com",
"org_id": 502,
"org_name": "Global Services Ltd"
},
"rejected_by": {
"id": 102,
"first_name": "Jane",
"last_name": "Smith",
"email": "user2@example.com",
"org_id": 502,
"org_name": "Global Services Ltd"
},
"level_1_approved_by": {
"id": 102,
"first_name": "Jane",
"last_name": "Smith",
"email": "user2@example.com",
"org_id": 502,
"org_name": "Global Services Ltd"
}
}
],
"supplier": {
"id": 101,
"name": "Acme Corporation",
"email": "user1@example.com",
"vetting_status": "PASSED",
"tax_number": "Example tax_number",
"tax_registered": true
},
"created_at": "2024-01-16T10:30:00+00:00",
"updated_at": "2024-01-16T10:30:00+00:00",
"project_matches_count": 5,
"project_line_items": [
{
"id": 101,
"name": "Acme Corporation",
"manufacturer_name": "Example manufacturer_name",
"manufacturer_part_number": "Example manufacturer_part_number",
"uom": null,
"item": null,
"item_type": "service",
"price": {
"cents": 150000,
"currency": "GBP"
},
"quantity": "1500.00",
"net_total_price": null,
"quantity_delivered": null,
"quantity_undelivered": null,
"custom_fields": {
"department": "Engineering",
"priority": "high",
"cost_code": "CC-001"
},
"created_at": "2024-01-16T10:30:00+00:00",
"updated_at": "2024-01-16T10:30:00+00:00",
"project_id": 501
},
{
"id": 102,
"name": "Global Services Ltd",
"manufacturer_name": "Example manufacturer_name",
"manufacturer_part_number": "Example manufacturer_part_number",
"uom": null,
"item": null,
"item_type": "item",
"price": {
"cents": 300000,
"currency": "GBP"
},
"quantity": "1500.00",
"net_total_price": null,
"quantity_delivered": null,
"quantity_undelivered": null,
"custom_fields": {
"department": "Engineering",
"priority": "high",
"cost_code": "CC-001"
},
"created_at": "2024-01-17T10:30:00+00:00",
"updated_at": "2024-01-17T10:30:00+00:00",
"project_id": 502
}
],
"award_criteria_groups": [
{
"id": 101,
"name": "Acme Corporation",
"group_type": "Example group_type",
"weighting": 101,
"has_sub_criteria": true,
"position": 101,
"project_quality_criteria": []
},
{
"id": 102,
"name": "Global Services Ltd",
"group_type": "Example group_type",
"weighting": 102,
"has_sub_criteria": true,
"position": 102,
"project_quality_criteria": []
}
]
}{
"error": "invalid_token",
"error_description": "The access token provided is expired, revoked, malformed, or invalid for other reasons"
}{
"error": "insufficient_scope",
"error_description": "The request requires higher privileges than provided by the access token",
"required_scope": "projects:write",
"provided_scopes": [
"welcome:read"
]
}{
"message": "Record not found"
}{
"error": "State transition from 'completed' to 'draft' is not allowed"
}Update a Project
curl --request PATCH \
--url https://api.zivio.net/api/v4/projects/{id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'zivio-tenant-id: <api-key>' \
--data '
{
"project": {
"title": "Updated Project Title"
}
}
'{
"id": 101,
"title": "Website Redesign Project",
"description": "Complete redesign of corporate website with modern UX",
"state": "pending",
"additional_notes": "Additional information and context for this record.",
"skill_category": {
"id": 101,
"name": "Acme Corporation",
"code": "Example code",
"slug": "Example slug",
"precedence": 101,
"parent_id": 501,
"parent_name": "Example parent_name",
"parent_slug": "Example parent_slug"
},
"skill_subcategory": {
"id": 101,
"name": "Acme Corporation",
"code": "Example code",
"slug": "Example slug",
"precedence": 101,
"parent_id": 501,
"parent_name": "Example parent_name",
"parent_slug": "Example parent_slug"
},
"skill_category_tier3": {
"id": 101,
"name": "Acme Corporation",
"code": "Example code",
"slug": "Example slug",
"precedence": 101,
"parent_id": 501,
"parent_name": "Example parent_name",
"parent_slug": "Example parent_slug"
},
"skills": [
{
"id": 101,
"name": "Acme Corporation",
"slug": "Example slug"
},
{
"id": 102,
"name": "Global Services Ltd",
"slug": "Example slug"
}
],
"talent_pool_id": 501,
"type": "standard",
"posting_type": "public",
"bids_count": 5,
"submission_deadline": "2024-01-16T10:30:00+00:00",
"submission_deadline_time_zone": "Europe/London",
"ccy": "GBP",
"fee_methodology": "supplier_absorbed",
"fee_schedule_id": 501,
"award_type": "competition",
"risk_level_id": 501,
"is_template": false,
"quality_score_allocation_percentage": 50,
"cost_score_allocation_percentage": 50,
"award_suppliers": [
"direct",
"panel"
],
"approved": true,
"submitted_at": "2024-01-16T10:30:00+00:00",
"approved_at": "2024-01-16T10:30:00+00:00",
"hired_at": "2024-01-16T10:30:00+00:00",
"start_date": "2024-03-08",
"due_on": "2024-01-16",
"original_due_on": "2024-01-16",
"ended_at": "2024-01-16T10:30:00+00:00",
"closed_at": "2024-01-16T10:30:00+00:00",
"auto_close_at": "2024-01-16T10:30:00+00:00",
"halted_comment": null,
"cancellation_reason_id": 501,
"cancellation_other_reason": null,
"cancelled_by": {
"id": 101,
"first_name": "Demo",
"last_name": "User",
"email": "user1@example.com",
"org_id": 501,
"org_name": "Acme Corporation"
},
"cancelled_at": "2024-01-16T10:30:00+00:00",
"completed_by": {
"id": 101,
"first_name": "Demo",
"last_name": "User",
"email": "user1@example.com",
"org_id": 501,
"org_name": "Acme Corporation"
},
"closed_by": {
"id": 101,
"first_name": "Demo",
"last_name": "User",
"email": "user1@example.com",
"org_id": 501,
"org_name": "Acme Corporation"
},
"visibility": "visible",
"bafo_submission_deadline": "2024-01-16T10:30:00+00:00",
"bid_round": 101,
"original_project_id": 501,
"location": {
"type": "location",
"label": "London, UK"
},
"target_cost": {
"cents": 150000,
"currency": "GBP"
},
"budget": {
"cents": 150000,
"currency": "GBP"
},
"original_budget": {
"cents": 150000,
"currency": "GBP"
},
"rate": {
"cents": 150000,
"currency": "GBP"
},
"original_rate": {
"cents": 150000,
"currency": "GBP"
},
"fee": "1500.00",
"markup": "1500.00",
"estimated_savings": {
"cents": 150000,
"currency": "GBP"
},
"projected_recognized_savings": {
"cents": 150000,
"currency": "GBP"
},
"payment_terms_in_days": 30,
"client_payment_terms_in_days": 30,
"permit_supplier_defined_milestones": null,
"supplier_defined_milestones": null,
"client_defined_milestones_mandatory": null,
"invoices_cis": null,
"cis_end_user_client": null,
"is_child": false,
"is_parent": false,
"custom_fields": {
"department": "Engineering",
"priority": "high",
"cost_code": "CC-001"
},
"badges": [
"urgent",
"featured"
],
"project_screening_questions": [
{
"question": "Years of experience?",
"required": true
},
{
"question": "Available start date?",
"required": false
}
],
"client": {
"id": 101,
"first_name": "Demo",
"last_name": "User",
"email": "user1@example.com",
"org_id": 501,
"org_name": "Acme Corporation"
},
"administrator": {
"id": 101,
"first_name": "Demo",
"last_name": "User",
"email": "user1@example.com",
"org_id": 501,
"org_name": "Acme Corporation"
},
"client_org": {
"id": 101,
"name": "Acme Corporation",
"is_external_client": true
},
"cost_centers": [
{
"cost_center_id": 501,
"allocation_percentage": "1500.00",
"name": "Acme Corporation",
"code": null,
"admin_custom_fields": null,
"project_id": 501
},
{
"cost_center_id": 502,
"allocation_percentage": "1500.00",
"name": "Global Services Ltd",
"code": null,
"admin_custom_fields": null,
"project_id": 502
}
],
"milestones": [
{
"id": 101,
"title": "Website Redesign Project",
"status": "submitted",
"client_suggested": false,
"close_project": false,
"comments": "Additional information and context for this record.",
"details": "Additional information and context for this record.",
"due_on": "2024-01-16",
"project_summary": "Website Redesign Project - Complete redesign of corporate website with modern UX",
"mandatory": false,
"notes": "Additional information and context for this record.",
"original_id": 501,
"original_rate": {
"cents": 150000,
"currency": "GBP"
},
"purchase_order_line_id": 501,
"rate": {
"cents": 150000,
"currency": "GBP"
},
"submitted_at": "2024-01-16T10:30:00+00:00",
"interim_valuation_date": "2024-01-16T10:30:00+00:00",
"tiered_markup_fee": {
"cents": 150000,
"currency": "GBP"
},
"children": [
201,
202
],
"parents": [
201,
202
],
"custom_fields": {
"department": "Engineering",
"priority": "high",
"cost_code": "CC-001"
},
"created_at": "2024-01-16T10:30:00+00:00",
"updated_at": "2024-01-16T10:30:00+00:00",
"project_id": 501,
"final_claim": "false",
"delivered_on": "2024-01-16",
"approved_by": {
"id": 101,
"first_name": "Demo",
"last_name": "User",
"email": "user1@example.com",
"org_id": 501,
"org_name": "Acme Corporation"
},
"rejected_by": {
"id": 101,
"first_name": "Demo",
"last_name": "User",
"email": "user1@example.com",
"org_id": 501,
"org_name": "Acme Corporation"
},
"level_1_approved_by": {
"id": 101,
"first_name": "Demo",
"last_name": "User",
"email": "user1@example.com",
"org_id": 501,
"org_name": "Acme Corporation"
}
},
{
"id": 102,
"title": "Mobile App Development",
"status": "approved",
"client_suggested": false,
"close_project": false,
"comments": "Additional information and context for this record.",
"details": "Additional information and context for this record.",
"due_on": "2024-01-17",
"project_summary": "Website Redesign Project - Complete redesign of corporate website with modern UX",
"mandatory": false,
"notes": "Additional information and context for this record.",
"original_id": 502,
"original_rate": {
"cents": 300000,
"currency": "GBP"
},
"purchase_order_line_id": 502,
"rate": {
"cents": 300000,
"currency": "GBP"
},
"submitted_at": "2024-01-17T10:30:00+00:00",
"interim_valuation_date": "2024-01-17T10:30:00+00:00",
"tiered_markup_fee": {
"cents": 300000,
"currency": "GBP"
},
"children": [
202,
203
],
"parents": [
202,
203
],
"custom_fields": {
"department": "Engineering",
"priority": "high",
"cost_code": "CC-001"
},
"created_at": "2024-01-17T10:30:00+00:00",
"updated_at": "2024-01-17T10:30:00+00:00",
"project_id": 502,
"final_claim": "true",
"delivered_on": "2024-01-17",
"approved_by": {
"id": 102,
"first_name": "Jane",
"last_name": "Smith",
"email": "user2@example.com",
"org_id": 502,
"org_name": "Global Services Ltd"
},
"rejected_by": {
"id": 102,
"first_name": "Jane",
"last_name": "Smith",
"email": "user2@example.com",
"org_id": 502,
"org_name": "Global Services Ltd"
},
"level_1_approved_by": {
"id": 102,
"first_name": "Jane",
"last_name": "Smith",
"email": "user2@example.com",
"org_id": 502,
"org_name": "Global Services Ltd"
}
}
],
"supplier": {
"id": 101,
"name": "Acme Corporation",
"email": "user1@example.com",
"vetting_status": "PASSED",
"tax_number": "Example tax_number",
"tax_registered": true
},
"created_at": "2024-01-16T10:30:00+00:00",
"updated_at": "2024-01-16T10:30:00+00:00",
"project_matches_count": 5,
"project_line_items": [
{
"id": 101,
"name": "Acme Corporation",
"manufacturer_name": "Example manufacturer_name",
"manufacturer_part_number": "Example manufacturer_part_number",
"uom": null,
"item": null,
"item_type": "service",
"price": {
"cents": 150000,
"currency": "GBP"
},
"quantity": "1500.00",
"net_total_price": null,
"quantity_delivered": null,
"quantity_undelivered": null,
"custom_fields": {
"department": "Engineering",
"priority": "high",
"cost_code": "CC-001"
},
"created_at": "2024-01-16T10:30:00+00:00",
"updated_at": "2024-01-16T10:30:00+00:00",
"project_id": 501
},
{
"id": 102,
"name": "Global Services Ltd",
"manufacturer_name": "Example manufacturer_name",
"manufacturer_part_number": "Example manufacturer_part_number",
"uom": null,
"item": null,
"item_type": "item",
"price": {
"cents": 300000,
"currency": "GBP"
},
"quantity": "1500.00",
"net_total_price": null,
"quantity_delivered": null,
"quantity_undelivered": null,
"custom_fields": {
"department": "Engineering",
"priority": "high",
"cost_code": "CC-001"
},
"created_at": "2024-01-17T10:30:00+00:00",
"updated_at": "2024-01-17T10:30:00+00:00",
"project_id": 502
}
],
"award_criteria_groups": [
{
"id": 101,
"name": "Acme Corporation",
"group_type": "Example group_type",
"weighting": 101,
"has_sub_criteria": true,
"position": 101,
"project_quality_criteria": []
},
{
"id": 102,
"name": "Global Services Ltd",
"group_type": "Example group_type",
"weighting": 102,
"has_sub_criteria": true,
"position": 102,
"project_quality_criteria": []
}
]
}{
"error": "invalid_token",
"error_description": "The access token provided is expired, revoked, malformed, or invalid for other reasons"
}{
"error": "insufficient_scope",
"error_description": "The request requires higher privileges than provided by the access token",
"required_scope": "projects:write",
"provided_scopes": [
"welcome:read"
]
}{
"message": "Record not found"
}{
"error": "State transition from 'completed' to 'draft' is not allowed"
}Authorizations
OAuth 2.0 client credentials. The access token from POST /oauth/token is sent as a bearer token. Request only the scopes you need.
Your Zivio organisation identifier. The regional API endpoints serve every Zivio organisation, so each request must identify yours.
Path Parameters
Project ID
Body
Input schema for creating and updating a project. Only fields listed here are accepted — unrecognised fields are silently ignored. Read-only fields visible in the response (e.g. supplier_id, state, awarded_at) cannot be set via the API. supplier_id is set internally when a project is hired and cannot be assigned directly. The V4 API only permits write operations on projects in draft or pending state.
Show child attributes
Show child attributes
Response
Project updated
draft, pending, new, halted, in_progress, work_completed, cancelled, closed, superseded, bafo "draft"
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
markup, supplier_absorbed, tiered_markup, supplier_absorbed_itemized, markup_itemized "markup"
direct_award, competition "direct_award"
true
true
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
true
true
Key-value pairs of custom field data
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes

