Update App
sandbox-api.akoya.com/manage/{version}/recipients/{recipientId}/apps/{appId}
Update your application. The request format follows the JSON Patch specification (RFC 6902).
Only the add, replace, and remove (for lists only) operations are supported.
client_name cannot be updated. You cannot change an application's name after it's created.
Path Parameters
version*
stringManagement API major version (e.g. v2)
recipientId*
stringRecipient ID
appId*
stringThe ID of your application
Body Params
The request body will vary depending on what attributes of your application you're looking to update or replace. "op" (operation) accepted values: - "add" - "replace" - Use the "replace" operation when resetting your client secret. - "remove" "path" (app attribute) accepted values: - "/description" (app description) - "/redirect_uris/{number}" {number} is the redirect URI you want to alter (e.g. the first, the second). The redirect URI order is as shown in the Data Recipient Hub. Example: "/redirect_uris/1" refers to the second listed redirect URI. - "/client_secret" "value" (the value of the updated attribute) accepted values: - ""(Empty string - resetting client secret ONLY) - Free text for other operation > **Note** > > You can enter more than one operation in the same request.
op
string
path
string
value
string
Responses
200
OK
Response Body
client_id
string
client_name
string
owner
string
redirect_uris
array of strings
string
client_uri
string
contacts
array of strings
string
description
string
logo_uri
string
scope
array of strings
string
Headers
Content-Typestring
X-Akoya-Interaction-Idstring
400
Invalid Argument
Response Body
Headers
Content-Typestring
X-Akoya-Interaction-Idstring
Try it
Authorization
const options = {
"method": "PATCH",
"headers": {
"accept": "application/json"
},
"body": JSON.stringify([
{}
])
}};
fetch('sandbox-api.akoya.com/manage//recipients//apps/', options)
.then(response => response.json())
.catch(err => console.error(err));