Update Link by Id
PATCH/links/:id
Use this endpoint to update a link by Id.
Request
Path Parameters
id stringrequired
- application/json
Body
isActive boolean
isDefault boolean
priority1 number
Responses
- 200
- 400
- 404
Update Link by Id 202
Response Headers
Connection
string
Content-Length
string
Date
string
Keep-Alive
string
Return-Format
string
- application/json
- Schema
- Example (from schema)
- Update Link by Id 202
Schema
data
object
isActive boolean
isDefault boolean
priority number
messages string[]
total number
{
"data": {
"isActive": true,
"isDefault": true,
"priority": 1
},
"messages": [
"Link updated"
],
"total": 1
}
{
"data": {
"isActive": true,
"isDefault": true,
"priority": 1
},
"messages": [
"Link updated"
],
"total": 1
}
Update Link by Id - 400 (invalid schema)
Response Headers
Connection
string
Content-Length
string
Date
string
Return-Format
string
- application/json
- Schema
- Example (from schema)
- Update Link by Id - 400 (invalid schema)
Schema
error
object
code number
messages string[]
moreInfo string
status number
type string
{
"error": {
"code": 10007,
"messages": [
"#: extraneous key [priority1] is not permitted"
],
"moreInfo": "https://www.propel.us/docs/errors/10007",
"status": 400,
"type": "SchemaValidationException"
}
}
{
"error": {
"code": 10007,
"messages": [
"#: extraneous key [priority1] is not permitted"
],
"moreInfo": "https://www.propel.us/docs/errors/10007",
"status": 400,
"type": "SchemaValidationException"
}
}
Update Link by Id - 404
Response Headers
Connection
string
Content-Length
string
Date
string
Keep-Alive
string
Return-Format
string
- application/json
- Schema
- Example (from schema)
- Update Link by Id - 404
Schema
error
object
code number
messages string[]
moreInfo string
status number
type string
{
"error": {
"code": 18003,
"messages": [
"Link with id [731085] not found"
],
"moreInfo": "https://www.propel.us/docs/errors/18003",
"status": 404,
"type": "LinkNotFound"
}
}
{
"error": {
"code": 18003,
"messages": [
"Link with id [731085] not found"
],
"moreInfo": "https://www.propel.us/docs/errors/18003",
"status": 404,
"type": "LinkNotFound"
}
}
Loading...