Skip to main content
PATCH
Update partner

Path Parameters

id
integer<int32>
required

The ID of the partner to update.

Body

id
integer<int32>
name
string | null
status
enum<string>
Available options:
Unknown,
Active,
Prospect,
Rejected,
Applicant,
Inactive,
Onboarding
onboardingStageId
integer<int32> | null
onboardingStageIds
integer<int32>[] | null
programLevelIds
integer<int32>[] | null
properties
object | null
currency
string | null
groupId
integer<int32> | null
ownerUserId
integer<int32> | null
sinceDate
string<date-time> | null
referralCode
string | null
payoutProvider
object
paypalEmail
string | null

Deprecated. Use PayoutProvider and PayoutProvider

language
string | null
prospectionStage
string | null

Response

Partner updated

id
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
mainContact
object
onboardingStage
object
onboardingStages
object[] | null
levels
object[] | null
sinceDate
string<date-time> | null
partnerTypeId
integer<int32> | null
partnerTypeName
string | null
properties
object | null
ownerUserId
integer<int32> | null
owner
object
referralCode
string | null
paypalEmail
string | null
currency
string | null
payoutProvider
object
language
string | null