Update - Crego APIs

Request

Authorization

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

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

Path Params

contact_id

string

required

Example:

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

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}$

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}$

Example

{
    
    "tags": [
        "9uJPe0RjSZ",
        "RIPx3gSDNzV",
        "ZdZ- gtkSZTBZeO6m"
    ]
  
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

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}$

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}$

Example

{"id":"01JQ8RRBB2XRSVTCG11Y6JKCKH","namespace":"Vayana","tenant_id":"23067dbc-6c62-4203-9014-7100e4ffe811","created_by":"6da08401-b1f7-46ec-9013-2a9d7bc6185c","updated_by":"6da08401-b1f7-46ec-9013-2a9d7bc6185c","created_at":"2025-03-26T13:52:59.683345Z","updated_at":"2025-03-26T13:54:34.531893Z","name":"Sukumar","ref_id":"jijkdmkdoedmsaad","status":"active","type":"individual","tags":["9uJPe0RjSZ","RIPx3gSDNzV","ZdZ- gtkSZTBZeO6m"],"refs":{},"branch_id":"","props":["01JQ8RRB3HN71YQWJK8QRWG80K"]}