Cirqll Core
HomeCirqll
HomeCirqll
  1. Customer
  • Getting Started
  • Query Parameters
    • Eager Loading
    • Partial Data
    • Count Relations
    • Filter
    • Order By
    • Pagination
  • 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
      GET
    • Show
      GET
    • Create
      POST
    • Update
      PATCH
    • Delete
      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
      • Show
      • Create
      • Update
      • 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. Customer

Update

PATCH
https://api.cirqll.nl/api/customer/{id}
Update customer 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
No schema defined
Example
{
    "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",
        "password": "string",
        "company_id": 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
    }
}

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/customer/' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data-raw '{
    "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",
        "password": "string",
        "company_id": 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
    }
}'

Responses

🟢200Success
application/json
Body
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
id
integer <uint32>
read-onlyrequired
Unique identifier of entity
>= 1<= 4294967296
Example:
1
name
string 
required
<= 255 characters
Examples:
Casey DachMakayla BashirianMiracle Langworth
email
string 
required
<= 255 characters
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
company_id
integer <uint32>
required
company
object 
Company
read-onlyoptional
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
Example
{
    "id": 1,
    "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"
}
🟠404Record Not Found
🟠401Not Logged In
🔴500Server Error
Modified at 2025-05-06 02:34:32
Previous
Create
Next
Delete
Built with