POST
/
api
/
v2
/
public
/
linked-account
curl --request POST \
  --url https://api.gocobalt.io/api/v2/public/linked-account \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '{
  "linked_account_id": "<string>",
  "name": "<string>",
  "your_app": {},
  "udf": {}
}'
{
    "_id": "64cb7c433c6dddda0fb6bde8",
    "associated_org": "63dba3b4d9c4be8f0f3f5e8f",
    "account_id": "1234567893",
    "environment": "test",
    "name": "Charizard8",
    "udf": [],
    "createdAt": "2023-08-03T10:06:59.703Z",
    "updatedAt": "2023-08-03T10:06:59.833Z",
    "__v": 1
}

This API allows you to create a new linked account for your customer within Cobalt’s platform. Linked accounts represent your end-users or customers, and they are essential for enabling connections with third-party applications.

Request description

Body Parameters

linked_account_id
string
required

Unique customer identification id. For Eg: markwood@some_email.com

name
string

User name. for Eg: Mark Wood

your_app
object

An object containing the details of your application associated with you account

udf
object

An object containing user-defined fields (if any) associated with the linked account.

Response description

_id
string

index id of the record created

associated_org
string

Organization Id

account_id
string

Linked account id

environment
string

Environment in which the account was created

name
string

Name of the linked account

udf
array

Initial values passed while creating the linked account. User can pass any values of primitive datatypes.

createdAt
date

Creation time

updatedAt
date

`Last update time

__v
integer