Cirqll Core
HomeCirqll
HomeCirqll
  1. Contract
  • Query Parameters
    • Eager Loading
    • Partial Data
    • Count Relations
    • Pagination
      • Filter
      • Order By
  • Authentication
    • OAuth2
      • Authorize
        • Authorize
      • User
        • Me
      • Client
        • Index
        • Create
        • Update
        • Delete
      • Token
        • Create
        • Refresh
        • Index
      • Scopes
  • User
    • Index
      GET
    • Show
      GET
    • Create
      POST
    • Update
      PATCH
    • Delete
      DELETE
  • Role
    • Index
      GET
    • Show
      GET
    • Create
      POST
    • Update
      PATCH
    • Delete
      DELETE
  • Customer
    • Index
      GET
    • Show
      GET
    • Create
      POST
    • Update
      PATCH
    • Delete
      DELETE
  • Contact
    • Index
    • Show
    • Create
    • Update
    • Delete
  • Appointment
    • Index
    • Show
    • Create
    • Update
    • Delete
  • Task
    • Index
    • Show
    • Create
    • Update
    • Delete
  • Financial
    • Chance
      • Index
      • Show
      • Create
      • Update
      • Delete
    • Assignment
      • Index
      • Show
      • Create
      • Update
      • Delete
    • Contract
      • Index
        GET
      • Show
        GET
      • Create
        POST
      • Update
        PATCH
      • Delete
        DELETE
  • Email
    • Index
    • Show
    • Create
    • Update
    • Delete
  • Field
    • Index
    • Show
    • Create
    • Update
    • Delete
  • Note
    • Index
    • Show
    • Create
    • Update
    • Delete
  • To-do
    • Index
    • Show
    • Create
    • Update
    • Delete
  • Template
    • Index
    • Show
    • Update
    • Create
    • Delete
  • Setting
    • Index
    • Update
  • Webhook
    • Index
    • Show
    • Create
    • Update
    • Delete
  1. Contract

Update

PATCH
/contract/{id}
Financial
Update contract based on unique entity id

Request

Authorization
Add the parameter
Authorization
to Headers，whose value is to concatenate the Token after the Bearer.
Example:
Authorization: Bearer ********************
Path Params
id
integer 
required
Header Params
Accept
string 
optional
Default:
application/json
Body Params application/json
name
string <char>
required
Name of the chance
>= 0 characters<= 255 characters
price
number <float>
required
Value of the chance, is used for the financial dashboard to get your earnings in the selected date frame
>= 0
description
string <char>
optional
Description which can be left to inform other colleagues of the progress or give context
<= 65535 characters
percentage
integer <int32>
required
Succesrate percentage of a chance completing
>= 0<= 100
customer_id
integer <uint32>
required
user_id
integer <uint32>
required
user
object 
User
optional
name
string 
required
<= 255 characters
Examples:
Casey DachMakayla BashirianMiracle Langworth
email
string 
required
<= 255 characters
password
string 
write-onlyrequired
<= 255 characters
company_id
integer <uint32>
required
archived_at
string <date-time> | null 
required
Example
{
  "name": "string",
  "price": 0,
  "description": "string",
  "percentage": 0,
  "customer_id": 0,
  "archived_at": "2019-08-24T14:15:22Z"
}

Request samples

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request PATCH 'https://api.cirqll.nl/api/contract/' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data-raw '{
    "name": "string",
    "price": 0,
    "description": "string",
    "percentage": 0,
    "customer_id": 0,
    "archived_at": "2019-08-24T14:15:22Z"
}'

Responses

🟢200Success
application/json
Body
id
integer <uint32>
read-onlyrequired
Unique identifier of entity
>= 1<= 4294967296
Example:
1
calculated_price
number 
read-onlyoptional
calculated value, read only
description
string 
optional
<= 65535 characters
end_date
string <date-time>
required
import_id
integer 
optional
>= 0<= 4294967296
name
string 
required
<= 255 characters
price
number 
required
price_type
integer 
required
1: monthly, 12: yearly
>= -2147483648<= 2147483647
Default:
1
reminder_date
string <date-time>
optional
start_date
string <date-time>
required
customer_id
integer <uint32>
required
customer
object 
Customer
read-onlyoptional
id
integer <uint32>
read-onlyrequired
Unique identifier of entity
>= 1<= 4294967296
Example:
1
name
string 
required
next_contact
string <date-time>
required
email
string <email>
required
<= 255 characters
Example:
cleora42@gmail.com
phone
string 
required
<= 255 characters
Example:
1-848-429-9425
show_on_map
boolean 
required
Default:
true
coc
string <char>
optional
<= 8 characters
description
string 
optional
user_id
integer <uint32>
required
user
object 
User
optional
address_id
integer <uint32>
required
address
object 
Address
required
created_at
string <date-time>
read-onlyrequired
Date at which the entity was created
Example:
2024-05-18 13:38:35
updated_at
string <date-time>
read-onlyrequired
Date at which the entity was last changed
Example:
2024-05-18 13:38:35
contact_id
integer <uint32>
required
contact
object 
Contact
required
id
integer <uint32>
read-onlyrequired
Unique identifier of entity
>= 1<= 4294967296
Example:
1
archived_at
string <date-time>
optional
email
string 
optional
<= 255 characters
first_name
string 
required
<= 255 characters
function
string 
optional
<= 255 characters
import_id
integer 
optional
>= 0<= 4294967296
last_name
string 
required
<= 255 characters
more_info
string 
optional
<= 65535 characters
phone
string 
optional
<= 255 characters
customer_id
integer <uint32>
required
customer
object 
Customer
read-onlyoptional
created_at
string <date-time>
read-onlyrequired
Date at which the entity was created
Example:
2024-05-18 13:38:35
updated_at
string <date-time>
read-onlyrequired
Date at which the entity was last changed
Example:
2024-05-18 13:38:35
chance_id
integer <uint32>
required
chance
object 
Chance
required
id
integer <uint32>
read-onlyrequired
Unique identifier of entity
>= 1<= 4294967296
Example:
1
name
string <char>
required
Name of the chance
>= 0 characters<= 255 characters
price
number <float>
required
Value of the chance, is used for the financial dashboard to get your earnings in the selected date frame
>= 0
description
string <char>
optional
Description which can be left to inform other colleagues of the progress or give context
<= 65535 characters
percentage
integer <int32>
required
Succesrate percentage of a chance completing
>= 0<= 100
customer_id
integer <uint32>
required
customer
object 
Customer
read-onlyoptional
user_id
integer <uint32>
required
user
object 
User
optional
created_at
string <date-time>
read-onlyrequired
Date at which the entity was created
Example:
2024-05-18 13:38:35
updated_at
string <date-time>
read-onlyrequired
Date at which the entity was last changed
Example:
2024-05-18 13:38:35
archived_at
string <date-time> | null 
required
created_at
string <date-time>
read-onlyrequired
Date at which the entity was created
Example:
2024-05-18 13:38:35
updated_at
string <date-time>
read-onlyrequired
Date at which the entity was last changed
Example:
2024-05-18 13:38:35
archived_at
string <date-time> | null 
required
user_id
integer <uint32>
required
user
object 
User
optional
Example
{
  "id": 1,
  "calculated_price": 0,
  "description": "string",
  "end_date": "2019-08-24T14:15:22Z",
  "import_id": 0,
  "name": "string",
  "price": 0,
  "price_type": "1",
  "reminder_date": "2019-08-24T14:15:22Z",
  "start_date": "2019-08-24T14:15:22Z",
  "customer_id": 0,
  "customer": {
    "name": "string",
    "next_contact": "2019-08-24T14:15:22Z",
    "email": "cleora42@gmail.com",
    "phone": "1-848-429-9425",
    "show_on_map": true,
    "coc": "string",
    "description": "string",
    "user_id": 0,
    "user": {
      "name": "Casey Dach",
      "email": "string",
      "created_at": "2024-05-18 13:38:35",
      "updated_at": "2024-05-18 13:38:35",
      "company_id": 0,
      "company": {
        "name": "string",
        "phone": "1-310-793-5469",
        "coc": "string",
        "financial_goal": 0,
        "address_id": 0,
        "address": {
          "street": "Georgianna Loop",
          "house_number": 12,
          "addition": "A",
          "zipcode": "45668",
          "city": "Lake Quentinmouth",
          "province": "DR",
          "country": "NL",
          "extra_address_line_one": "string",
          "extra_address_line_two": "string",
          "lat": 0,
          "lon": 0,
          "created_at": "2024-05-18 13:38:35",
          "updated_at": "2024-05-18 13:38:35"
        },
        "created_at": "2024-05-18 13:38:35",
        "updated_at": "2024-05-18 13:38:35"
      }
    },
    "address_id": 0,
    "address": {
      "street": "Georgianna Loop",
      "house_number": 12,
      "addition": "A",
      "zipcode": "45668",
      "city": "Lake Quentinmouth",
      "province": "DR",
      "country": "NL",
      "extra_address_line_one": "string",
      "extra_address_line_two": "string",
      "lat": 0,
      "lon": 0,
      "created_at": "2024-05-18 13:38:35",
      "updated_at": "2024-05-18 13:38:35"
    },
    "created_at": "2024-05-18 13:38:35",
    "updated_at": "2024-05-18 13:38:35"
  },
  "contact_id": 0,
  "contact": {
    "archived_at": "2019-08-24T14:15:22Z",
    "email": "string",
    "first_name": "string",
    "function": "string",
    "import_id": 0,
    "last_name": "string",
    "more_info": "string",
    "phone": "string",
    "created_at": "2024-05-18 13:38:35",
    "updated_at": "2024-05-18 13:38:35"
  },
  "chance_id": 0,
  "chance": {
    "name": "string",
    "price": 0,
    "description": "string",
    "percentage": 0,
    "created_at": "2024-05-18 13:38:35",
    "updated_at": "2024-05-18 13:38:35",
    "archived_at": "2019-08-24T14:15:22Z"
  },
  "created_at": "2024-05-18 13:38:35",
  "updated_at": "2024-05-18 13:38:35",
  "archived_at": "2019-08-24T14:15:22Z"
}
🟠404Record Not Found
🟠401Not Logged In
🔴500Server Error
Modified at 2025-05-06 02:34:32
Previous
Create
Next
Delete
Built with