API ReferenceToolkits

Update a custom toolkitv3.1

PATCH
/api/v3.1/custom/toolkits/{slug}

Experimental: this endpoint may change. Updates a custom toolkit's name, logo, or API key field text. Omitted fields keep their current value. To change app_url, auth_schemes, or user_id, delete and re-create the toolkit. On a project with 2FA enabled, updating a private toolkit requires the user_id it is private to.

Authorization

x-api-key<token>

Project API key authentication

In: header

Path Parameters

slugstringRequired

Custom toolkit slug

Request Body

application/json

Fields to update. Include at least one of name, logo_file, or api_key_field.

namestring

Display name of the toolkit

logo_fileobject

Square PNG or JPEG logo, 256-1024px, max 3MB. Omit to keep the current logo.

api_key_fieldobject

Label and help text for the API key input on the connect page. API_KEY toolkits only.

user_idstring

The user the toolkit is private to. Required to update a private toolkit when the project has 2FA enabled; optional for a toolkit shared with all users. Ignored when 2FA is disabled.

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

import requestsurl = "https://example.com/api/v3.1/custom/toolkits/CUSTOM_NOTION_K7F2Q"body = """{}"""response = requests.request("PATCH", url, data = body, headers = {  "Content-Type": "application/json"})print(response.text)
{  "success": true}
Edit this page on GitHub