Create New Relation

Request

Header Params

x-api-key

string

required

Default:

x-api-env

string

required

Default:

Body Params application/json

name

string

optional

<= 100 characters

description

string | null

optional

<= 150 characters

type

string | null

optional

<= 255 characters

note

string | null

optional

<= 65535 characters

phone

string | null

optional

<= 25 characters

fax

string | null

optional

<= 25 characters

email

string <email> | null

optional

<= 254 characters

website

string <uri> | null

optional

<= 512 characters

Example

{
    "name": "string",
    "description": "string",
    "type": "string",
    "note": "string",
    "phone": "string",
    "fax": "string",
    "email": "user@example.com",
    "website": "http://example.com"
}

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/relation' \
--header 'x-api-key;' \
--header 'x-api-env;' \
--header 'Content-Type: application/json' \
--data-raw '{
    "name": "string",
    "description": "string",
    "type": "string",
    "note": "string",
    "phone": "string",
    "fax": "string",
    "email": "user@example.com",
    "website": "http://example.com"
}'

Responses

🟢201Created

application/json

Body

id

string <uuid>

read-onlyoptional

Unique identifier

name

string

optional

<= 100 characters

description

string | null

optional

<= 150 characters

type

string | null

optional

<= 255 characters

note

string | null

optional

<= 65535 characters

phone

string | null

optional

<= 25 characters

fax

string | null

optional

<= 25 characters

email

string <email> | null

optional

<= 254 characters

website

string <uri> | null

optional

<= 512 characters

external_ref

string | null

read-onlyoptional

Third-party reference of the object, for informational purposes only

Example:

fb1033a2ed70

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": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "name": "string",
    "description": "string",
    "type": "string",
    "note": "string",
    "phone": "string",
    "fax": "string",
    "email": "user@example.com",
    "website": "http://example.com",
    "external_ref": "fb1033a2ed70",
    "created_at": "2024-04-11T10:22:15Z",
    "updated_at": "2024-04-11T10:22:15Z"
}

🟠412412

🟠422Unprocessable Content

🟠401Not Logged In