Cirqll Core
HomeCirqll
HomeCirqll
  1. Contact
  • 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. Contact

Create

POST
/contact
Endpoint to create contact

Request

Authorization
Add the parameter
Authorization
to Headers
,whose value is to concatenate the Token after the Bearer.
Example:
Authorization: Bearer ********************
Header Params
Accept
string 
optional
Default:
application/json
Body Params application/json
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
Example
{
  "archived_at": "2024-08-20T00:24:23.133Z",
  "email": "Marjolaine_OHara37@gmail.com",
  "first_name": "Brock",
  "function": "consequat",
  "import_id": 839738802,
  "last_name": "Ullrich",
  "more_info": "ea dolore cillum",
  "phone": "1-331-794-6594",
  "customer_id": 4,
  "customer": {
    "name": "Heaney - Boyle",
    "next_contact": "2014-02-15T03:08:38.595Z",
    "email": "cleora42@gmail.com",
    "phone": "1-848-429-9425",
    "show_on_map": true,
    "coc": "qui",
    "description": "Distinctio commodi rerum reprehenderit consequatur quidem optio quibusdam. Nostrum aliquam quam voluptatibus odio pariatur nam quod veritatis et. Voluptates dolor dolorum molestias ipsum consectetur inventore ad. Autem id quibusdam asperiores assumenda libero voluptates. Illum consequatur tempore voluptas fugit voluptatum. Perferendis est et quos voluptatum quisquam impedit laborum cupiditate.",
    "user_id": 6,
    "user": {
      "name": "Casey Dach",
      "email": "Katheryn39@yahoo.com",
      "password": "Vel voluptates reprehenderit consequuntur necessitatibus maxime quia accusamus similique.",
      "next_notification": "2021-08-29",
      "phone": "+1-734-239-6055",
      "coc": "99594509",
      "financial_goal": 75000,
      "user_id": 6,
      "user": {
        "name": "Miracle Langworth",
        "email": "Katheryn39@yahoo.com",
        "password": "Vel voluptates reprehenderit consequuntur necessitatibus maxime quia accusamus similique.",
        "next_notification": "2021-08-29",
        "phone": "+1-734-239-6055",
        "coc": "99594509",
        "financial_goal": 15000,
        "user_id": 6,
        "user": {},
        "address_id": 4,
        "address": {
          "street": "Corwin Parkway",
          "house_number": 64,
          "addition": "a",
          "zipcode": "45668",
          "city": "Toyview",
          "province": "OV",
          "country": "DE",
          "extra_address_line_one": "cillum proident irure consequat",
          "extra_address_line_two": "fugiat aute qui in et",
          "lat": -267223.236781165,
          "lon": -87958720.89177416,
          "updated_at": "2024-05-18 13:38:35"
        },
        "updated_at": "2024-05-18 13:38:35"
      },
      "address_id": 4,
      "address": {
        "street": "Georgianna Loop",
        "house_number": 100,
        "addition": "a",
        "zipcode": "45668",
        "city": "Lake Quentinmouth",
        "province": "UT",
        "country": "NL",
        "extra_address_line_one": "cillum proident irure consequat",
        "extra_address_line_two": "fugiat aute qui in et",
        "lat": -267223.236781165,
        "lon": -87958720.89177416
      },
      "updated_at": "2024-05-18 13:38:35"
    },
    "address_id": 4,
    "address": {
      "street": "Georgianna Loop",
      "house_number": 64,
      "addition": "a",
      "zipcode": "45668",
      "city": "Toyview",
      "province": "DR",
      "country": "EN",
      "extra_address_line_one": "cillum proident irure consequat",
      "extra_address_line_two": "fugiat aute qui in et",
      "lat": -267223.236781165,
      "lon": -87958720.89177416
    },
    "updated_at": "2024-05-18 13:38:35"
  },
  "updated_at": "2024-05-18 13:38:35"
}

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 POST 'https://api.cirqll.nl/api/contact' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data-raw '{
    "archived_at": "2024-08-20T00:24:23.133Z",
    "email": "Marjolaine_OHara37@gmail.com",
    "first_name": "Brock",
    "function": "consequat",
    "import_id": 839738802,
    "last_name": "Ullrich",
    "more_info": "ea dolore cillum",
    "phone": "1-331-794-6594",
    "customer_id": 4,
    "customer": {
        "name": "Heaney - Boyle",
        "next_contact": "2014-02-15T03:08:38.595Z",
        "email": "cleora42@gmail.com",
        "phone": "1-848-429-9425",
        "show_on_map": true,
        "coc": "qui",
        "description": "Distinctio commodi rerum reprehenderit consequatur quidem optio quibusdam. Nostrum aliquam quam voluptatibus odio pariatur nam quod veritatis et. Voluptates dolor dolorum molestias ipsum consectetur inventore ad. Autem id quibusdam asperiores assumenda libero voluptates. Illum consequatur tempore voluptas fugit voluptatum. Perferendis est et quos voluptatum quisquam impedit laborum cupiditate.",
        "user_id": 6,
        "user": {
            "name": "Casey Dach",
            "email": "Katheryn39@yahoo.com",
            "password": "Vel voluptates reprehenderit consequuntur necessitatibus maxime quia accusamus similique.",
            "next_notification": "2021-08-29",
            "phone": "+1-734-239-6055",
            "coc": "99594509",
            "financial_goal": 75000,
            "user_id": 6,
            "user": {
                "name": "Miracle Langworth",
                "email": "Katheryn39@yahoo.com",
                "password": "Vel voluptates reprehenderit consequuntur necessitatibus maxime quia accusamus similique.",
                "next_notification": "2021-08-29",
                "phone": "+1-734-239-6055",
                "coc": "99594509",
                "financial_goal": 15000,
                "user_id": 6,
                "user": {},
                "address_id": 4,
                "address": {
                    "street": "Corwin Parkway",
                    "house_number": 64,
                    "addition": "a",
                    "zipcode": "45668",
                    "city": "Toyview",
                    "province": "OV",
                    "country": "DE",
                    "extra_address_line_one": "cillum proident irure consequat",
                    "extra_address_line_two": "fugiat aute qui in et",
                    "lat": -267223.236781165,
                    "lon": -87958720.89177416,
                    "updated_at": "2024-05-18 13:38:35"
                },
                "updated_at": "2024-05-18 13:38:35"
            },
            "address_id": 4,
            "address": {
                "street": "Georgianna Loop",
                "house_number": 100,
                "addition": "a",
                "zipcode": "45668",
                "city": "Lake Quentinmouth",
                "province": "UT",
                "country": "NL",
                "extra_address_line_one": "cillum proident irure consequat",
                "extra_address_line_two": "fugiat aute qui in et",
                "lat": -267223.236781165,
                "lon": -87958720.89177416
            },
            "updated_at": "2024-05-18 13:38:35"
        },
        "address_id": 4,
        "address": {
            "street": "Georgianna Loop",
            "house_number": 64,
            "addition": "a",
            "zipcode": "45668",
            "city": "Toyview",
            "province": "DR",
            "country": "EN",
            "extra_address_line_one": "cillum proident irure consequat",
            "extra_address_line_two": "fugiat aute qui in et",
            "lat": -267223.236781165,
            "lon": -87958720.89177416
        },
        "updated_at": "2024-05-18 13:38:35"
    },
    "updated_at": "2024-05-18 13:38:35"
}'

Responses

🟢201Created
application/json
Body
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
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
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,
  "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",
  "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"
  },
  "created_at": "2024-05-18 13:38:35",
  "updated_at": "2024-05-18 13:38:35"
}
🟠401Not Logged In
🔴500Server Error
Modified at 2025-05-06 02:34:32
Previous
Show
Next
Update
Built with