Create - Crego APIs

Request

Authorization

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Body Params application/json

name

string

required

Name of the entity, 1-100 characters long, allowing letters, numbers, spaces, and common symbols (,.'-&()).

>= 1 characters<= 100 characters

Match pattern:

^[a-zA-Z0-9\s,.\-'&()]{1,100}$

namespace

string

required

Namespace for contact

status

enum<string>

required

Status of the entity. Allowed values are 'active' or 'inactive'.

Allowed values:

activeinactive

type

enum<string>

required

Type of the entity. Allowed values are 'individual' or 'corporate'.

Allowed values:

individualcorporate

Request samples

Shell

JavaScript

Java

Swift

Go

PHP

Python

HTTP

C

C#

Objective-C

Ruby

OCaml

Dart

R

curl --location --request POST 'https://preprod.api.crego.io/contacts/' \
--header 'Content-Type: application/json' \
--data-raw '{
    "name": "Sukumar",
    "ref_id":"jijkdmkdoedmsaad",
    "status": "active",
    "type": "individual",
    "tags": [
        "string"
    ],
    "refs": {},
    "branch_id": "",
    "namespace":"Vayana",
    "props": [
        {
            "key": "pan_no",
            "type": "number",
            "value":"123254684"
        }
    ]
    
}'

Responses

🟢201Created

application/json

Body

name

string

required

Name of the entity, 1-100 characters long, allowing letters, numbers, spaces, and common symbols (,.'-&()).

>= 1 characters<= 100 characters

Match pattern:

^[a-zA-Z0-9\s,.\-'&()]{1,100}$

namespace

string

required

Namespace for contact

status

enum<string>

required

Status of the entity. Allowed values are 'active' or 'inactive'.

Allowed values:

activeinactive

type

enum<string>

required

Type of the entity. Allowed values are 'individual' or 'corporate'.

Allowed values:

individualcorporate

tags

array[string]

optional

An array of unique tags.

refs

object

optional

Object to hold miscellaneous references.

props

array[object (Props) {3}]

required

key

string

required

Name of the entity, 1-100 characters long, allowing letters, numbers, spaces, and common symbols (,.'-&()).

>= 1 characters<= 100 characters

Match pattern:

^[a-zA-Z0-9\s,.\-'&()]{1,100}$

value

string

required

Value associated with the entity, 1-500 characters long.

>= 1 characters<= 500 characters

type

enum<string>

required

Type of the entity. Allowed values are 'file', 'number', 'text', or 'boolean'.

Allowed values:

filenumbertextboolean

rm_id

string

optional

Relationship manager ID, 1-50 characters long, allowing alphanumeric characters, dashes, and underscores.

Match pattern:

^[A-Za-z0-9_-]{1,50}$

branch_id

string

optional

Branch ID, 1-50 characters long, allowing alphanumeric characters, dashes, and underscores.

Match pattern:

^[A-Za-z0-9_-]{1,50}$

id

string

required

ID, 8-40 characters long, allowing alphanumeric characters.

>= 8 characters<= 40 characters

Match pattern:

^[a-zA-Z0-9._-]{8,50}$

created_at

string <date-time>

required

Timestamp indicating when the entity was created, in ISO 8601 format.

created_by

string

required

Created by, 1-100 characters long, allowing alphanumeric characters, spaces, periods, underscores, and dashes.

<= 100 characters

Match pattern:

^[a-zA-Z0-9._-]{8,50}$

updated_at

string <date-time>

optional

Timestamp indicating when the entity was last updated, in ISO 8601 format.

updated_by

string | null

optional

Updated by, 1-100 characters long, allowing alphanumeric characters, spaces, periods, underscores, and dashes.

<= 100 characters

Match pattern:

^[a-zA-Z0-9._-]{8,50}$

tenant_id

string

required

Tenant ID, 6-40 characters long, allowing alphanumeric characters.

<= 40 characters

Match pattern:

^[a-zA-Z0-9._-]{8,50}$

Examples

SuccessSuccess with detailSuccess with Props

{"id":"01JK7V37V8RY5NX22AF4QYSBB3","tenant_id":"59ecf94e-054d-43ee-83db-b158ab9d7f67","created_by":"cffe818a-5003-4116-9104-069f7e062bb4","updated_by":"","created_at":"2025-02-04T12:11:52.033074Z","updated_at":"2025-02-04T12:11:52.033196Z","name":"Kaushick","status":"active","type":"individual","tags":["string"],"refs":{},"branch":null}

🟢201Created