Start an onboarding for a partner.

POST

partners

{id}

onboard

curl --request POST \
  --url https://api.example.com/v3/partners/{id}/onboard \
  --header 'Content-Type: application/json-patch+json' \
  --data '
{
  "onboardingPipelineId": 123,
  "onboardingStageId": 123
}
'

import requests

url = "https://api.example.com/v3/partners/{id}/onboard"

payload = {
    "onboardingPipelineId": 123,
    "onboardingStageId": 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({onboardingPipelineId: 123, onboardingStageId: 123})
};

fetch('https://api.example.com/v3/partners/{id}/onboard', 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/partners/{id}/onboard",
  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([
    'onboardingPipelineId' => 123,
    'onboardingStageId' => 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/partners/{id}/onboard"

	payload := strings.NewReader("{\n  \"onboardingPipelineId\": 123,\n  \"onboardingStageId\": 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/partners/{id}/onboard")
  .header("Content-Type", "application/json-patch+json")
  .body("{\n  \"onboardingPipelineId\": 123,\n  \"onboardingStageId\": 123\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.example.com/v3/partners/{id}/onboard")

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  \"onboardingPipelineId\": 123,\n  \"onboardingStageId\": 123\n}"

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

{
  "id": 123,
  "name": "<string>",
  "groupId": 123,
  "onboardingStatus": "Unknown",
  "status": "Unknown",
  "source": "Unknown",
  "company": {
    "id": 123,
    "name": "<string>",
    "websiteUrls": [
      "<string>"
    ]
  },
  "mainContact": {
    "id": 123,
    "email": "<string>",
    "firstname": "<string>",
    "lastname": "<string>",
    "jobTitle": "<string>",
    "phoneNumber": "<string>",
    "linkedInProfileUrl": "<string>",
    "creationDate": "2023-11-07T05:31:56Z",
    "isMainContact": true
  },
  "onboardingStage": {
    "id": 123,
    "name": "<string>",
    "description": "<string>",
    "order": 123,
    "onboardingPipelineId": 123,
    "onboardingPipelineName": "<string>"
  },
  "onboardingStages": [
    {
      "id": 123,
      "name": "<string>",
      "description": "<string>",
      "order": 123,
      "onboardingPipelineId": 123,
      "onboardingPipelineName": "<string>"
    }
  ],
  "levels": [
    {
      "programLevelId": 123,
      "programLevelName": "<string>",
      "programId": 123,
      "programName": "<string>"
    }
  ],
  "sinceDate": "2023-11-07T05:31:56Z",
  "partnerTypeId": 123,
  "partnerTypeName": "<string>",
  "properties": {},
  "ownerUserId": 123,
  "owner": {
    "id": 123,
    "email": "<string>",
    "firstName": "<string>",
    "lastName": "<string>"
  },
  "referralCode": "<string>",
  "paypalEmail": "<string>",
  "currency": "<string>",
  "payoutProvider": {
    "type": "Unknown",
    "details": {}
  },
  "language": "<string>"
}

Path Parameters

integer<int32>

required

ID of the partner to onboard

Body

onboardingPipelineId

integer<int32>

The ID of the onboarding pipeline the partner must start.

onboardingStageId

integer<int32> | null

The optional ID of the onboarding stage in the specified pipeline. If empty the partner starts the onboarding in the first stage.

Response

Partner onboarded successfully

integer<int32>

name

string | null

groupId

integer<int32> | null

onboardingStatus

enum<string>

Available options:

Unknown,

NotOnboarded,

InProgress,

Completed

status

enum<string>

Available options:

Unknown,

Active,

Prospect,

Rejected,

Applicant,

Inactive,

Onboarding

source

enum<string>

Available options:

Unknown,

ManuallyAdded,

SignupForm

company

object

Show child attributes

mainContact

object

Show child attributes

onboardingStage

object

Show child attributes

onboardingStages

object[] | null

Show child attributes

levels

object[] | null

Show child attributes

sinceDate

string<date-time> | null

partnerTypeId

integer<int32> | null

partnerTypeName

string | null

properties

object | null

Show child attributes

ownerUserId

integer<int32> | null

owner

object

Show child attributes

referralCode

string | null

paypalEmail

string | null

currency

string | null

payoutProvider

object

Show child attributes

language

string | null

Start an onboarding for a partner.

curl --request POST \
  --url https://api.example.com/v3/partners/{id}/onboard \
  --header 'Content-Type: application/json-patch+json' \
  --data '
{
  "onboardingPipelineId": 123,
  "onboardingStageId": 123
}
'

import requests

url = "https://api.example.com/v3/partners/{id}/onboard"

payload = {
    "onboardingPipelineId": 123,
    "onboardingStageId": 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({onboardingPipelineId: 123, onboardingStageId: 123})
};

fetch('https://api.example.com/v3/partners/{id}/onboard', 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/partners/{id}/onboard",
  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([
    'onboardingPipelineId' => 123,
    'onboardingStageId' => 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/partners/{id}/onboard"

	payload := strings.NewReader("{\n  \"onboardingPipelineId\": 123,\n  \"onboardingStageId\": 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/partners/{id}/onboard")
  .header("Content-Type", "application/json-patch+json")
  .body("{\n  \"onboardingPipelineId\": 123,\n  \"onboardingStageId\": 123\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.example.com/v3/partners/{id}/onboard")

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  \"onboardingPipelineId\": 123,\n  \"onboardingStageId\": 123\n}"

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

{
  "id": 123,
  "name": "<string>",
  "groupId": 123,
  "onboardingStatus": "Unknown",
  "status": "Unknown",
  "source": "Unknown",
  "company": {
    "id": 123,
    "name": "<string>",
    "websiteUrls": [
      "<string>"
    ]
  },
  "mainContact": {
    "id": 123,
    "email": "<string>",
    "firstname": "<string>",
    "lastname": "<string>",
    "jobTitle": "<string>",
    "phoneNumber": "<string>",
    "linkedInProfileUrl": "<string>",
    "creationDate": "2023-11-07T05:31:56Z",
    "isMainContact": true
  },
  "onboardingStage": {
    "id": 123,
    "name": "<string>",
    "description": "<string>",
    "order": 123,
    "onboardingPipelineId": 123,
    "onboardingPipelineName": "<string>"
  },
  "onboardingStages": [
    {
      "id": 123,
      "name": "<string>",
      "description": "<string>",
      "order": 123,
      "onboardingPipelineId": 123,
      "onboardingPipelineName": "<string>"
    }
  ],
  "levels": [
    {
      "programLevelId": 123,
      "programLevelName": "<string>",
      "programId": 123,
      "programName": "<string>"
    }
  ],
  "sinceDate": "2023-11-07T05:31:56Z",
  "partnerTypeId": 123,
  "partnerTypeName": "<string>",
  "properties": {},
  "ownerUserId": 123,
  "owner": {
    "id": 123,
    "email": "<string>",
    "firstName": "<string>",
    "lastName": "<string>"
  },
  "referralCode": "<string>",
  "paypalEmail": "<string>",
  "currency": "<string>",
  "payoutProvider": {
    "type": "Unknown",
    "details": {}
  },
  "language": "<string>"
}

Account

Attachments

Certifications

ChannelConflicts

ContactProperties

Contacts

Customers

CustomersProperties

DealPipelines

DealProperties

Deals

EmailTemplates

Groups

LeadProperties

Leads

LineItems

Notes

Onboarding

PartnerApplications

PartnerContactCertifications

PartnerContacts

PartnerProperties

Partners

PayoutProperties

Payouts

ProductPrices

Products

Programs

RewardProperties

Rewards

Subscriptions

TransactionProperties

Transactions

Start an onboarding for a partner.

Path Parameters

Body

Response