Notion

Register a destination database

Either creates a new Synci-managed database under a page shared with Synci (mode=create) or attaches an existing database the user selected (mode=attach). Any properties Synci needs that are missing from an attached database are added; existing properties are never changed.

POST

/destinations/notion/connections/{connectionId}/databases

curl --request POST \
  --url https://api.synci.io/api/v1/destinations/notion/connections/{connectionId}/databases \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "mode": "create"
}
'

<string>

Authorizations

Authorizationstringheaderrequired

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

connectionIdintegerrequired

The Notion connection ID

Body

data_source_idstring | null

The Notion data source (database table) to attach. Required when mode is "attach".

Pattern: ^[0-9a-fA-F]{32}$|^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$

Example: 59833787-2cf9-4fdf-8782-e53db20768a5

header_configenum<string>[] | null

Optional ordered list of transaction field keys to write as database properties. Omit to use the default set.

modeenum<string>required

Use "create" to have Synci create a new database under a page you shared with Synci, or "attach" to register an existing database.

Available options: create, attach

namestring | null

Optional display name for the database in Synci. Defaults to the database's title in Notion.

Maximum string length: 255

parent_page_idstring | null

The Notion page to create the database under. Required when mode is "create" unless the connection was set up from the Synci template.

Pattern: ^[0-9a-fA-F]{32}$|^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$

Example: 59833787-2cf9-4fdf-8782-e53db20768a5

titlestring | null

Title for the new database. Only used when mode is "create".

Maximum string length: 255

Response

bodystring

Still need help? Ask the team