PRproductive
Deals

Update a deal

Changed on

Update a deal's attributes or relationships.

patch/api/v2/deals/{id}

Request

  • Base URL
    https://developer.productive.io (the document declares no server; this is the origin it was published from)
  • URL
    https://developer.productive.io/api/v2/deals/{id}
  • Auth
    none declared

Path parameters

idstring required

ID

Request body

Example request

{
  "data": {
    "type": "deals",
    "attributes": {
      "name": "Website Redesign Project",
      "date": "2026-01-15",
      "end_date": "2026-06-30",
      "description": "Full redesign of the company website"
    },
    "relationships": {
      "company": {
        "data": {
          "type": "companies",
          "id": "65111"
        }
      },
      "person": {
        "data": {
          "type": "people",
          "id": "12"
        }
      },
      "pipeline": {
        "data": {
          "type": "pipelines",
          "id": "1"
        }
      }
    }
  }
}

Response

Single deal

Example response

{
  "data": {
    "id": "89",
    "type": "deals",
    "attributes": {
      "name": "Website Redesign Project",
      "number": "DEAL-089",
      "status_id": 1,
      "date": "2026-01-15",
      "end_date": "2026-06-30",
      "closed_at": null,
      "lost_at": null,
      "created_at": "2026-01-15T10:00:00.000+00:00",
      "updated_at": "2026-03-01T09:00:00.000+00:00",
      "last_activity_at": "2026-03-01T09:00:00.000+00:00",
      "tag_list": [],
      "custom_fields": null,
      "description": "Redesigning the company website with new branding",
      "is_budget": false,
      "currency": "USD"
    },
    "relationships": {
      "company": {
        "data": {
          "type": "companies",
          "id": "65111"
        }
      },
      "person": {
        "data": {
          "type": "people",
          "id": "12"
        }
      },
      "pipeline": {
        "data": {
          "type": "pipelines",
          "id": "1"
        }
      },
      "deal_status": {
        "data": {
          "type": "deal_statuses",
          "id": "5"
        }
      }
    }
  },
  "included": []
}

Changes

  • 7dcc2525e812Revision changes
    • warning

      added the new netsuite_project_ambiguous enum value to the // response property for the response status

  • fa3060fd0144Revision changes
    • warning

      added the new bad_decimal_format enum value to the // response property for the response status

    • warning

      added the new non_finite_number enum value to the // response property for the response status

    • warning

      added the new null_bytes_in_params enum value to the // response property for the response status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status