Create New CardRelation

Request

Query Params

show

string

optional

limit the response to show only specific properties, see show & hide for more info

Example:

id,updated_at

hide

string

optional

hide properties from the response, see show & hide for more info

Example:

created_at,updated_at

Header Params

x-api-key

string

required

Default:

x-api-env

string

required

Default:

Body Params application/json

type

enum<string>

optional

Allowed values:

relatedclonedblocksdepends

Default:

string <uuid>

required

card_id

string <uuid>

required

Unique identifier of the Card

Example

Request samples

Shell

JavaScript

Java

Swift

Go

PHP

Python

HTTP

C

C#

Objective-C

Ruby

OCaml

Dart

R

curl --location --request POST 'https://api.vplan.com/v1/card_relation' \
--header 'x-api-key;' \
--header 'x-api-env;' \
--header 'Content-Type: application/json' \
--data-raw ''

Responses

🟢201Created

application/json

Body

id

string <uuid>

read-onlyoptional

Unique identifier

type

enum<string>

optional

Allowed values:

relatedclonedblocksdepends

Default:

enum<string>

read-onlyoptional

Allowed values:

validwarningerror

Default:

valid

related_card_id

string <uuid>

required

card_id

string <uuid>

required

Unique identifier of the Card

created_at

string <date-time>

read-onlyoptional

Date and time of creation

Example:

2024-04-11T10:22:15Z

updated_at

string <date-time>

read-onlyoptional

Date and time of last update

Example:

2024-04-11T10:22:15Z

Example

{
  "id": "72e38664-7bd0-46f8-b943-8c9f266e4260",
  "card_id": "af380e19-f6b5-43fe-99cc-3b14fa82ec27",
  "related_card_id": "e76f5298-af05-45ec-b24c-ee4ce0159c3b",
  "type": "related",
  "status": "valid",
  "created_at": "2024-06-10T14:26:10Z",
  "updated_at": "2024-06-10T14:26:10Z"
}

🟠422Unprocessable Content

🟠401Not Logged In