Request

Response

    Update properties of a Product Family
    PATCH

    product-families/{productFamilyId}

    Modifies only the specified attributes in the request body for the identified Product Family. Attributes not included in the request remain unchanged.

    Resource Information

    Method and URI
    PATCH
    https://api.aps.autodesk.com/fusion-operations/v2/product-families/{productFamilyId}
    Authentication Context
    No security required
    Required OAuth Scopes
    data:read data:write
    Data Format
    JSON

    Request

    Headers

    Content-Type*
    string
    Must be application/json
    * Required

    Request

    URI Parameters

    productFamilyId
    int
    The unique identifier of the Product Family to retrieve.

    Request

    Body Structure

    The Product Family attributes to be updated, conforming to the specified schema. Only the provided fields will be modified.

    code
    string
    Max length: 255
    name
    string
    Max length: 255

    Response

    HTTP Status Code Summary

    200
    OK
    Product Family updated successfully.
    400
    Bad Request
    Bad request due to invalid data.
    401
    Unauthorized
    The access token is invalid. It may have either expired or may not be a three-legged access token. Please verify the token and retry the request.
    403
    Forbidden
    The request was successfully validated but lacked required permission. Please verify your token permissions and retry the request.
    404
    Not Found
    The resource in the path does not exist.
    429
    Too Many Requests
    Rate limit exceeded; wait some time before retrying.
    500
    Internal Server Error
    An unknown server-side error occurred. Please try again later. If the problem persists, please contact support.

    Response

    Header (429)

    Retry-After
    integer
    The number of seconds to wait before retrying the request.

    Response

    Body Structure (200)

    id
    int
    The unique identifier of the Product Family to retrieve.
    code
    string
    Max length: 255
    name
    string
    Max length: 255

    Example

    Product Family updated successfully.

    Request

    curl -v 'https://developer.api.autodesk.com/fusion-operations/v2/product-families/:productFamilyId' \
      -X 'PATCH' \
      -H 'Authorization: ' \
      -H 'Content-Type: application/json' \
      -d '{
            "name": "MySuperProductFamily Updated"
          }'
    

    Response

    {
      "id": 3,
      "code": "MySuperProdFamily",
      "name": "MySuperProductFamily Updated"
    }