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

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

{
    "name": "Casey Dach",
    "email": "string",
    "password": "string",
    "company_id": 0
}

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/role' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data-raw '{
    "name": "Casey Dach",
    "email": "string",
    "password": "string",
    "company_id": 0
}'

Responses

🟢201Created

application/json

Body

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

id

integer <uint32>

read-onlyrequired

Unique identifier of entity

>= 1<= 4294967296

Example:

1

name

string

required

phone

string

required

Examples:

1-310-793-5469+1-734-239-6055

coc

string

optional

Chamber of commerce number

<= 8 characters

financial_goal

integer <uint>

required

Yearly goal to achive

Default:

0

Examples:

70051500075000

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

Example

{
    "id": 1,
    "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,
        "user_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
        }
    }
}

🟠401Not Logged In

🔴500Server Error