Channel partners API reference

Every endpoint in Channel partners: 29 operations across 17 resources. Each one takes the same API key and returns the same error shapes as the rest of the API; see Authentication and Errors and limits.

Every path below is relative to https://app.jaicrm.ai. A key only reaches what it was granted when it was created, an endpoint you cannot use answers 403 rather than hiding.

Partners

GET`/api/partners`

List channel partners, filtered, sorted and paged

curl -X GET https://app.jaicrm.ai/api/partners 
  -H 'Authorization: Bearer YOUR_API_KEY'

GET`/api/partners/{id}`

Read one channel partner in full

Parameter	Type	Required	Notes
`id`	string	Required	The record’s id.

curl -X GET https://app.jaicrm.ai/api/partners/RECORD_ID 
  -H 'Authorization: Bearer YOUR_API_KEY'

POST`/api/partners`

Create a channel partner

Body

Field	Type	Required	Notes
`name`	string	Required	None
`firm`	string	Optional	None
`kind`	string	Optional	None
`phone`	string	Optional	None
`email`	one of several	Optional	None
`city`	string	Optional	None
`address`	string	Optional	None
`gstin`	string	Optional	None
`pan`	string	Optional	None
`ownerId`	string (uuid)	Optional	None
`vendorId`	string (uuid)	Optional	None
`attributionMonths`	integer	Optional	1 or more
`notes`	string	Optional	None
`tags`	array	Optional	None
`isActive`	boolean	Optional	None
`custom`	object	Optional	None

curl -X POST https://app.jaicrm.ai/api/partners 
  -H 'Authorization: Bearer YOUR_API_KEY' 
  -H 'Content-Type: application/json' 
  -d '{
    "name": "…",
    "firm": "…",
    "kind": "…",
    "phone": "…"
  }'

PATCH`/api/partners/{id}`

Change a channel partner

Parameter	Type	Required	Notes
`id`	string	Required	The record’s id.

Body

Field	Type	Required	Notes
`name`	string	Optional	None
`firm`	string	Optional	None
`kind`	string	Optional	None
`phone`	string	Optional	None
`email`	one of several	Optional	None
`city`	string	Optional	None
`address`	string	Optional	None
`gstin`	string	Optional	None
`pan`	string	Optional	None
`ownerId`	string (uuid)	Optional	None
`vendorId`	string (uuid)	Optional	None
`attributionMonths`	integer	Optional	1 or more
`notes`	string	Optional	None
`tags`	array	Optional	None
`isActive`	boolean	Optional	None
`custom`	object	Optional	None

curl -X PATCH https://app.jaicrm.ai/api/partners/RECORD_ID 
  -H 'Authorization: Bearer YOUR_API_KEY' 
  -H 'Content-Type: application/json' 
  -d '{
    "name": "…",
    "firm": "…",
    "kind": "…",
    "phone": "…"
  }'

DELETE`/api/partners/{id}`

Delete a channel partner

Parameter	Type	Required	Notes
`id`	string	Required	The record’s id.

curl -X DELETE https://app.jaicrm.ai/api/partners/RECORD_ID 
  -H 'Authorization: Bearer YOUR_API_KEY'

Comments

GET`/api/partners/{id}/comments`

List the comments for a channel partner

Parameter	Type	Required	Notes
`id`	string	Required	The record’s id.

curl -X GET https://app.jaicrm.ai/api/partners/RECORD_ID/comments 
  -H 'Authorization: Bearer YOUR_API_KEY'

POST`/api/partners/{id}/comments`

Add to the comments of a channel partner

Parameter	Type	Required	Notes
`id`	string	Required	The record’s id.

curl -X POST https://app.jaicrm.ai/api/partners/RECORD_ID/comments 
  -H 'Authorization: Bearer YOUR_API_KEY'

DELETE`/api/partners/{id}/comments/{commentId}`

Remove from the comments of a channel partner

Parameter	Type	Required	Notes
`id`	string	Required	The record’s id.
`commentId`	string	Required	The record’s id.

curl -X DELETE https://app.jaicrm.ai/api/partners/RECORD_ID/comments/RECORD_ID 
  -H 'Authorization: Bearer YOUR_API_KEY'

Bulk

POST`/api/partners/bulk`

Change several channel partners at once

curl -X POST https://app.jaicrm.ai/api/partners/bulk 
  -H 'Authorization: Bearer YOUR_API_KEY'

POST`/api/partners/bulk/assign`

Assign several channel partners to somebody at once

curl -X POST https://app.jaicrm.ai/api/partners/bulk/assign 
  -H 'Authorization: Bearer YOUR_API_KEY'

POST`/api/partners/bulk/delete`

Delete several channel partners at once

curl -X POST https://app.jaicrm.ai/api/partners/bulk/delete 
  -H 'Authorization: Bearer YOUR_API_KEY'

Notes

POST`/api/partners/{id}/notes`

Add a note to a channel partner

Parameter	Type	Required	Notes
`id`	string	Required	The record’s id.

curl -X POST https://app.jaicrm.ai/api/partners/RECORD_ID/notes 
  -H 'Authorization: Bearer YOUR_API_KEY'

PATCH`/api/partners/{id}/notes/{noteId}`

Change or remove a note on a channel partner

Parameter	Type	Required	Notes
`id`	string	Required	The record’s id.
`noteId`	string	Required	The record’s id.

curl -X PATCH https://app.jaicrm.ai/api/partners/RECORD_ID/notes/RECORD_ID 
  -H 'Authorization: Bearer YOUR_API_KEY'

DELETE`/api/partners/{id}/notes/{noteId}`

Change or remove a note on a channel partner

Parameter	Type	Required	Notes
`id`	string	Required	The record’s id.
`noteId`	string	Required	The record’s id.

curl -X DELETE https://app.jaicrm.ai/api/partners/RECORD_ID/notes/RECORD_ID 
  -H 'Authorization: Bearer YOUR_API_KEY'

Assignees

POST`/api/partners/{id}/assignees`

Put somebody on a channel partner

Parameter	Type	Required	Notes
`id`	string	Required	The record’s id.

curl -X POST https://app.jaicrm.ai/api/partners/RECORD_ID/assignees 
  -H 'Authorization: Bearer YOUR_API_KEY'

DELETE`/api/partners/{id}/assignees/{userId}`

Take somebody off a channel partner

Parameter	Type	Required	Notes
`id`	string	Required	The record’s id.
`userId`	string	Required	The record’s id.

curl -X DELETE https://app.jaicrm.ai/api/partners/RECORD_ID/assignees/RECORD_ID 
  -H 'Authorization: Bearer YOUR_API_KEY'

GET`/api/partners/{id}/related`

List the related for a channel partner

Parameter	Type	Required	Notes
`id`	string	Required	The record’s id.

curl -X GET https://app.jaicrm.ai/api/partners/RECORD_ID/related 
  -H 'Authorization: Bearer YOUR_API_KEY'

GET`/api/partners/{id}/related/{module}`

List the related for a channel partner

Parameter	Type	Required	Notes
`id`	string	Required	The record’s id.
`module`	string	Required	The record’s id.

curl -X GET https://app.jaicrm.ai/api/partners/RECORD_ID/related/RECORD_ID 
  -H 'Authorization: Bearer YOUR_API_KEY'

Figures

GET`/api/partners/{id}/figures`

List the figures for a channel partner

Parameter	Type	Required	Notes
`id`	string	Required	The record’s id.

curl -X GET https://app.jaicrm.ai/api/partners/RECORD_ID/figures 
  -H 'Authorization: Bearer YOUR_API_KEY'

Attribution

POST`/api/partners/attribution`

Add to the attribution of a channel partner

curl -X POST https://app.jaicrm.ai/api/partners/attribution 
  -H 'Authorization: Bearer YOUR_API_KEY'

Export.csv

GET`/api/partners/export.csv`

Download channel partners as a CSV file

curl -X GET https://app.jaicrm.ai/api/partners/export.csv 
  -H 'Authorization: Bearer YOUR_API_KEY'

Kanban

GET`/api/partners/kanban`

Read channel partners arranged as a board

curl -X GET https://app.jaicrm.ai/api/partners/kanban 
  -H 'Authorization: Bearer YOUR_API_KEY'

Pivot

GET`/api/partners/pivot`

Summarise channel partners as a pivot table

curl -X GET https://app.jaicrm.ai/api/partners/pivot 
  -H 'Authorization: Bearer YOUR_API_KEY'

Import

POST`/api/partners/import`

Import channel partners from a CSV file

curl -X POST https://app.jaicrm.ai/api/partners/import 
  -H 'Authorization: Bearer YOUR_API_KEY'

Similar

GET`/api/partners/{id}/similar`

Find channel partners that look like duplicates of this one

Parameter	Type	Required	Notes
`id`	string	Required	The record’s id.

curl -X GET https://app.jaicrm.ai/api/partners/RECORD_ID/similar 
  -H 'Authorization: Bearer YOUR_API_KEY'

Dependencies

GET`/api/partners/{id}/dependencies`

List what would break if a channel partner were deleted

Parameter	Type	Required	Notes
`id`	string	Required	The record’s id.

curl -X GET https://app.jaicrm.ai/api/partners/RECORD_ID/dependencies 
  -H 'Authorization: Bearer YOUR_API_KEY'

Timeline

GET`/api/partners/{id}/timeline`

Read everything that has happened to a channel partner

Parameter	Type	Required	Notes
`id`	string	Required	The record’s id.

curl -X GET https://app.jaicrm.ai/api/partners/RECORD_ID/timeline 
  -H 'Authorization: Bearer YOUR_API_KEY'

Email check

GET`/api/partners/{id}/email-check`

List the email check for a channel partner

Parameter	Type	Required	Notes
`id`	string	Required	The record’s id.

curl -X GET https://app.jaicrm.ai/api/partners/RECORD_ID/email-check 
  -H 'Authorization: Bearer YOUR_API_KEY'

Email

POST`/api/partners/{id}/email`

Send an email about a channel partner

Parameter	Type	Required	Notes
`id`	string	Required	The record’s id.

curl -X POST https://app.jaicrm.ai/api/partners/RECORD_ID/email 
  -H 'Authorization: Bearer YOUR_API_KEY'

Next in api Platform endpoints → Errors and rate limits →

Something missing or wrong here? Tell us. A question that needed asking usually means a page that needed writing.

Channel partners endpoints

Partners

GET/api/partners

GET/api/partners/{id}

POST/api/partners

PATCH/api/partners/{id}

DELETE/api/partners/{id}

Comments

GET/api/partners/{id}/comments

POST/api/partners/{id}/comments

DELETE/api/partners/{id}/comments/{commentId}

Bulk

POST/api/partners/bulk

POST/api/partners/bulk/assign

POST/api/partners/bulk/delete

Notes

POST/api/partners/{id}/notes

PATCH/api/partners/{id}/notes/{noteId}

DELETE/api/partners/{id}/notes/{noteId}