Teamwork CRM API

Getting access, Developing, Testing

Back to Teamwork CRM

Update a product

Updates a product and returns it

The following values are allowed in the include query parameter:

  • owner
  • prices
  • avatar

Input

type: object properties: parameters: type: object properties: include: type: string description: |- Comma separated list of relationships to include in the response. See [including related entities](/crm/general/related-entities) for more detailed documentation of how this works. id: type: integer required: - id title: Parameters data: type: object title: Data properties: product: type: object properties: name: type: string owner: type: object properties: id: type: integer description: The id related entity. type: type: string description: The type of the related entity, e.g "users". prices: type: array description: >- [To-many relationship array](/crm/general/entity-models#to-many-relationships) which describes a list of resource identifier objects. items: type: object properties: id: type: integer description: The id related entity. type: type: string description: The type of the related entity, e.g "users". state: type: string

Output

type: object title: productResponse properties: included: type: object title: Included product: type: object title: Product properties: avatar: type: object properties: id: type: integer description: The id related entity. type: type: string description: The type of the related entity, e.g "users". createdAt: type: string description: When the item was created, as a datetime format: date-time createdBy: type: object properties: id: type: integer type: type: string enum: - users deletedAt: type: string description: When the item was deleted, as a datetime format: date-time deletedBy: type: object properties: id: type: integer type: type: string enum: - users id: type: integer name: type: string owner: type: object properties: id: type: integer description: The id related entity. type: type: string description: The type of the related entity, e.g "users". prices: type: array description: >- Prices related to the product. [Resource objects/entity models](/crm/general/entity-models#relationships) for more details on relationships. items: type: object properties: id: type: integer meta: type: object properties: price: type: integer description: >- Price of the product in the same currency as the deal in its lowest denomination, e.g for USD the value in cents. type: type: string enum: - currencies state: type: string description: State of the product. enum: - active - inactive updatedAt: type: string description: When the item was last updated, as a datetime format: date-time updatedBy: type: object properties: id: type: integer type: type: string enum: - users updatedSourceId: type: integer description: Source ID of the latest request made (API / Web app)