Create - Cirqll Core

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

description

string | null

optional

<= 65535 characters

end_date

string <date-time>

required

location

string | null

optional

<= 255 characters

name

string

required

<= 255 characters

start_date

string <date-time>

required

customer_id

integer <uint32>

required

archived_at

string <date-time> | null

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

Example

{
  "description": "string",
  "end_date": "2019-08-24T14:15:22Z",
  "location": "string",
  "name": "string",
  "start_date": "2019-08-24T14:15:22Z",
  "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

curl --location --request POST 'https://api.cirqll.nl/api/appointment' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data-raw '{
    "description": "string",
    "end_date": "2019-08-24T14:15:22Z",
    "location": "string",
    "name": "string",
    "start_date": "2019-08-24T14:15:22Z",
    "customer_id": 0,
    "archived_at": "2019-08-24T14:15:22Z"
}'

Responses

🟢201Created

application/json

Body

id

integer <uint32>

read-onlyrequired

Unique identifier of entity

>= 1<= 4294967296

Example:

1

description

string | null

optional

<= 65535 characters

end_date

string <date-time>

required

location

string | null

optional

<= 255 characters

name

string

required

<= 255 characters

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

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

user_id

integer <uint32>

required

user

object

User

optional

Example

{
  "id": 1,
  "description": "string",
  "end_date": "2019-08-24T14:15:22Z",
  "location": "string",
  "name": "string",
  "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"
  },
  "archived_at": "2019-08-24T14:15:22Z",
  "created_at": "2024-05-18 13:38:35",
  "updated_at": "2024-05-18 13:38:35"
}

🟠401Not Logged In

🔴500Server Error