Skip to main content
POST
Register an app

Body

application/json
app_name
string
required
Maximum string length: 100
Example:

"My SaaS"

email
string<email>
required
Example:

"dev@mysaas.com"

redirect_uris
string<uri>[]
required
Example:
scopes
enum<string>[]
required

Scopes your app needs. Users approve them individually on the consent screen.

A single OAuth scope value.

Available options:
people:read,
people:write,
companies:read,
companies:write,
deals:read,
deals:write,
tasks:read,
tasks:write,
activities:read,
activities:write,
products:read,
products:write,
tags:read,
tags:write,
lists:read,
lists:write,
custom_fields:read,
custom_fields:write,
webhooks:manage
Example:
description
string
Maximum string length: 500
Example:

"Integration with Vendaze to sync contacts."

avatar_image
string

Public HTTPS URL or full base64 data URI of your app logo (e.g. data:image/png;base64,...). Accepted formats: JPEG, PNG, WebP, GIF, BMP, TIFF. Max 2MB.

Example:

"data:image/png;base64,iVBORw0KGgo..."

Response

App registered successfully.

data
object