Start a collaboration

POST

account-mapping

collaborations

curl --request POST \
  --url https://api.example.com/v3/account-mapping/collaborations \
  --header 'Content-Type: application/json-patch+json' \
  --data '
{
  "accountId": 123,
  "overlappingAccountId": 123,
  "context": "<string>",
  "assignedUserId": 123
}
'

import requests

url = "https://api.example.com/v3/account-mapping/collaborations"

payload = {
    "accountId": 123,
    "overlappingAccountId": 123,
    "context": "<string>",
    "assignedUserId": 123
}
headers = {"Content-Type": "application/json-patch+json"}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {'Content-Type': 'application/json-patch+json'},
  body: JSON.stringify({
    accountId: 123,
    overlappingAccountId: 123,
    context: '<string>',
    assignedUserId: 123
  })
};

fetch('https://api.example.com/v3/account-mapping/collaborations', 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.example.com/v3/account-mapping/collaborations",
  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([
    'accountId' => 123,
    'overlappingAccountId' => 123,
    'context' => '<string>',
    'assignedUserId' => 123
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json-patch+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.example.com/v3/account-mapping/collaborations"

	payload := strings.NewReader("{\n  \"accountId\": 123,\n  \"overlappingAccountId\": 123,\n  \"context\": \"<string>\",\n  \"assignedUserId\": 123\n}")

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

	req.Header.Add("Content-Type", "application/json-patch+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.example.com/v3/account-mapping/collaborations")
  .header("Content-Type", "application/json-patch+json")
  .body("{\n  \"accountId\": 123,\n  \"overlappingAccountId\": 123,\n  \"context\": \"<string>\",\n  \"assignedUserId\": 123\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.example.com/v3/account-mapping/collaborations")

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

request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json-patch+json'
request.body = "{\n  \"accountId\": 123,\n  \"overlappingAccountId\": 123,\n  \"context\": \"<string>\",\n  \"assignedUserId\": 123\n}"

response = http.request(request)
puts response.read_body

{
  "id": 128,
  "name": "Acme Corporation x Globex Partners",
  "status": "New",
  "partnerId": 7,
  "tenantAccountId": 1,
  "partnerAccountId": 42,
  "ownerUserId": 315,
  "assignedUserId": 964,
  "creationDate": "2026-04-22T10:06:00Z"
}

Body

accountId

integer<int32>

The ID of your account on the overlap.

overlappingAccountId

integer<int32>

The ID of the partner's account overlapping Resels.Backend.Api.Public.Model.AccountMappingCollaborations.v3.AccountMappingCollaborationStartRequestDto.AccountId.

context

string | null

The context shared with the partner, saved as a public note on the collaboration. Required.

assignedUserId

integer<int32> | null

The ID of the Kiflo user of the partner team member assigned to the collaboration. Optional.

Response

Collaboration started

integer<int32>

The ID of the collaboration.

name

string | null

The name of the collaboration, built from your account and the partner names.

status

enum<string>

Available options:

Unknown,

New,

Accepted,

Refused,

Abandoned,

Closed,

Converted

partnerId

integer<int32>

The ID of the partner the collaboration is started with.

tenantAccountId

integer<int32>

The ID of your account on the overlap the collaboration was started from.

partnerAccountId

integer<int32>

The ID of the partner's account on the overlap the collaboration was started from.

ownerUserId

integer<int32> | null

The ID of the user owning the collaboration on your side.

assignedUserId

integer<int32> | null

The ID of the Kiflo user of the partner team member assigned to the collaboration.

creationDate

string<date-time>

The date the collaboration was created, in UTC.

Start a collaboration

curl --request POST \
  --url https://api.example.com/v3/account-mapping/collaborations \
  --header 'Content-Type: application/json-patch+json' \
  --data '
{
  "accountId": 123,
  "overlappingAccountId": 123,
  "context": "<string>",
  "assignedUserId": 123
}
'

import requests

url = "https://api.example.com/v3/account-mapping/collaborations"

payload = {
    "accountId": 123,
    "overlappingAccountId": 123,
    "context": "<string>",
    "assignedUserId": 123
}
headers = {"Content-Type": "application/json-patch+json"}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {'Content-Type': 'application/json-patch+json'},
  body: JSON.stringify({
    accountId: 123,
    overlappingAccountId: 123,
    context: '<string>',
    assignedUserId: 123
  })
};

fetch('https://api.example.com/v3/account-mapping/collaborations', 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.example.com/v3/account-mapping/collaborations",
  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([
    'accountId' => 123,
    'overlappingAccountId' => 123,
    'context' => '<string>',
    'assignedUserId' => 123
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json-patch+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.example.com/v3/account-mapping/collaborations"

	payload := strings.NewReader("{\n  \"accountId\": 123,\n  \"overlappingAccountId\": 123,\n  \"context\": \"<string>\",\n  \"assignedUserId\": 123\n}")

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

	req.Header.Add("Content-Type", "application/json-patch+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.example.com/v3/account-mapping/collaborations")
  .header("Content-Type", "application/json-patch+json")
  .body("{\n  \"accountId\": 123,\n  \"overlappingAccountId\": 123,\n  \"context\": \"<string>\",\n  \"assignedUserId\": 123\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.example.com/v3/account-mapping/collaborations")

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

request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json-patch+json'
request.body = "{\n  \"accountId\": 123,\n  \"overlappingAccountId\": 123,\n  \"context\": \"<string>\",\n  \"assignedUserId\": 123\n}"

response = http.request(request)
puts response.read_body

{
  "id": 128,
  "name": "Acme Corporation x Globex Partners",
  "status": "New",
  "partnerId": 7,
  "tenantAccountId": 1,
  "partnerAccountId": 42,
  "ownerUserId": 315,
  "assignedUserId": 964,
  "creationDate": "2026-04-22T10:06:00Z"
}

API

JS SDK

API reference

Start a collaboration

Body

Response