logo

Partner Management

APIs related to managing partner organisations and users

List Partner Organisations

Retrieve a list of all partner organisations with optional pagination

SecuritybearerAuth
Request
query Parameters
limit
integer

Maximum number of items to return

Responses
200

OK

401

Unauthorized

get/partner-organisations
Request samples 
Response samples 
application/json
{
  • "items": [
    ],
  • "queryMore": "string"
}
Create Partner Organisation
Create a new partner organisation


SecuritybearerAuth 
Request 
Request Body schema: application/json
required
name
required
string
Organisation name


 
zuoraAccountId
required
string
Associated Zuora account ID


 
isZuoraInvoiceOwner
required
boolean
Whether this organisation owns Zuora invoices


 
salesforceAccountId
string
Associated Salesforce account ID


 
logo
string <uri> 
Organisation logo URL


 
Responses 
200
Created


401
Unauthorized


post/partner-organisation
Request samples 
application/json
{
  • "name": "string",
  • "zuoraAccountId": "string",
  • "isZuoraInvoiceOwner": true,
  • "salesforceAccountId": "string",
  • "logo": "http://example.com"
}
Response samples 
application/json
{
  • "id": "string",
  • "name": "string",
  • "data": {
    },
  • "record_type": "partner_org",
  • "service": "limio",
  • "created": "2019-08-24T14:15:22Z",
  • "modified": "2019-08-24T14:15:22Z"
}
Create Partner User
Create a new user for a specific partner organisation


SecuritybearerAuth 
Request 
path Parameters
partnerOrganisationId
required
string
Partner organisation ID


 
Request Body schema: application/json
required
email
required
string <email> 
User email address


 
Responses 
200
Created


401
Unauthorized


post/partner-organisation/{partnerOrganisationId}
Request samples 
application/json
{
  • "email": "user@example.com"
}
Response samples 
application/json
{
  • "id": "string",
  • "name": "string",
  • "data": {
    },
  • "partner_org": "string",
  • "record_type": "partner_user",
  • "service": "limio",
  • "created": "2019-08-24T14:15:22Z",
  • "modified": "2019-08-24T14:15:22Z"
}
Update Partner Organisation
Update an existing partner organisation's details


SecuritybearerAuth 
Request 
path Parameters
partnerOrganisationId
required
string
Partner organisation ID


 
Request Body schema: application/json
required
zuoraAccountId
string
Associated Zuora account ID


 
isZuoraInvoiceOwner
boolean
Whether this organisation owns Zuora invoices


 
salesforceAccountId
string
Associated Salesforce account ID


 
logo
string <uri> 
Organisation logo URL


 
Responses 
200
Updated


401
Unauthorized


put/partner-organisation/{partnerOrganisationId}
Request samples 
application/json
{
  • "zuoraAccountId": "string",
  • "isZuoraInvoiceOwner": true,
  • "salesforceAccountId": "string",
  • "logo": "http://example.com"
}
Response samples 
application/json
{
  • "id": "string",
  • "name": "string",
  • "data": {
    },
  • "record_type": "partner_org",
  • "service": "limio",
  • "created": "2019-08-24T14:15:22Z",
  • "modified": "2019-08-24T14:15:22Z"
}
Delete Partner Organisation
Delete a partner organisation and all associated users


SecuritybearerAuth 
Request 
path Parameters
partnerOrganisationId
required
string
Partner organisation ID


 
Responses 
200
Deleted


401
Unauthorized


delete/partner-organisation/{partnerOrganisationId}
Request samples 
Response samples 
application/json
{
  • "success": true
}
List Partner Users for Organisation
Retrieve all users associated with a specific partner organisation


SecuritybearerAuth 
Request 
path Parameters
partnerOrganisationId
required
string
Partner organisation ID


 
Responses 
200
OK


401
Unauthorized


get/partner-organisation/{partnerOrganisationId}/users
Request samples 
Response samples 
application/json
{
  • "items": [
    ],
  • "queryMore": "string"
}
Delete Partner User
Delete a specific user from a partner organisation


SecuritybearerAuth 
Request 
path Parameters
partnerOrganisationId
required
string
Partner organisation ID


 
partnerUserId
required
string
Partner user ID


 
Responses 
200
Deleted


401
Unauthorized


delete/partner-organisation/{partnerOrganisationId}/{partnerUserId}
Request samples 
Response samples 
application/json
{
  • "success": true
}
➔ Next to Get Objects For Partner