Skip to main content
POST
/
v1
/
auth
/
register-app
Register an app
curl --request POST \
  --url https://api.vendaze.com/v1/auth/register-app \
  --header 'Content-Type: application/json' \
  --data '
{
  "app_name": "My SaaS",
  "email": "dev@mysaas.com",
  "redirect_uris": [
    "https://mysaas.com/callback/vendaze"
  ],
  "scopes": [
    "people:read",
    "deals:write"
  ],
  "description": "Integration with Vendaze to sync contacts.",
  "avatar_image": "data:image/png;base64,iVBORw0KGgo..."
}
'
import requests

url = "https://api.vendaze.com/v1/auth/register-app"

payload = {
"app_name": "My SaaS",
"email": "dev@mysaas.com",
"redirect_uris": ["https://mysaas.com/callback/vendaze"],
"scopes": ["people:read", "deals:write"],
"description": "Integration with Vendaze to sync contacts.",
"avatar_image": "data:image/png;base64,iVBORw0KGgo..."
}
headers = {"Content-Type": "application/json"}

response = requests.post(url, json=payload, headers=headers)

print(response.text)
const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({
app_name: 'My SaaS',
email: 'dev@mysaas.com',
redirect_uris: ['https://mysaas.com/callback/vendaze'],
scopes: ['people:read', 'deals:write'],
description: 'Integration with Vendaze to sync contacts.',
avatar_image: 'data:image/png;base64,iVBORw0KGgo...'
})
};

fetch('https://api.vendaze.com/v1/auth/register-app', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
CURLOPT_URL => "https://api.vendaze.com/v1/auth/register-app",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'app_name' => 'My SaaS',
'email' => 'dev@mysaas.com',
'redirect_uris' => [
'https://mysaas.com/callback/vendaze'
],
'scopes' => [
'people:read',
'deals:write'
],
'description' => 'Integration with Vendaze to sync contacts.',
'avatar_image' => 'data:image/png;base64,iVBORw0KGgo...'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json"
],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
package main

import (
"fmt"
"strings"
"net/http"
"io"
)

func main() {

url := "https://api.vendaze.com/v1/auth/register-app"

payload := strings.NewReader("{\n \"app_name\": \"My SaaS\",\n \"email\": \"dev@mysaas.com\",\n \"redirect_uris\": [\n \"https://mysaas.com/callback/vendaze\"\n ],\n \"scopes\": [\n \"people:read\",\n \"deals:write\"\n ],\n \"description\": \"Integration with Vendaze to sync contacts.\",\n \"avatar_image\": \"data:image/png;base64,iVBORw0KGgo...\"\n}")

req, _ := http.NewRequest("POST", url, payload)

req.Header.Add("Content-Type", "application/json")

res, _ := http.DefaultClient.Do(req)

defer res.Body.Close()
body, _ := io.ReadAll(res.Body)

fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.post("https://api.vendaze.com/v1/auth/register-app")
.header("Content-Type", "application/json")
.body("{\n \"app_name\": \"My SaaS\",\n \"email\": \"dev@mysaas.com\",\n \"redirect_uris\": [\n \"https://mysaas.com/callback/vendaze\"\n ],\n \"scopes\": [\n \"people:read\",\n \"deals:write\"\n ],\n \"description\": \"Integration with Vendaze to sync contacts.\",\n \"avatar_image\": \"data:image/png;base64,iVBORw0KGgo...\"\n}")
.asString();
require 'uri'
require 'net/http'

url = URI("https://api.vendaze.com/v1/auth/register-app")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"app_name\": \"My SaaS\",\n \"email\": \"dev@mysaas.com\",\n \"redirect_uris\": [\n \"https://mysaas.com/callback/vendaze\"\n ],\n \"scopes\": [\n \"people:read\",\n \"deals:write\"\n ],\n \"description\": \"Integration with Vendaze to sync contacts.\",\n \"avatar_image\": \"data:image/png;base64,iVBORw0KGgo...\"\n}"

response = http.request(request)
puts response.read_body
{
  "data": {
    "app_name": "My SaaS",
    "client_id": "9a8b7c6d-5e4f-3a2b-1c0d-9e8f7a6b5c4d",
    "avatar_url": "https://storage.vendaze.com/assets/integrations/mysaas.jpg",
    "message": "Credentials sent by email."
  }
}
{
"error": {
"code": "bad_request",
"message": "Request body must be valid JSON.",
"request_id": "550e8400-e29b-41d4-a716-446655440000"
}
}
{
"error": {
"code": "conflict",
"message": "An app is already registered with this email address.",
"request_id": "550e8400-e29b-41d4-a716-446655440000"
}
}
{
"error": {
"code": "validation_error",
"message": "Validation failed.",
"fields": {
"url": "url must use HTTPS.",
"events": "At least one event is required."
},
"request_id": "550e8400-e29b-41d4-a716-446655440000"
}
}
{
"error": {
"code": "rate_limit_exceeded",
"message": "Rate limit exceeded. Try again in 60 seconds.",
"request_id": "550e8400-e29b-41d4-a716-446655440000"
}
}
{
"error": {
"code": "internal_error",
"message": "An unexpected error occurred.",
"request_id": "550e8400-e29b-41d4-a716-446655440000"
}
}

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:
["https://mysaas.com/callback/vendaze"]
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:
["people:read", "deals:write"]
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