Update Single Relation

PUT

/relation/{relation_id}

Update a single Relation

Request

Authorization

API Key

Add parameter in header

x-api-key

Example:

x-api-key: ********************

API Key

Add parameter in header

x-api-env

Example:

x-api-env: ********************

Path Params

Body Params application/json

Example

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

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request PUT 'https://api.vplan.com/v1/relation/' \
--header 'Content-Type: application/json' \
--header 'x-api-key;' \
--header 'x-api-env;' \
--data-raw '{
    "name": "string",
    "description": "string",
    "type": "string",
    "note": "string",
    "phone": "string",
    "fax": "string",
    "email": "user@example.com",
    "website": "http://example.com",
    "external_ref": "fb1033a2ed70"
}'

Responses

🟢204No Content

This response does not have a body.

🟠412412

🟠422Unprocessable Content

🟠404Not Found

🟠401Not Logged In

Modified at 2025-07-22 14:20:42

Retrieve Single Relation

Remove Single Relation