Update Pin
This api is deprecated. Please use custom dashboard api instead.
Request
URI
PUT
https://{api_host}/api/ni/pinboards/{id}/pins/{pin-id}
COPY
Path Parameters
string
id
Required
The Entity ID of object requestion information on
string
pin-id
Required
The ID of pin requesting information on
Request Body
Pin details to be updated
UpdatePinRequest
of type(s)
application/json
Required
{
"pin_name": "Pin Name"
}
string
pin_name
Optional
Name of the pin
Responses
200
OK
Returns
PinResponse
of type(s)
application/json
"PinResponse Object"
string
id
Optional
Model key for the pin
string
custom_dashboard_id
Optional
Model key of the custom dashboard of which the pin is part of
string
name
Optional
Name of the pin
string
created_timestamp
Optional
Create timestamp of the pin
string
last_updated_timestamp
Optional
Last update timestamop of the pin
string
query
Optional
Query behind the pin
string
pinned_timestamp
Optional
Timestamp when the pin was pinned
string
owner
Optional
Owner of the pin
400
Bad Request
Returns
ApiError
of type(s)
application/json
"ApiError Object"
integer As int32
As int32
code
Optional
code
string
message
Optional
message
array of
object
details
Optional
details
401
Unauthorized
Returns
ApiError
of type(s)
application/json
"ApiError Object"
integer As int32
As int32
code
Optional
code
string
message
Optional
message
array of
object
details
Optional
details
403
Forbidden
Returns
ApiError
of type(s)
application/json
"ApiError Object"
integer As int32
As int32
code
Optional
code
string
message
Optional
message
array of
object
details
Optional
details
404
Not Found
Returns
ApiError
of type(s)
application/json
"ApiError Object"
integer As int32
As int32
code
Optional
code
string
message
Optional
message
array of
object
details
Optional
details
500
Internal Error
Returns
ApiError
of type(s)
application/json
"ApiError Object"
integer As int32
As int32
code
Optional
code
string
message
Optional
message
array of
object
details
Optional
details
Code Samples
COPY
curl -X PUT -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '{}' https://{api_host}/api/ni/pinboards/{id}/pins/{pin-id}
Deprecated
On This Page
Pinboards Operations
GET
Get All Pinboards
Deprecated
POST
Create Pinboard
Deprecated
GET
Get Pinboard
Deprecated
PUT
Edit Pinboard
Deprecated
DELETE
Delete Pinboard
Deprecated
POST
Create Pin
Deprecated
PUT
Update Pin
Deprecated
DELETE
Delete Pin
Deprecated
POST
Duplicate Pinboard
Deprecated
POST
Set Pinboard As Homepage
Deprecated
PUT
Share Pinboard
Deprecated
PUT
Remove Share Pinboard
Deprecated