PRproductive
Custom Field Options

Updates a custom field option

Changed on

Update a custom field option.

patch/api/v2/custom_field_options/{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/custom_field_options/{id}
  • Auth
    none declared

Path parameters

idstring required

ID

Request body

Example request

{
  "data": {
    "type": "custom_fields",
    "attributes": {
      "name": "Priority",
      "field_type": "dropdown",
      "required": false,
      "filterable": true
    },
    "relationships": {
      "custom_field_section": {
        "data": {
          "type": "custom_field_sections",
          "id": "12"
        }
      }
    }
  }
}

Response

Single custom field option

Example response

{
  "data": {
    "id": "170576",
    "type": "custom_field_options",
    "attributes": {
      "name": "High",
      "color_id": "1",
      "position": 1,
      "archived_at": null
    },
    "relationships": {
      "custom_field": {
        "data": {
          "type": "custom_fields",
          "id": "53455"
        }
      }
    }
  },
  "included": []
}

Changes

  • 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

  • f11a8740641aRevision changes
    • breaking

      response property data/attributes/color_id list-of-types was widened by adding types null and string to media type application/vnd.api+json of response 200

    • breaking

      the // response's property type changed from string to no type, and format from date-time to no format for status

    • warning

      deleted the header request parameter X-Organization-Id

    • info

      added the non-success response with the status

    • info

      added to the // response property anyOf list for the response status

    • info

      added to the // response property anyOf list for the response status

    • info

      added subschema #2 to the // response property anyOf list for the response status

    • info

      removed subschema #1: Single data from the // response property anyOf list for the response status

    • info

      removed subschema #1: Single data from the // response property anyOf list for the response status

    • info

      the response property //// became required for the status

    • info

      the response property ///// became required for the status

    • info

      the response property //// became required for the status

    • info

      the response property ///// became required for the status

    This list may be incomplete.