Migrations
Create a migration
Create a migration workspace for one customer — a workbook with one sheet per template. Requires API-key auth specifically. external_id makes creation idempotent: re-sending the same one (with the same source) returns the existing migration with a 200.
POST
/
migrations
Create a migration
curl --request POST \
--url https://app.vern.so/api/v1/migrations \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"name": "Acme Corp",
"source": "Salesforce",
"external_id": "acme-001",
"templates": [
"contacts"
]
}
'import requests
url = "https://app.vern.so/api/v1/migrations"
payload = {
"name": "Acme Corp",
"source": "Salesforce",
"external_id": "acme-001",
"templates": ["contacts"]
}
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: 'Acme Corp',
source: 'Salesforce',
external_id: 'acme-001',
templates: ['contacts']
})
};
fetch('https://app.vern.so/api/v1/migrations', 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://app.vern.so/api/v1/migrations",
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([
'name' => 'Acme Corp',
'source' => 'Salesforce',
'external_id' => 'acme-001',
'templates' => [
'contacts'
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-api-key: <api-key>"
],
]);
$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://app.vern.so/api/v1/migrations"
payload := strings.NewReader("{\n \"name\": \"Acme Corp\",\n \"source\": \"Salesforce\",\n \"external_id\": \"acme-001\",\n \"templates\": [\n \"contacts\"\n ]\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-api-key", "<api-key>")
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://app.vern.so/api/v1/migrations")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"Acme Corp\",\n \"source\": \"Salesforce\",\n \"external_id\": \"acme-001\",\n \"templates\": [\n \"contacts\"\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.vern.so/api/v1/migrations")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"Acme Corp\",\n \"source\": \"Salesforce\",\n \"external_id\": \"acme-001\",\n \"templates\": [\n \"contacts\"\n ]\n}"
response = http.request(request)
puts response.read_body{
"migration": {
"id": "c0a8012e-4f1b-4d3a-9b2c-7e6f5a4b3c2d",
"name": "Acme Corp",
"source": "Salesforce",
"status": "awaiting_files",
"templates": [
{
"slug": "contacts",
"name": "Contacts"
}
]
}
}{
"error": "<string>"
}{
"error": "<string>"
}{
"error": "<string>"
}{
"error": "<string>"
}{
"error": "Too many requests"
}Authorizations
Your Vern API key. Create one at Settings → API keys.
Body
application/json
Display name for the migration (e.g. the customer's org name).
The source name this migration comes from. Optional — omit for a sourceless migration.
Your own identifier for this customer. Alphanumeric, hyphens, underscores. Makes creation idempotent.
Maximum string length:
255Pattern:
^[a-zA-Z0-9_-]+$Template slugs to create sheets from. Omit to use every active template.
Response
The created migration (200 when an existing migration is returned via external_id idempotency).
Show child attributes
Show child attributes
Previous
Mint signed upload URLsRequest one signed upload URL per file, then PUT each file's bytes to its `signed_url`. Files are workbook-level — not mapped to templates.
Next
⌘I
Create a migration
curl --request POST \
--url https://app.vern.so/api/v1/migrations \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"name": "Acme Corp",
"source": "Salesforce",
"external_id": "acme-001",
"templates": [
"contacts"
]
}
'import requests
url = "https://app.vern.so/api/v1/migrations"
payload = {
"name": "Acme Corp",
"source": "Salesforce",
"external_id": "acme-001",
"templates": ["contacts"]
}
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: 'Acme Corp',
source: 'Salesforce',
external_id: 'acme-001',
templates: ['contacts']
})
};
fetch('https://app.vern.so/api/v1/migrations', 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://app.vern.so/api/v1/migrations",
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([
'name' => 'Acme Corp',
'source' => 'Salesforce',
'external_id' => 'acme-001',
'templates' => [
'contacts'
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-api-key: <api-key>"
],
]);
$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://app.vern.so/api/v1/migrations"
payload := strings.NewReader("{\n \"name\": \"Acme Corp\",\n \"source\": \"Salesforce\",\n \"external_id\": \"acme-001\",\n \"templates\": [\n \"contacts\"\n ]\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-api-key", "<api-key>")
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://app.vern.so/api/v1/migrations")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"Acme Corp\",\n \"source\": \"Salesforce\",\n \"external_id\": \"acme-001\",\n \"templates\": [\n \"contacts\"\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.vern.so/api/v1/migrations")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"Acme Corp\",\n \"source\": \"Salesforce\",\n \"external_id\": \"acme-001\",\n \"templates\": [\n \"contacts\"\n ]\n}"
response = http.request(request)
puts response.read_body{
"migration": {
"id": "c0a8012e-4f1b-4d3a-9b2c-7e6f5a4b3c2d",
"name": "Acme Corp",
"source": "Salesforce",
"status": "awaiting_files",
"templates": [
{
"slug": "contacts",
"name": "Contacts"
}
]
}
}{
"error": "<string>"
}{
"error": "<string>"
}{
"error": "<string>"
}{
"error": "<string>"
}{
"error": "Too many requests"
}