Weeek Public API
  1. CRM
  2. Deals
Weeek Public API
  • Get started
  • Workspace
    • Tag
      • Tag list
      • Create tag
      • Tag
      • Update tag
      • Delete tag
    • Get workspace info
      GET
    • Get workspace members
      GET
  • Task Manager
    • Project
      • Custom Fields
        • Options
          • Create a custom field option
          • Update a custom field option
          • Move a custom field option
          • Delete a custom field option
        • Create a custom field
        • Update a custom field
        • Delete a custom field
      • Get project list
      • Create project
      • Update project info
      • Delete project
      • Get project
      • Archive project
      • Un Archive project
    • Board
      • Custom Fields
        • Options
          • Create a custom field option
          • Update a custom field option
          • Move a custom field option
          • Delete a custom field option
        • Create a custom field
        • Update a custom field
        • Delete a custom field
      • Get board list
      • Create board
      • Update board
      • Delete board
      • Move board
    • BoardColumn
      • Get board column list
      • Create board column
      • Update board column
      • Delete board column
      • Move board column
    • Task
      • Attachments
        • Upload attachments
      • Time Entries
        • Create a time entry
        • Update a time entry
        • Delete a time entry
      • Watchers
        • Add watchers to a task
        • Remove watchers from a task
      • Get tasks
      • Create task
      • Get one task info
      • Update a task
      • Delete task
      • Complete task
      • Un complete task
      • Change board
      • Change board column
    • Custom Fields
      • Options
        • Create global custom field option
        • Update global custom field option
        • Move global custom field option
        • Delete global custom field option
      • Create global custom field
      • Update global custom field
      • Delete global custom field
      • Get global custom fields
  • CRM
    • Funnels
      • Custom Fields
        • Options
          • Create a custom field option
          • Update a custom field option
          • Move a custom field option
          • Delete a custom field option
        • Create a custom field
        • Update a custom field
        • Move a custom field
        • Delete a custom field
      • Get all funnels
      • Create a funnel
      • Get a funnel
      • Update a funnel
      • Delete a funnel
    • Funnel Statuses
      • Get all funnel statuses
      • Create a funnel status
      • Get a funnel status
      • Update a funnel status
      • Delete a funnel status
    • Deals
      • Assignees
        • Attach an assignee
        • Detach an assignee
      • Contacts
        • Attach a contact
        • Detach a contact
      • Organizations
        • Attach an organization
        • Detach an organization
      • Tags
        • Attach a tag
        • Detach a tag
      • Tasks
        • Attach a new task
        • Move a attached to the deal task
        • Detach a task
      • Attachments
        • Upload attachments
      • Get all deals
        GET
      • Create a deal
        POST
      • Get a deal
        GET
      • Update a deal
        PUT
      • Update a deal fields
        PATCH
      • Move a deal
        POST
      • Delete a deal
        DELETE
      • Update the deal funnel
        PUT
      • Update the deal funnel status
        PUT
    • Organizations
      • Addresses
        • Create an address
        • Update the address
        • Delete the address
      • Emails
        • Create an email
        • Update the email
        • Delete the email
      • Phones
        • Create a phone
        • Update the phone
        • Delete the phone
      • Contacts
        • Attach a contact
        • Detach the contact
      • Tags
        • Attach a tag
        • Detach the tag
      • Get all organizations
      • Create an organization
      • Get an organization
      • Update an organization
      • Delete an organization
    • Contacts
      • Emails
        • Create an email
        • Update the email
        • Delete the email
      • Phones
        • Create a phone
        • Update the phone
        • Delete the phone
      • Tags
        • Attach a tag
        • Detach the tag
      • Get all contacts
      • Create a contact
      • Get a contact
      • Update a contact
      • Delete a contact
    • Currencies
      • Get all currencies
  • User
    • Get profile
  • Attachments
    • Get an attachment
  1. CRM
  2. Deals

Update a deal fields

PATCH
https://api.weeek.net/public/v1/crm/deals/{id}
CRM.Deal

Request

Authorization
Provide your bearer token in the
Authorization
header when making requests to protected resources.
Example:
Authorization: Bearer ********************
Path Params
id
string 
required
Body Params application/json
title
string  | null 
optional
<= 255 characters
amount
number <double> | null 
optional
winStatus
enum<string>  | enum<null> 
optional
Allowed values:
wonlostarchived
description
string  | null 
optional
assignees
array[string <uuid>]
optional
organizations
array[string <uuid>]
optional
contacts
array[string <uuid>]
optional
tags
array[integer]
optional
customFields
object (Custom field values) 
optional
A key-value object with custom field id as key and custom field value
For example
"customFields" : {
    "<text_custom_field_id>": "Text value",
    "<boolean_custom_field_id>": true,
    "<datetime_custom_field_id>": "<ISO 8601 datetime string>",
    "<select_custom_field_id>": "<custom_field_option_id>"
    "<multiselect_custom_field_id>": ["<custom_field_option_id>"],
    "<member_custom_field_id>": ["<user_id>"],
    "<contact_custom_field_id>": "<contact_id>",
    "<link_custom_field_id>": "https://example.com",
    "<approval_custom_field_id>": ["<user_id>"]
}
Example

Responses

🟢200Success
application/json
Body
success
boolean 
optional
Example
{
  "success": true
}
Modified at 2024-01-23 10:07:01
Previous
Update a deal
Next
Move a deal
Built with