API docs by Redocly

PartnerPortal.io API

To use the PartnerPortal.io API, you will need a valid access token. To obtain this, please use the provided Client ID and Client Secret, going through the standard OAuth 2.0 flow.

/company/{companyId}/leads

Authorizations:
OAuth2
path Parameters
companyId
required
string
query Parameters
customFieldValue
string
email
string
limit
string
skip
string
customFieldId
string

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "context": {
    },
  • "status": 0
}

/company/{companyId}/leads

Authorizations:
OAuth2
path Parameters
companyId
required
string
Request Body schema: application/json
lastName
required
string
null or string
null or string
object or null
null or string
null or string
platform
required
string
string or null
firstName
required
string
null or string
null or string
null or number
null or string

Responses

Request samples

Content type
application/json
{
  • "lastName": "string",
  • "agentId": { },
  • "notes": { },
  • "customFields": { },
  • "companyName": { },
  • "partnerOrganizationId": { },
  • "platform": "string",
  • "closeDate": "2019-08-24T14:15:22Z",
  • "firstName": "string",
  • "phone": { },
  • "websiteUrl": { },
  • "value": { },
  • "email": { }
}

Response samples

Content type
application/json
{
  • "data": {
    },
  • "context": {
    },
  • "status": 0
}

/company/{companyId}/leads/{leadId}/comments

Authorizations:
OAuth2
path Parameters
leadId
required
string
companyId
required
string
Request Body schema: application/json
message
required
string

Responses

Request samples

Content type
application/json
{
  • "message": "string"
}

Response samples

Content type
application/json
{
  • "data": {
    },
  • "context": {
    },
  • "status": 0
}

/company/{companyId}/leads/{leadId}

Authorizations:
OAuth2
path Parameters
leadId
required
string
companyId
required
string

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "context": {
    },
  • "status": 0
}

/company/{companyId}/leads/{leadId}

Authorizations:
OAuth2
path Parameters
leadId
required
string
companyId
required
string
Request Body schema: application/json
lastName
string
null or string
null or string
object or null
null or string
null or string
null or string
platform
string
string or null
firstName
string
null or string
null or string
null or number
null or string

Responses

Request samples

Content type
application/json
{
  • "lastName": "string",
  • "agentId": { },
  • "notes": { },
  • "customFields": { },
  • "companyName": { },
  • "phaseId": { },
  • "partnerOrganizationId": { },
  • "platform": "string",
  • "closeDate": "2019-08-24T14:15:22Z",
  • "firstName": "string",
  • "phone": { },
  • "websiteUrl": { },
  • "value": { },
  • "email": { }
}

Response samples

Content type
application/json
{
  • "data": {
    },
  • "context": {
    },
  • "status": 0
}

/company/{companyId}/bulk/{type}

Authorizations:
OAuth2
path Parameters
type
required
string
companyId
required
string

/company/{companyId}/account/{accountId}/roles

Authorizations:
OAuth2
path Parameters
accountId
required
string
companyId
required
string

/company/{companyId}/account/{accountId}/roles

Authorizations:
OAuth2
path Parameters
accountId
required
string
companyId
required
string

/company/{companyId}/partners

Authorizations:
OAuth2
path Parameters
companyId
required
string
query Parameters
domain
string
email
string

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "context": {
    },
  • "status": 0
}

/company/{companyId}/partners

Authorizations:
OAuth2
path Parameters
companyId
required
string
Request Body schema: application/json
firstName
required
string
lastName
required
string
phone
required
string
companyName
required
string
domain
required
string
paypalEmail
string
email
required
string

Responses

Request samples

Content type
application/json
{
  • "firstName": "string",
  • "lastName": "string",
  • "phone": "string",
  • "companyName": "string",
  • "domain": "string",
  • "paypalEmail": "string",
  • "email": "string"
}

Response samples

Content type
application/json
{
  • "data": {
    },
  • "context": {
    },
  • "status": 0
}

/company/{companyId}/partner/{partnerOrganizationId}/schema/{object}

Authorizations:
OAuth2
path Parameters
partnerOrganizationId
required
string
object
required
string
companyId
required
string

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "context": {
    },
  • "status": 0
}

/bulk-create-jobs/{bulkCreateJobId}

Authorizations:
OAuth2
path Parameters
bulkCreateJobId
required
string

/company/{companyId}/partners/{partnerOrganizationId}

Authorizations:
OAuth2
path Parameters
partnerOrganizationId
required
string
companyId
required
string

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "context": {
    },
  • "status": 0
}

/company/{companyId}/schema/{object}

Authorizations:
OAuth2
path Parameters
object
required
string
companyId
required
string

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "context": {
    },
  • "status": 0
}