- General
- Endpoints
Update Single Relation
PUT
/relation/{relation_id}
Relation
Request
Path Params
relation_id
string <uuid>
required
Header Params
x-api-key
string
required
Default:
{{api_key}}
x-api-env
string
required
Default:
{{api_env}}
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
Request samples
Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request PUT 'https://api.vplan.com/v1/relation/' \
--header 'x-api-key;' \
--header 'x-api-env;' \
--header 'Content-Type: application/json' \
--data-raw ''Responses
🟢204No Content
text/plain
Body
object {0}
🟠412412
🟠422Unprocessable Content
🟠404Not Found
🟠401Not Logged In
Modified at 2024-10-14 12:07:08