{"info":{"_postman_id":"8a0bdeaf-2ce6-45c3-a6c3-a385bef2d90a","name":"Kiflo API (DEV)","description":"

The Kiflo API allows you to have control over your integration and create the best experiences.

\n
\n

Format

\n

The API follows the REST standard using JSON to format requests and responses.
Decimals are formatted using invariant culture, ie: using \".\" (dot) as a decimal sperator and no thousands separator.
Dates are formatted using ISO standards, in UTC format, including the timezone. Ex: 2015-03-25T12:00:00Z

\n
\n

Security

\n

The API is secured using an API token.

\n

How to generate an API Access Token

\n
    \n
  1. Open your account settings page
    2. \n
  2. Go to the \"API Access Token\" section
    3. \n
  3. Click \"Add\" button
    4. \n
  4. Choose a name that will be used to identify the token and click \"Add\"
    5. \n
  5. Copy the generate token
    6. \n
\n
\n

Note: For security reason, the generated API Access Token won't be visible after you close the settings page. Be sure to copy the generated token otherwise you won't be able to get it later.

\n
\n

How to authenticate on the API

\n

To authenticate on the API, send the generated token in the Authorization header using the Bearer scheme:
Authorization: Bearer #YOUR_GENERATED_TOKEN_HERE#

\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"7495150","collectionId":"8a0bdeaf-2ce6-45c3-a6c3-a385bef2d90a","publishedId":"2sBY4VJcKo","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"},"publishDate":"2026-08-05T14:39:30.000Z"},"item":[{"name":"Vendor API","item":[{"name":"Endpoints","item":[{"name":"Account","item":[{"name":"Get account information","id":"99472bc0-d1de-4cdc-a23a-0811aabc0012","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"//v3/account","urlObject":{"path":["v3","account"],"host":["/"],"query":[],"variable":[]}},"response":[{"id":"babd2e8f-b878-487a-a31c-2d47829832a8","name":"Account information","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"//v3/account"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"accountId\": \"\",\n \"appId\": \"\",\n \"companyName\": \"\"\n}"}],"_postman_id":"99472bc0-d1de-4cdc-a23a-0811aabc0012"}],"id":"b882f50d-0b90-4209-b699-fda149b94b89","_postman_id":"b882f50d-0b90-4209-b699-fda149b94b89","description":""},{"name":"AccountMappingAccounts","item":[{"name":"List accounts","id":"0f6ba8bc-2a44-4d1a-aef6-3463efe17ec3","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"//v3/account-mapping/accounts?offset=&limit=&sort_by=&order_by=&type=Customer&data_source_id=&external_id=&has_prospect_overlaps=&has_customer_overlaps=&has_opportunity_overlaps=","urlObject":{"path":["v3","account-mapping","accounts"],"host":["/"],"query":[{"description":{"content":"

The cursor used in pagination. This is the index of the first account to be returned.

\n","type":"text/plain"},"key":"offset","value":""},{"description":{"content":"

The maximum number of accounts to be returned. The default is 20.

\n","type":"text/plain"},"key":"limit","value":""},{"description":{"content":"

The property used to sort the accounts by. The default is Name.

\n","type":"text/plain"},"key":"sort_by","value":""},{"description":{"content":"

The sorting direction for the returned accounts. Accepted values: ASC, DESC. The default is ASC.

\n","type":"text/plain"},"key":"order_by","value":""},{"description":{"content":"

Filters accounts on their type. (This can only be one of Unknown,Prospect,Opportunity,Customer)

\n","type":"text/plain"},"key":"type","value":"Customer"},{"description":{"content":"

Filters accounts on the data source they were imported from.

\n","type":"text/plain"},"key":"data_source_id","value":""},{"description":{"content":"

Filters accounts on their external ID.

\n","type":"text/plain"},"key":"external_id","value":""},{"description":{"content":"

Filters accounts on whether they overlap with at least one prospect account.\nWhen true, returns only accounts that overlap with a prospect account; when false, returns only accounts\nthat do not. When omitted, no filter is applied.

\n","type":"text/plain"},"key":"has_prospect_overlaps","value":""},{"description":{"content":"

Filters accounts on whether they overlap with at least one customer account.\nWhen true, returns only accounts that overlap with a customer account; when false, returns only accounts\nthat do not. When omitted, no filter is applied.

\n","type":"text/plain"},"key":"has_customer_overlaps","value":""},{"description":{"content":"

Filters accounts on whether they overlap with at least one opportunity account.\nWhen true, returns only accounts that overlap with an opportunity account; when false, returns only accounts\nthat do not. When omitted, no filter is applied.

\n","type":"text/plain"},"key":"has_opportunity_overlaps","value":""}],"variable":[]}},"response":[{"id":"c438fc0f-0933-4a11-9213-696f39696224","name":"Accounts returned","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"//v3/account-mapping/accounts?offset=&limit=&sort_by=&order_by=&type=Customer&data_source_id=&external_id=&has_prospect_overlaps=&has_customer_overlaps=&has_opportunity_overlaps=","host":["/"],"path":["v3","account-mapping","accounts"],"query":[{"description":"The cursor used in pagination. This is the index of the first account to be returned.","key":"offset","value":""},{"description":"The maximum number of accounts to be returned. The default is 20.","key":"limit","value":""},{"description":"The property used to sort the accounts by. The default is Name.","key":"sort_by","value":""},{"description":"The sorting direction for the returned accounts. Accepted values: ASC, DESC. The default is ASC.","key":"order_by","value":""},{"description":"Filters accounts on their type. (This can only be one of Unknown,Prospect,Opportunity,Customer)","key":"type","value":"Customer"},{"description":"Filters accounts on the data source they were imported from.","key":"data_source_id","value":""},{"description":"Filters accounts on their external ID.","key":"external_id","value":""},{"description":"Filters accounts on whether they overlap with at least one prospect account.\r\nWhen true, returns only accounts that overlap with a prospect account; when false, returns only accounts\r\nthat do not. When omitted, no filter is applied.","key":"has_prospect_overlaps","value":""},{"description":"Filters accounts on whether they overlap with at least one customer account.\r\nWhen true, returns only accounts that overlap with a customer account; when false, returns only accounts\r\nthat do not. When omitted, no filter is applied.","key":"has_customer_overlaps","value":""},{"description":"Filters accounts on whether they overlap with at least one opportunity account.\r\nWhen true, returns only accounts that overlap with an opportunity account; when false, returns only accounts\r\nthat do not. When omitted, no filter is applied.","key":"has_opportunity_overlaps","value":""}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"items\": [\n {\n \"id\": \"\",\n \"externalId\": \"\",\n \"name\": \"\",\n \"type\": \"Prospect\",\n \"country\": \"\",\n \"websiteUrl\": \"\",\n \"ownerName\": \"\",\n \"ownerEmail\": \"\",\n \"dataSourceId\": \"\",\n \"dataSourceName\": \"\",\n \"dataSourceType\": \"HubSpot\",\n \"importedDate\": \"\",\n \"prospectOverlapsCount\": \"\",\n \"opportunityOverlapsCount\": \"\",\n \"customerOverlapsCount\": \"\"\n },\n {\n \"id\": \"\",\n \"externalId\": \"\",\n \"name\": \"\",\n \"type\": \"Prospect\",\n \"country\": \"\",\n \"websiteUrl\": \"\",\n \"ownerName\": \"\",\n \"ownerEmail\": \"\",\n \"dataSourceId\": \"\",\n \"dataSourceName\": \"\",\n \"dataSourceType\": \"HubSpot\",\n \"importedDate\": \"\",\n \"prospectOverlapsCount\": \"\",\n \"opportunityOverlapsCount\": \"\",\n \"customerOverlapsCount\": \"\"\n }\n ],\n \"paginationSkipCount\": \"\",\n \"totalCount\": \"\"\n}"},{"id":"9e258427-f1bf-4bb6-b1c4-f5f5e7a014e0","name":"Invalid request","originalRequest":{"method":"GET","header":[],"url":{"raw":"//v3/account-mapping/accounts?offset=&limit=&sort_by=&order_by=&type=Customer&data_source_id=&external_id=&has_prospect_overlaps=&has_customer_overlaps=&has_opportunity_overlaps=","host":["/"],"path":["v3","account-mapping","accounts"],"query":[{"description":"The cursor used in pagination. This is the index of the first account to be returned.","key":"offset","value":""},{"description":"The maximum number of accounts to be returned. The default is 20.","key":"limit","value":""},{"description":"The property used to sort the accounts by. The default is Name.","key":"sort_by","value":""},{"description":"The sorting direction for the returned accounts. Accepted values: ASC, DESC. The default is ASC.","key":"order_by","value":""},{"description":"Filters accounts on their type. (This can only be one of Unknown,Prospect,Opportunity,Customer)","key":"type","value":"Customer"},{"description":"Filters accounts on the data source they were imported from.","key":"data_source_id","value":""},{"description":"Filters accounts on their external ID.","key":"external_id","value":""},{"description":"Filters accounts on whether they overlap with at least one prospect account.\r\nWhen true, returns only accounts that overlap with a prospect account; when false, returns only accounts\r\nthat do not. When omitted, no filter is applied.","key":"has_prospect_overlaps","value":""},{"description":"Filters accounts on whether they overlap with at least one customer account.\r\nWhen true, returns only accounts that overlap with a customer account; when false, returns only accounts\r\nthat do not. When omitted, no filter is applied.","key":"has_customer_overlaps","value":""},{"description":"Filters accounts on whether they overlap with at least one opportunity account.\r\nWhen true, returns only accounts that overlap with an opportunity account; when false, returns only accounts\r\nthat do not. When omitted, no filter is applied.","key":"has_opportunity_overlaps","value":""}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":null},{"id":"1dccb81e-e7cd-45f5-aa0e-a836b8fc7a0e","name":"Account mapping feature is not available","originalRequest":{"method":"GET","header":[],"url":{"raw":"//v3/account-mapping/accounts?offset=&limit=&sort_by=&order_by=&type=Customer&data_source_id=&external_id=&has_prospect_overlaps=&has_customer_overlaps=&has_opportunity_overlaps=","host":["/"],"path":["v3","account-mapping","accounts"],"query":[{"description":"The cursor used in pagination. This is the index of the first account to be returned.","key":"offset","value":""},{"description":"The maximum number of accounts to be returned. The default is 20.","key":"limit","value":""},{"description":"The property used to sort the accounts by. The default is Name.","key":"sort_by","value":""},{"description":"The sorting direction for the returned accounts. Accepted values: ASC, DESC. The default is ASC.","key":"order_by","value":""},{"description":"Filters accounts on their type. (This can only be one of Unknown,Prospect,Opportunity,Customer)","key":"type","value":"Customer"},{"description":"Filters accounts on the data source they were imported from.","key":"data_source_id","value":""},{"description":"Filters accounts on their external ID.","key":"external_id","value":""},{"description":"Filters accounts on whether they overlap with at least one prospect account.\r\nWhen true, returns only accounts that overlap with a prospect account; when false, returns only accounts\r\nthat do not. When omitted, no filter is applied.","key":"has_prospect_overlaps","value":""},{"description":"Filters accounts on whether they overlap with at least one customer account.\r\nWhen true, returns only accounts that overlap with a customer account; when false, returns only accounts\r\nthat do not. When omitted, no filter is applied.","key":"has_customer_overlaps","value":""},{"description":"Filters accounts on whether they overlap with at least one opportunity account.\r\nWhen true, returns only accounts that overlap with an opportunity account; when false, returns only accounts\r\nthat do not. When omitted, no filter is applied.","key":"has_opportunity_overlaps","value":""}]}},"status":"Forbidden","code":403,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":null}],"_postman_id":"0f6ba8bc-2a44-4d1a-aef6-3463efe17ec3"}],"id":"daf73bfa-27b7-4d4a-b606-436c6b9b11bb","_postman_id":"daf73bfa-27b7-4d4a-b606-436c6b9b11bb","description":""},{"name":"AccountMappingDataSources","item":[{"name":"List data sources","id":"8d04c8dd-9a97-4ca7-b135-439fe2f68330","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"//v3/account-mapping/data-sources?offset=&limit=&sort_by=&order_by=&type=Csv&status=Disabled","urlObject":{"path":["v3","account-mapping","data-sources"],"host":["/"],"query":[{"description":{"content":"

The cursor used in pagination. This is the index of the first data source to be returned.

\n","type":"text/plain"},"key":"offset","value":""},{"description":{"content":"

The maximum number of data sources to be returned. The default is 20.

\n","type":"text/plain"},"key":"limit","value":""},{"description":{"content":"

The property used to sort the data sources by. The default is CreationDate.

\n","type":"text/plain"},"key":"sort_by","value":""},{"description":{"content":"

The sorting direction for the returned data sources. Accepted values: ASC, DESC. The default is DESC.

\n","type":"text/plain"},"key":"order_by","value":""},{"description":{"content":"

Filters data sources on their type. (This can only be one of Unknown,Csv,HubSpot)

\n","type":"text/plain"},"key":"type","value":"Csv"},{"description":{"content":"

Filters data sources on their status. (This can only be one of Unknown,Processing,Enabled,Disabled,Error)

\n","type":"text/plain"},"key":"status","value":"Disabled"}],"variable":[]}},"response":[{"id":"717e2d0e-edbe-4499-953c-f8698c1eb9d1","name":"Data sources returned","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"//v3/account-mapping/data-sources?offset=&limit=&sort_by=&order_by=&type=Csv&status=Disabled","host":["/"],"path":["v3","account-mapping","data-sources"],"query":[{"description":"The cursor used in pagination. This is the index of the first data source to be returned.","key":"offset","value":""},{"description":"The maximum number of data sources to be returned. The default is 20.","key":"limit","value":""},{"description":"The property used to sort the data sources by. The default is CreationDate.","key":"sort_by","value":""},{"description":"The sorting direction for the returned data sources. Accepted values: ASC, DESC. The default is DESC.","key":"order_by","value":""},{"description":"Filters data sources on their type. (This can only be one of Unknown,Csv,HubSpot)","key":"type","value":"Csv"},{"description":"Filters data sources on their status. (This can only be one of Unknown,Processing,Enabled,Disabled,Error)","key":"status","value":"Disabled"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"items\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"type\": \"Csv\",\n \"status\": \"Disabled\",\n \"creationDate\": \"\",\n \"lastImportedDate\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"type\": \"Unknown\",\n \"status\": \"Enabled\",\n \"creationDate\": \"\",\n \"lastImportedDate\": \"\"\n }\n ],\n \"paginationSkipCount\": \"\",\n \"totalCount\": \"\"\n}"},{"id":"11ed4fdd-8c44-4063-910d-13afaf64e712","name":"Invalid request","originalRequest":{"method":"GET","header":[],"url":{"raw":"//v3/account-mapping/data-sources?offset=&limit=&sort_by=&order_by=&type=Csv&status=Disabled","host":["/"],"path":["v3","account-mapping","data-sources"],"query":[{"description":"The cursor used in pagination. This is the index of the first data source to be returned.","key":"offset","value":""},{"description":"The maximum number of data sources to be returned. The default is 20.","key":"limit","value":""},{"description":"The property used to sort the data sources by. The default is CreationDate.","key":"sort_by","value":""},{"description":"The sorting direction for the returned data sources. Accepted values: ASC, DESC. The default is DESC.","key":"order_by","value":""},{"description":"Filters data sources on their type. (This can only be one of Unknown,Csv,HubSpot)","key":"type","value":"Csv"},{"description":"Filters data sources on their status. (This can only be one of Unknown,Processing,Enabled,Disabled,Error)","key":"status","value":"Disabled"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":null},{"id":"b47481e5-c253-4673-955a-2bf624bbeaf3","name":"Account mapping feature is not available","originalRequest":{"method":"GET","header":[],"url":{"raw":"//v3/account-mapping/data-sources?offset=&limit=&sort_by=&order_by=&type=Csv&status=Disabled","host":["/"],"path":["v3","account-mapping","data-sources"],"query":[{"description":"The cursor used in pagination. This is the index of the first data source to be returned.","key":"offset","value":""},{"description":"The maximum number of data sources to be returned. The default is 20.","key":"limit","value":""},{"description":"The property used to sort the data sources by. The default is CreationDate.","key":"sort_by","value":""},{"description":"The sorting direction for the returned data sources. Accepted values: ASC, DESC. The default is DESC.","key":"order_by","value":""},{"description":"Filters data sources on their type. (This can only be one of Unknown,Csv,HubSpot)","key":"type","value":"Csv"},{"description":"Filters data sources on their status. (This can only be one of Unknown,Processing,Enabled,Disabled,Error)","key":"status","value":"Disabled"}]}},"status":"Forbidden","code":403,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":null}],"_postman_id":"8d04c8dd-9a97-4ca7-b135-439fe2f68330"}],"id":"03c30c25-73cf-4d26-b46b-a93b9f4688a6","_postman_id":"03c30c25-73cf-4d26-b46b-a93b9f4688a6","description":""},{"name":"AccountMappingOverlaps","item":[{"name":"List overlaps","id":"c776e372-9a8f-4741-9ed5-eca09716290e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"//v3/account-mapping/overlaps?offset=&limit=&sort_by=&order_by=&partner_id=&account_id=&account_external_id=&account_external_ids=&account_external_ids=&data_source_id=","description":"

List the account mapping overlaps between your accounts and your partners' accounts.

\n","urlObject":{"path":["v3","account-mapping","overlaps"],"host":["/"],"query":[{"description":{"content":"

The cursor used in pagination. This is the index of the first overlap to be returned.

\n","type":"text/plain"},"key":"offset","value":""},{"description":{"content":"

The maximum number of overlaps to be returned. The default is 20.

\n","type":"text/plain"},"key":"limit","value":""},{"description":{"content":"

The property used to sort the overlaps by. The default is CreationDate.

\n","type":"text/plain"},"key":"sort_by","value":""},{"description":{"content":"

The sorting direction for the returned overlaps. Accepted values: ASC, DESC. The default is DESC.

\n","type":"text/plain"},"key":"order_by","value":""},{"description":{"content":"

Filters overlaps on the partner that owns the overlapping partner account.

\n","type":"text/plain"},"key":"partner_id","value":""},{"description":{"content":"

Filters overlaps on the ID of your account involved in the overlap.

\n","type":"text/plain"},"key":"account_id","value":""},{"description":{"content":"

Filters overlaps on the external ID of your account involved in the overlap.

\n","type":"text/plain"},"key":"account_external_id","value":""},{"description":{"content":"

Filters overlaps on any of the external IDs of your accounts involved in the overlap (OR semantics).

\n","type":"text/plain"},"key":"account_external_ids","value":""},{"description":{"content":"

Filters overlaps on any of the external IDs of your accounts involved in the overlap (OR semantics).

\n","type":"text/plain"},"key":"account_external_ids","value":""},{"description":{"content":"

Filters overlaps on the data source your account was imported from.

\n","type":"text/plain"},"key":"data_source_id","value":""}],"variable":[]}},"response":[{"id":"3a8bc7e0-8536-4c58-ad0e-4ee16bb261cb","name":"Overlaps returned","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"//v3/account-mapping/overlaps?offset=&limit=&sort_by=&order_by=&partner_id=&account_id=&account_external_id=&account_external_ids=&data_source_id=","host":["/"],"path":["v3","account-mapping","overlaps"],"query":[{"description":"The cursor used in pagination. This is the index of the first overlap to be returned.","key":"offset","value":""},{"description":"The maximum number of overlaps to be returned. The default is 20.","key":"limit","value":""},{"description":"The property used to sort the overlaps by. The default is CreationDate.","key":"sort_by","value":""},{"description":"The sorting direction for the returned overlaps. Accepted values: ASC, DESC. The default is DESC.","key":"order_by","value":""},{"description":"Filters overlaps on the partner that owns the overlapping partner account.","key":"partner_id","value":""},{"description":"Filters overlaps on the ID of your account involved in the overlap.","key":"account_id","value":""},{"description":"Filters overlaps on the external ID of your account involved in the overlap.","key":"account_external_id","value":""},{"description":"Filters overlaps on any of the external IDs of your accounts involved in the overlap (OR semantics).","key":"account_external_ids","value":""},{"description":"Filters overlaps on the data source your account was imported from.","key":"data_source_id","value":""}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"items\": [\n {\n \"id\": \"\",\n \"creationDate\": \"\",\n \"tenantAccount\": {\n \"id\": \"\",\n \"externalId\": \"\",\n \"name\": \"\",\n \"type\": \"Customer\",\n \"ownerName\": \"\",\n \"ownerEmail\": \"\",\n \"country\": \"\",\n \"websiteUrl\": \"\"\n },\n \"partnerAccount\": {\n \"id\": \"\",\n \"externalId\": \"\",\n \"name\": \"\",\n \"type\": \"Unknown\",\n \"ownerName\": \"\",\n \"ownerEmail\": \"\",\n \"country\": \"\",\n \"websiteUrl\": \"\"\n },\n \"partnerId\": \"\",\n \"partnerName\": \"\"\n },\n {\n \"id\": \"\",\n \"creationDate\": \"\",\n \"tenantAccount\": {\n \"id\": \"\",\n \"externalId\": \"\",\n \"name\": \"\",\n \"type\": \"Customer\",\n \"ownerName\": \"\",\n \"ownerEmail\": \"\",\n \"country\": \"\",\n \"websiteUrl\": \"\"\n },\n \"partnerAccount\": {\n \"id\": \"\",\n \"externalId\": \"\",\n \"name\": \"\",\n \"type\": \"Prospect\",\n \"ownerName\": \"\",\n \"ownerEmail\": \"\",\n \"country\": \"\",\n \"websiteUrl\": \"\"\n },\n \"partnerId\": \"\",\n \"partnerName\": \"\"\n }\n ],\n \"paginationSkipCount\": \"\",\n \"totalCount\": \"\"\n}"},{"id":"048febfa-361d-4512-ab8d-e5a452050e4e","name":"Invalid request","originalRequest":{"method":"GET","header":[],"url":{"raw":"//v3/account-mapping/overlaps?offset=&limit=&sort_by=&order_by=&partner_id=&account_id=&account_external_id=&account_external_ids=&data_source_id=","host":["/"],"path":["v3","account-mapping","overlaps"],"query":[{"description":"The cursor used in pagination. This is the index of the first overlap to be returned.","key":"offset","value":""},{"description":"The maximum number of overlaps to be returned. The default is 20.","key":"limit","value":""},{"description":"The property used to sort the overlaps by. The default is CreationDate.","key":"sort_by","value":""},{"description":"The sorting direction for the returned overlaps. Accepted values: ASC, DESC. The default is DESC.","key":"order_by","value":""},{"description":"Filters overlaps on the partner that owns the overlapping partner account.","key":"partner_id","value":""},{"description":"Filters overlaps on the ID of your account involved in the overlap.","key":"account_id","value":""},{"description":"Filters overlaps on the external ID of your account involved in the overlap.","key":"account_external_id","value":""},{"description":"Filters overlaps on any of the external IDs of your accounts involved in the overlap (OR semantics).","key":"account_external_ids","value":""},{"description":"Filters overlaps on the data source your account was imported from.","key":"data_source_id","value":""}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":null},{"id":"4d9a1192-f39f-4b63-9769-3cf869848692","name":"Account mapping feature is not available","originalRequest":{"method":"GET","header":[],"url":{"raw":"//v3/account-mapping/overlaps?offset=&limit=&sort_by=&order_by=&partner_id=&account_id=&account_external_id=&account_external_ids=&data_source_id=","host":["/"],"path":["v3","account-mapping","overlaps"],"query":[{"description":"The cursor used in pagination. This is the index of the first overlap to be returned.","key":"offset","value":""},{"description":"The maximum number of overlaps to be returned. The default is 20.","key":"limit","value":""},{"description":"The property used to sort the overlaps by. The default is CreationDate.","key":"sort_by","value":""},{"description":"The sorting direction for the returned overlaps. Accepted values: ASC, DESC. The default is DESC.","key":"order_by","value":""},{"description":"Filters overlaps on the partner that owns the overlapping partner account.","key":"partner_id","value":""},{"description":"Filters overlaps on the ID of your account involved in the overlap.","key":"account_id","value":""},{"description":"Filters overlaps on the external ID of your account involved in the overlap.","key":"account_external_id","value":""},{"description":"Filters overlaps on any of the external IDs of your accounts involved in the overlap (OR semantics).","key":"account_external_ids","value":""},{"description":"Filters overlaps on the data source your account was imported from.","key":"data_source_id","value":""}]}},"status":"Forbidden","code":403,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":null}],"_postman_id":"c776e372-9a8f-4741-9ed5-eca09716290e"}],"id":"688f0457-b35c-4ac3-a0b8-a2af2fd5d5fe","_postman_id":"688f0457-b35c-4ac3-a0b8-a2af2fd5d5fe","description":""},{"name":"Attachments","item":[{"name":"Upload attachment from file","id":"5959f5f7-2812-4045-bfd7-71b343f5646d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"multipart/form-data"},{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"key":"file","type":"file","value":null},{"key":"fileName","value":"","type":"text"},{"key":"partnerId","value":"","type":"text"},{"key":"dealId","value":"","type":"text"},{"key":"leadId","value":"","type":"text"},{"key":"noteId","value":"","type":"text"},{"key":"payoutId","value":"","type":"text"},{"key":"customerId","value":"","type":"text"},{"key":"collaborationId","value":"","type":"text"}]},"url":"//v3/attachments/upload","description":"

Upload and create one attachment linked to a partner, deal, lead, note, payout, customer, or collaboration.

\n","urlObject":{"path":["v3","attachments","upload"],"host":["/"],"query":[],"variable":[]}},"response":[{"id":"c4a99a52-5e66-4e4c-bdf5-09de59771068","name":"Attachments created","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"multipart/form-data"},{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"key":"file","type":"file"},{"key":"fileName","value":"","type":"text"},{"key":"partnerId","value":"","type":"text"},{"key":"dealId","value":"","type":"text"},{"key":"leadId","value":"","type":"text"},{"key":"noteId","value":"","type":"text"},{"key":"payoutId","value":"","type":"text"},{"key":"customerId","value":"","type":"text"},{"key":"collaborationId","value":"","type":"text"}]},"url":"//v3/attachments/upload"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"\",\n \"name\": \"\",\n \"fileExtension\": \"\",\n \"size\": \"\",\n \"downloadUrl\": \"\",\n \"partnerId\": \"\",\n \"dealId\": \"\",\n \"leadId\": \"\",\n \"noteId\": \"\",\n \"payoutId\": \"\",\n \"customerId\": \"\",\n \"collaborationId\": \"\",\n \"creationDate\": \"\",\n \"createdByUserName\": \"\"\n}"},{"id":"2f97e22c-7194-486a-b5f3-c0991594a860","name":"Invalid request","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"multipart/form-data"}],"body":{"mode":"formdata","formdata":[{"key":"file","type":"file"},{"key":"fileName","value":"","type":"text"},{"key":"partnerId","value":"","type":"text"},{"key":"dealId","value":"","type":"text"},{"key":"leadId","value":"","type":"text"},{"key":"noteId","value":"","type":"text"},{"key":"payoutId","value":"","type":"text"},{"key":"customerId","value":"","type":"text"},{"key":"collaborationId","value":"","type":"text"}]},"url":"//v3/attachments/upload"},"status":"Bad Request","code":400,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":null}],"_postman_id":"5959f5f7-2812-4045-bfd7-71b343f5646d"},{"name":"Upload attachment from URL","id":"7c7a8477-8dcb-41d5-9bb1-019a2950f01b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"url\": \"\",\n \"fileName\": \"\",\n \"partnerId\": \"\",\n \"dealId\": \"\",\n \"leadId\": \"\",\n \"noteId\": \"\",\n \"payoutId\": \"\",\n \"customerId\": \"\",\n \"collaborationId\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"//v3/attachments/upload-from-url","description":"

Download a file from a given URL and create an attachment linked to a partner, deal, lead, note, payout, customer, or collaboration.

\n","urlObject":{"path":["v3","attachments","upload-from-url"],"host":["/"],"query":[],"variable":[]}},"response":[{"id":"101c148d-fe77-49b8-bd60-f08235d3053e","name":"Attachment created","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"url\": \"\",\n \"fileName\": \"\",\n \"partnerId\": \"\",\n \"dealId\": \"\",\n \"leadId\": \"\",\n \"noteId\": \"\",\n \"payoutId\": \"\",\n \"customerId\": \"\",\n \"collaborationId\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"//v3/attachments/upload-from-url"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"\",\n \"name\": \"\",\n \"fileExtension\": \"\",\n \"size\": \"\",\n \"downloadUrl\": \"\",\n \"partnerId\": \"\",\n \"dealId\": \"\",\n \"leadId\": \"\",\n \"noteId\": \"\",\n \"payoutId\": \"\",\n \"customerId\": \"\",\n \"collaborationId\": \"\",\n \"creationDate\": \"\",\n \"createdByUserName\": \"\"\n}"},{"id":"fdd93e27-3de8-4778-933f-c39abc18f31b","name":"Invalid request","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"url\": \"\",\n \"fileName\": \"\",\n \"partnerId\": \"\",\n \"dealId\": \"\",\n \"leadId\": \"\",\n \"noteId\": \"\",\n \"payoutId\": \"\",\n \"customerId\": \"\",\n \"collaborationId\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"//v3/attachments/upload-from-url"},"status":"Bad Request","code":400,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":null}],"_postman_id":"7c7a8477-8dcb-41d5-9bb1-019a2950f01b"},{"name":"Get attachments","id":"5f7f5730-d5ed-48d3-a878-66049af09e71","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"//v3/attachments?partner_id=&deal_id=&lead_id=¬e_id=&payout_id=&customer_id=&collaboration_id=&offset=&limit=&sort_by=&order_by=","description":"

Get all attachments, filtered by entity.

\n","urlObject":{"path":["v3","attachments"],"host":["/"],"query":[{"description":{"content":"

A partner ID to filter the attachments on.

\n","type":"text/plain"},"key":"partner_id","value":""},{"description":{"content":"

A deal ID to filter the attachments on.

\n","type":"text/plain"},"key":"deal_id","value":""},{"description":{"content":"

A lead ID to filter the attachments on.

\n","type":"text/plain"},"key":"lead_id","value":""},{"description":{"content":"

A note ID to filter the attachments on.

\n","type":"text/plain"},"key":"note_id","value":""},{"description":{"content":"

A payout ID to filter the attachments on.

\n","type":"text/plain"},"key":"payout_id","value":""},{"description":{"content":"

A customer ID to filter the attachments on.

\n","type":"text/plain"},"key":"customer_id","value":""},{"description":{"content":"

A collaboration ID to filter the attachments on.

\n","type":"text/plain"},"key":"collaboration_id","value":""},{"description":{"content":"

The cursor used in pagination. This is the index of the first attachment to be returned.

\n","type":"text/plain"},"key":"offset","value":""},{"description":{"content":"

The maximum number of attachments to be returned. The default is 20.

\n","type":"text/plain"},"key":"limit","value":""},{"description":{"content":"

The property used to sort the attachments by. The default is CreationDate.

\n","type":"text/plain"},"key":"sort_by","value":""},{"description":{"content":"

The sorting direction for the returned attachments. Accepted values: ASC, DESC. The default is DESC.

\n","type":"text/plain"},"key":"order_by","value":""}],"variable":[]}},"response":[{"id":"6d02930e-8fd2-46b8-98c0-253a11b2a08f","name":"Attachments returned","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"//v3/attachments?partner_id=&deal_id=&lead_id=¬e_id=&payout_id=&customer_id=&collaboration_id=&offset=&limit=&sort_by=&order_by=","host":["/"],"path":["v3","attachments"],"query":[{"description":"A partner ID to filter the attachments on.","key":"partner_id","value":""},{"description":"A deal ID to filter the attachments on.","key":"deal_id","value":""},{"description":"A lead ID to filter the attachments on.","key":"lead_id","value":""},{"description":"A note ID to filter the attachments on.","key":"note_id","value":""},{"description":"A payout ID to filter the attachments on.","key":"payout_id","value":""},{"description":"A customer ID to filter the attachments on.","key":"customer_id","value":""},{"description":"A collaboration ID to filter the attachments on.","key":"collaboration_id","value":""},{"description":"The cursor used in pagination. This is the index of the first attachment to be returned.","key":"offset","value":""},{"description":"The maximum number of attachments to be returned. The default is 20.","key":"limit","value":""},{"description":"The property used to sort the attachments by. The default is CreationDate.","key":"sort_by","value":""},{"description":"The sorting direction for the returned attachments. Accepted values: ASC, DESC. The default is DESC.","key":"order_by","value":""}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"items\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"fileExtension\": \"\",\n \"size\": \"\",\n \"downloadUrl\": \"\",\n \"partnerId\": \"\",\n \"dealId\": \"\",\n \"leadId\": \"\",\n \"noteId\": \"\",\n \"payoutId\": \"\",\n \"customerId\": \"\",\n \"collaborationId\": \"\",\n \"creationDate\": \"\",\n \"createdByUserName\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"fileExtension\": \"\",\n \"size\": \"\",\n \"downloadUrl\": \"\",\n \"partnerId\": \"\",\n \"dealId\": \"\",\n \"leadId\": \"\",\n \"noteId\": \"\",\n \"payoutId\": \"\",\n \"customerId\": \"\",\n \"collaborationId\": \"\",\n \"creationDate\": \"\",\n \"createdByUserName\": \"\"\n }\n ],\n \"paginationSkipCount\": \"\",\n \"totalCount\": \"\"\n}"}],"_postman_id":"5f7f5730-d5ed-48d3-a878-66049af09e71"},{"name":"Get attachment","id":"f64e11cf-9d98-4c79-b5a0-422703d92ec1","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"//v3/attachments/:id","description":"

Get a single attachment by its ID, including a temporary download URL.

\n","urlObject":{"path":["v3","attachments",":id"],"host":["/"],"query":[],"variable":[{"id":"79939ba5-0619-47af-8818-549c946c261f","description":{"content":"

(Required)

\n","type":"text/plain"},"type":"any","value":"","key":"id"}]}},"response":[{"id":"b4040e2f-bf81-4714-9b79-30ff13ef39ef","name":"Attachment returned","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"//v3/attachments/:id","host":["/"],"path":["v3","attachments",":id"],"variable":[{"key":"id","value":"","description":"(Required) "}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"\",\n \"name\": \"\",\n \"fileExtension\": \"\",\n \"size\": \"\",\n \"downloadUrl\": \"\",\n \"partnerId\": \"\",\n \"dealId\": \"\",\n \"leadId\": \"\",\n \"noteId\": \"\",\n \"payoutId\": \"\",\n \"customerId\": \"\",\n \"collaborationId\": \"\",\n \"creationDate\": \"\",\n \"createdByUserName\": \"\"\n}"},{"id":"e2c37536-9b69-4281-a06d-11ee5032856c","name":"Attachment not found","originalRequest":{"method":"GET","header":[],"url":{"raw":"//v3/attachments/:id","host":["/"],"path":["v3","attachments",":id"],"variable":[{"key":"id","value":"","description":"(Required) "}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":null}],"_postman_id":"f64e11cf-9d98-4c79-b5a0-422703d92ec1"}],"id":"5366bc67-17b8-4221-8025-be125616ac4a","_postman_id":"5366bc67-17b8-4221-8025-be125616ac4a","description":""},{"name":"Certifications","item":[{"name":"Get partner certifications","id":"d16a28b2-7b86-442a-89e6-0d401ddab196","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"//v3/certifications?name=&offset=&limit=&sort_by=&order_by=","description":"

Get all certifications defined in your account

\n","urlObject":{"path":["v3","certifications"],"host":["/"],"query":[{"description":{"content":"

The certification name to filter on.

\n","type":"text/plain"},"key":"name","value":""},{"description":{"content":"

The cursor used in pagination. This is the index of the first certification to be returned.

\n","type":"text/plain"},"key":"offset","value":""},{"description":{"content":"

The maximum number of certifications to be returned. The default is 20.

\n","type":"text/plain"},"key":"limit","value":""},{"description":{"content":"

The property used to sort the certifications by. The default is Name.

\n","type":"text/plain"},"key":"sort_by","value":""},{"description":{"content":"

The sorting direction for the returned certifications. Accepted values: ASC, DESC. The default is DESC.

\n","type":"text/plain"},"key":"order_by","value":""}],"variable":[]}},"response":[{"id":"5a57253d-6d5c-4947-a674-08e930f08083","name":"Certifications returned","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"//v3/certifications?name=&offset=&limit=&sort_by=&order_by=","host":["/"],"path":["v3","certifications"],"query":[{"description":"The certification name to filter on.","key":"name","value":""},{"description":"The cursor used in pagination. This is the index of the first certification to be returned.","key":"offset","value":""},{"description":"The maximum number of certifications to be returned. The default is 20.","key":"limit","value":""},{"description":"The property used to sort the certifications by. The default is Name.","key":"sort_by","value":""},{"description":"The sorting direction for the returned certifications. Accepted values: ASC, DESC. The default is DESC.","key":"order_by","value":""}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\"\n }\n]"},{"id":"c553cd50-e663-47f3-a671-42adb39ba997","name":"You do not have access to this functionality in your current plan","originalRequest":{"method":"GET","header":[],"url":{"raw":"//v3/certifications?name=&offset=&limit=&sort_by=&order_by=","host":["/"],"path":["v3","certifications"],"query":[{"description":"The certification name to filter on.","key":"name","value":""},{"description":"The cursor used in pagination. This is the index of the first certification to be returned.","key":"offset","value":""},{"description":"The maximum number of certifications to be returned. The default is 20.","key":"limit","value":""},{"description":"The property used to sort the certifications by. The default is Name.","key":"sort_by","value":""},{"description":"The sorting direction for the returned certifications. Accepted values: ASC, DESC. The default is DESC.","key":"order_by","value":""}]}},"status":"Forbidden","code":403,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":null}],"_postman_id":"d16a28b2-7b86-442a-89e6-0d401ddab196"}],"id":"86c144f8-2b72-4cc2-9e6c-053becab26de","_postman_id":"86c144f8-2b72-4cc2-9e6c-053becab26de","description":""},{"name":"ChannelConflicts","item":[{"name":"Create Channel Conflict","id":"9ccbdd60-a145-496e-b0a8-bd60bfd8417d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"leadId\": \"\",\n \"dealId\": \"\",\n \"sourceName\": \"\",\n \"name\": \"\",\n \"sourceUrl\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"//v3/channel-conflicts","urlObject":{"path":["v3","channel-conflicts"],"host":["/"],"query":[],"variable":[]}},"response":[{"id":"0c3aa3cc-258e-4a52-9b8f-0d9b65c2da82","name":"Channel Conflict","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"leadId\": \"\",\n \"dealId\": \"\",\n \"sourceName\": \"\",\n \"name\": \"\",\n \"sourceUrl\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"//v3/channel-conflicts"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"\",\n \"leadId\": \"\",\n \"dealId\": \"\",\n \"sourceName\": \"\",\n \"name\": \"\",\n \"sourceUrl\": \"\"\n}"},{"id":"f8473984-b117-4d84-8bd9-e6e06e80cdc9","name":"You do not have access to this functionality in your current plan","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"leadId\": \"\",\n \"dealId\": \"\",\n \"sourceName\": \"\",\n \"name\": \"\",\n \"sourceUrl\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"//v3/channel-conflicts"},"status":"Forbidden","code":403,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":null}],"_postman_id":"9ccbdd60-a145-496e-b0a8-bd60bfd8417d"}],"id":"4cd3e029-c6e1-4029-a6b0-3b807bd3b1b4","_postman_id":"4cd3e029-c6e1-4029-a6b0-3b807bd3b1b4","description":""},{"name":"ContactProperties","item":[{"name":"List contact properties","id":"3d44f4b0-6146-4265-84c0-a3afb0c06762","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"//v3/contacts/properties","description":"

List all custom properties defined on contact object.
You can customize the contact properties from your account's settings page.

\n","urlObject":{"path":["v3","contacts","properties"],"host":["/"],"query":[],"variable":[]}},"response":[{"id":"4198094a-0265-4053-a648-5447ddb74053","name":"Success","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"//v3/contacts/properties"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"id\": \"\",\n \"entityType\": \"PartnerDirectory\",\n \"propertyType\": \"Currency\",\n \"name\": \"\",\n \"label\": \"\",\n \"placeholder\": \"\",\n \"description\": \"\",\n \"isRequired\": \"\",\n \"isVisible\": \"\",\n \"isPartnerEditable\": \"\",\n \"isCustom\": \"\",\n \"isReadOnly\": \"\",\n \"displayOrder\": \"\",\n \"isDealAmountPart\": \"\",\n \"canEditDescription\": \"\",\n \"canEditIsRequired\": \"\",\n \"dropdownConfiguration\": {\n \"options\": [\n {\n \"label\": \"\",\n \"originalValue\": \"\",\n \"value\": \"\"\n },\n {\n \"label\": \"\",\n \"originalValue\": \"\",\n \"value\": \"\"\n }\n ]\n }\n },\n {\n \"id\": \"\",\n \"entityType\": \"View\",\n \"propertyType\": \"Number\",\n \"name\": \"\",\n \"label\": \"\",\n \"placeholder\": \"\",\n \"description\": \"\",\n \"isRequired\": \"\",\n \"isVisible\": \"\",\n \"isPartnerEditable\": \"\",\n \"isCustom\": \"\",\n \"isReadOnly\": \"\",\n \"displayOrder\": \"\",\n \"isDealAmountPart\": \"\",\n \"canEditDescription\": \"\",\n \"canEditIsRequired\": \"\",\n \"dropdownConfiguration\": {\n \"options\": [\n {\n \"label\": \"\",\n \"originalValue\": \"\",\n \"value\": \"\"\n },\n {\n \"label\": \"\",\n \"originalValue\": \"\",\n \"value\": \"\"\n }\n ]\n }\n }\n]"}],"_postman_id":"3d44f4b0-6146-4265-84c0-a3afb0c06762"}],"id":"8b7a3d97-5399-4a11-a74a-33d3855dacda","_postman_id":"8b7a3d97-5399-4a11-a74a-33d3855dacda","description":""},{"name":"Contacts","item":[{"name":"Create contact","id":"2f4c1952-e081-414a-a186-27d09c9d475e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"properties\": {\n \"key_0\": \"\"\n },\n \"source\": \"System\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"//v3/contacts","description":"

Create a new contact.

\n

Contacts must be associated with deals in order to be visible.

\n","urlObject":{"path":["v3","contacts"],"host":["/"],"query":[],"variable":[]}},"response":[{"id":"071485d9-b481-494d-a0b6-697a2639d14d","name":"Contact created","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"properties\": {\n \"key_0\": \"\"\n },\n \"source\": \"System\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"//v3/contacts"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"externalContactId\": \"\",\n \"email\": \"\",\n \"contactId\": \"\"\n}"},{"id":"4d6aeb36-3ff9-46cb-97e8-3fb5985385d1","name":"Invalid request","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"properties\": {\n \"key_0\": \"\"\n },\n \"source\": \"System\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"//v3/contacts"},"status":"Bad Request","code":400,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":null}],"_postman_id":"2f4c1952-e081-414a-a186-27d09c9d475e"},{"name":"List contacts","id":"6bd60cec-6d55-4a27-ad44-c68d6181a54a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"//v3/contacts?email=&offset=0&limit=20&sort_by=&order_by=","description":"

List contacts and filter them by any custom properties.

\n

To filter contacts on custom property, just add the property with its exact value as a query parameter:
myCustomProp=ThisIsAValue
This will return the contacts where myCustomProp exactly matches the provided value.

\n","urlObject":{"path":["v3","contacts"],"host":["/"],"query":[{"key":"email","value":""},{"description":{"content":"

The cursor used in pagination. This is the index of the first contact to be returned.

\n","type":"text/plain"},"key":"offset","value":"0"},{"description":{"content":"

The maximum number of contacts to be returned. The default is 20.

\n","type":"text/plain"},"key":"limit","value":"20"},{"description":{"content":"

The property used to sort the contacts by. The default is Name.

\n","type":"text/plain"},"key":"sort_by","value":""},{"description":{"content":"

The sorting direction for the returned contacts. Accepted values: ASC, DESC. The default is ASC.

\n","type":"text/plain"},"key":"order_by","value":""}],"variable":[]}},"response":[{"id":"651a035c-3ad6-44b6-9a66-01ee8515a893","name":"Contacts returned","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"//v3/contacts?email=&offset=0&limit=20&sort_by=&order_by=","host":["/"],"path":["v3","contacts"],"query":[{"key":"email","value":""},{"description":"The cursor used in pagination. This is the index of the first contact to be returned.","key":"offset","value":"0"},{"description":"The maximum number of contacts to be returned. The default is 20.","key":"limit","value":"20"},{"description":"The property used to sort the contacts by. The default is Name.","key":"sort_by","value":""},{"description":"The sorting direction for the returned contacts. Accepted values: ASC, DESC. The default is ASC.","key":"order_by","value":""}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"items\": [\n {\n \"id\": \"\",\n \"source\": \"Website\",\n \"properties\": {\n \"key_0\": \"\"\n }\n },\n {\n \"id\": \"\",\n \"source\": \"PartnerDirectory\",\n \"properties\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n }\n ]\n}"}],"_postman_id":"6bd60cec-6d55-4a27-ad44-c68d6181a54a"},{"name":"Get contact","id":"0afb761b-d734-487d-a39a-2010fddd41e7","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"//v3/contacts/:id","description":"

Retrieve an existing contact by id.

\n","urlObject":{"path":["v3","contacts",":id"],"host":["/"],"query":[],"variable":[{"id":"6050336f-061f-49f8-8bb0-9cade1d6154b","description":{"content":"

(Required) The ID of the contact to return.

\n","type":"text/plain"},"type":"any","value":"","key":"id"}]}},"response":[{"id":"10d7e226-e137-4d11-8217-eee82da6b018","name":"Contact found","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"//v3/contacts/:id","host":["/"],"path":["v3","contacts",":id"],"variable":[{"key":"id","value":"","description":"(Required) The ID of the contact to return."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"\",\n \"source\": \"Website\",\n \"properties\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"2dee58f0-ea5d-4808-82fc-b1b1f2e62d68","name":"Contact not found","originalRequest":{"method":"GET","header":[],"url":{"raw":"//v3/contacts/:id","host":["/"],"path":["v3","contacts",":id"],"variable":[{"key":"id","value":"","description":"(Required) The ID of the contact to return."}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":null}],"_postman_id":"0afb761b-d734-487d-a39a-2010fddd41e7"},{"name":"Update contact","id":"8e80d4f7-e96a-4f46-be2e-32c8d8808d9b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PATCH","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"id\": \"\",\n \"properties\": {\n \"key_0\": \"\",\n \"key_1\": \"\",\n \"key_2\": \"\",\n \"key_3\": \"\"\n },\n \"leadSource\": \"System\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"//v3/contacts/:id","description":"

You can only specify properties to update in the properties field as this method will PATCH the existing contact.\nProperties not found in the properties field will not be modified.

\n","urlObject":{"path":["v3","contacts",":id"],"host":["/"],"query":[],"variable":[{"id":"66f6558e-ace3-422a-8cfd-a614ebc7a83d","description":{"content":"

(Required) The ID of the contact to update.

\n","type":"text/plain"},"type":"any","value":"","key":"id"}]}},"response":[{"id":"7430f152-5088-4259-9d24-79811ef52233","name":"Contact updated","originalRequest":{"method":"PATCH","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"id\": \"\",\n \"properties\": {\n \"key_0\": \"\",\n \"key_1\": \"\",\n \"key_2\": \"\",\n \"key_3\": \"\"\n },\n \"leadSource\": \"System\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"//v3/contacts/:id","host":["/"],"path":["v3","contacts",":id"],"variable":[{"key":"id","value":"","description":"(Required) The ID of the contact to update."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"\",\n \"source\": \"Website\",\n \"properties\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"304771bd-240c-4dc6-9a76-f11ea0b562a2","name":"Contact not found","originalRequest":{"method":"PATCH","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"id\": \"\",\n \"properties\": {\n \"key_0\": \"\",\n \"key_1\": \"\",\n \"key_2\": \"\",\n \"key_3\": \"\"\n },\n \"leadSource\": \"System\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"//v3/contacts/:id","host":["/"],"path":["v3","contacts",":id"],"variable":[{"key":"id","value":"","description":"(Required) The ID of the contact to update."}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":null}],"_postman_id":"8e80d4f7-e96a-4f46-be2e-32c8d8808d9b"}],"id":"c368ada5-e771-4b8f-8283-44ba35762d1b","_postman_id":"c368ada5-e771-4b8f-8283-44ba35762d1b","description":""},{"name":"Customers","item":[{"name":"List customers","id":"5c467386-89df-4c71-8cc7-c1ae34312314","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"//v3/customers?partner_id=&partner_id=&offset=&limit=&sort_by=&order_by=","description":"

List customers and filter them by partner or any custom properties.

\n

To filter customers on custom property, just add the property with its exact value as a query parameter:
myCustomProp=ThisIsAValue
This will return the customers where myCustomProp exactly matches the provided value.

\n","urlObject":{"path":["v3","customers"],"host":["/"],"query":[{"key":"partner_id","value":""},{"key":"partner_id","value":""},{"key":"offset","value":""},{"key":"limit","value":""},{"key":"sort_by","value":""},{"key":"order_by","value":""}],"variable":[]}},"response":[],"_postman_id":"5c467386-89df-4c71-8cc7-c1ae34312314"},{"name":"Create customer","id":"5e2db537-3b39-4e66-aeb8-8006fb7bd145","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"properties\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"partnerId\": \"\",\n \"source\": \"OnlineReferral\",\n \"status\": \"Unknown\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"//v3/customers","description":"

Create a new customer and optionnaly associate it with an existing partner.

\n

Examples:
To associate the customer with the partner ID 42, set the partnerId property to be:
\"partnerId\": 42

\n

If the customer comes from your website via a referral link shared by a partner and you want to associate it with the correct partner, use the HTTP header:
Kiflo-Tracking-Code: AABBCCDDEEFF+=
The ** tracking code** can be retrieved in javascript from your website using the JS SDK. Please referer to theJS SDK documentation.

\n","urlObject":{"path":["v3","customers"],"host":["/"],"query":[],"variable":[]}},"response":[{"id":"a7a4242e-a953-44a9-82fc-f09acf8d3624","name":"Customer created","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"properties\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"partnerId\": \"\",\n \"source\": \"OnlineReferral\",\n \"status\": \"Unknown\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"//v3/customers"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"\",\n \"creationDate\": \"\",\n \"properties\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"sourcePartnerId\": \"\",\n \"sourceLeadId\": \"\",\n \"status\": \"Canceled\",\n \"source\": \"Deal\",\n \"isDeleted\": \"\",\n \"deletionDate\": \"\"\n}"},{"id":"5cc2c638-ad5b-424a-b437-0fd343d6bd3f","name":"Invalid request","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"properties\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"partnerId\": \"\",\n \"source\": \"OnlineReferral\",\n \"status\": \"Unknown\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"//v3/customers"},"status":"Bad Request","code":400,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":null}],"_postman_id":"5e2db537-3b39-4e66-aeb8-8006fb7bd145"},{"name":"Get customer","id":"8010bf34-b33f-406a-9bb3-728fdc93cf26","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"//v3/customers/:id","description":"

Retrieve an existing customer by id.

\n","urlObject":{"path":["v3","customers",":id"],"host":["/"],"query":[],"variable":[{"id":"f5046c0a-b812-4805-9ff9-9a5053027073","description":{"content":"

(Required) The ID of the customer to return.

\n","type":"text/plain"},"type":"any","value":"","key":"id"}]}},"response":[],"_postman_id":"8010bf34-b33f-406a-9bb3-728fdc93cf26"},{"name":"Update customer","id":"52b0653a-f841-4824-8044-9bae6829a0c4","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"id\": \"\",\n \"properties\": {\n \"key_0\": \"\"\n },\n \"partnerId\": \"\",\n \"status\": \"Canceled\",\n \"source\": \"OnlineReferral\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"//v3/customers/:id","description":"

You must specify all properties in the properties field as this method will update the whole customer.

\n","urlObject":{"path":["v3","customers",":id"],"host":["/"],"query":[],"variable":[{"id":"d673c79d-d727-4175-b0ea-a83fcbd646e7","description":{"content":"

(Required) The ID of the customer to update.

\n","type":"text/plain"},"type":"any","value":"","key":"id"}]}},"response":[{"id":"fdccf151-59d7-4aef-86f5-45260b407a08","name":"Customer updated","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"id\": \"\",\n \"properties\": {\n \"key_0\": \"\"\n },\n \"partnerId\": \"\",\n \"status\": \"Canceled\",\n \"source\": \"OnlineReferral\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"//v3/customers/:id","host":["/"],"path":["v3","customers",":id"],"variable":[{"key":"id","value":"","description":"(Required) The ID of the customer to update."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"\",\n \"creationDate\": \"\",\n \"properties\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"sourcePartnerId\": \"\",\n \"sourceLeadId\": \"\",\n \"status\": \"Canceled\",\n \"source\": \"Deal\",\n \"isDeleted\": \"\",\n \"deletionDate\": \"\"\n}"},{"id":"db3caaab-09b5-4605-839f-0f44e3c66dd6","name":"Customer not found","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"id\": \"\",\n \"properties\": {\n \"key_0\": \"\"\n },\n \"partnerId\": \"\",\n \"status\": \"Canceled\",\n \"source\": \"OnlineReferral\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"//v3/customers/:id","host":["/"],"path":["v3","customers",":id"],"variable":[{"key":"id","value":"","description":"(Required) The ID of the customer to update."}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":null}],"_postman_id":"52b0653a-f841-4824-8044-9bae6829a0c4"},{"name":"Patch customer","id":"b11e4f49-7177-4ea9-8b53-7b0e4cf821ef","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PATCH","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"id\": \"\",\n \"properties\": {\n \"key_0\": \"\"\n },\n \"partnerId\": \"\",\n \"status\": \"Canceled\",\n \"source\": \"OnlineReferral\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"//v3/customers/:id","urlObject":{"path":["v3","customers",":id"],"host":["/"],"query":[],"variable":[{"id":"50706d4b-8b0e-4148-9eb6-f3edbf077a7f","description":{"content":"

(Required) The ID of the customer to patch.

\n","type":"text/plain"},"type":"any","value":"","key":"id"}]}},"response":[{"id":"2eba100e-9962-4761-a185-e475d7270fa3","name":"Customer updated","originalRequest":{"method":"PATCH","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"id\": \"\",\n \"properties\": {\n \"key_0\": \"\"\n },\n \"partnerId\": \"\",\n \"status\": \"Canceled\",\n \"source\": \"OnlineReferral\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"//v3/customers/:id","host":["/"],"path":["v3","customers",":id"],"variable":[{"key":"id","value":"","description":"(Required) The ID of the customer to patch."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"\",\n \"creationDate\": \"\",\n \"properties\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"sourcePartnerId\": \"\",\n \"sourceLeadId\": \"\",\n \"status\": \"Canceled\",\n \"source\": \"Deal\",\n \"isDeleted\": \"\",\n \"deletionDate\": \"\"\n}"},{"id":"305768c9-5442-4222-a445-910dc39b4549","name":"Customer not found","originalRequest":{"method":"PATCH","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"id\": \"\",\n \"properties\": {\n \"key_0\": \"\"\n },\n \"partnerId\": \"\",\n \"status\": \"Canceled\",\n \"source\": \"OnlineReferral\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"//v3/customers/:id","host":["/"],"path":["v3","customers",":id"],"variable":[{"key":"id","value":"","description":"(Required) The ID of the customer to patch."}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":null}],"_postman_id":"b11e4f49-7177-4ea9-8b53-7b0e4cf821ef"},{"name":"Delete customer","id":"35e5b980-3da2-420d-8532-30e26225d266","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[],"url":"//v3/customers/:id","urlObject":{"path":["v3","customers",":id"],"host":["/"],"query":[],"variable":[{"id":"fdd4f3f3-784a-4f5a-a879-6a8b43c2fa89","description":{"content":"

(Required) The ID of the customer to delete.

\n","type":"text/plain"},"type":"any","value":"","key":"id"}]}},"response":[{"id":"2fcc70d2-590a-428f-af11-b8c4a28fd507","name":"Customer deleted","originalRequest":{"method":"DELETE","header":[],"url":{"raw":"//v3/customers/:id","host":["/"],"path":["v3","customers",":id"],"variable":[{"key":"id","value":"","description":"(Required) The ID of the customer to delete."}]}},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":null},{"id":"8f8efff3-3775-47e5-b398-03118c1bb148","name":"Customer not found","originalRequest":{"method":"DELETE","header":[],"url":{"raw":"//v3/customers/:id","host":["/"],"path":["v3","customers",":id"],"variable":[{"key":"id","value":"","description":"(Required) The ID of the customer to delete."}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":null}],"_postman_id":"35e5b980-3da2-420d-8532-30e26225d266"}],"id":"b5d059dc-9dbb-43eb-a2d1-687d5b4f5f87","_postman_id":"b5d059dc-9dbb-43eb-a2d1-687d5b4f5f87","description":""},{"name":"CustomersProperties","item":[{"name":"List customer properties","id":"d499e16c-2c84-4215-aea8-692577530206","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"//v3/customers/properties","description":"

List all custom properties defined on customer object.
You can customize the customer properties from your account's settings page.

\n","urlObject":{"path":["v3","customers","properties"],"host":["/"],"query":[],"variable":[]}},"response":[{"id":"44eaba64-9300-4def-8d97-129be47a9ce8","name":"Success","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"//v3/customers/properties"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"id\": \"\",\n \"entityType\": \"PartnerDirectory\",\n \"propertyType\": \"Currency\",\n \"name\": \"\",\n \"label\": \"\",\n \"placeholder\": \"\",\n \"description\": \"\",\n \"isRequired\": \"\",\n \"isVisible\": \"\",\n \"isPartnerEditable\": \"\",\n \"isCustom\": \"\",\n \"isReadOnly\": \"\",\n \"displayOrder\": \"\",\n \"isDealAmountPart\": \"\",\n \"canEditDescription\": \"\",\n \"canEditIsRequired\": \"\",\n \"dropdownConfiguration\": {\n \"options\": [\n {\n \"label\": \"\",\n \"originalValue\": \"\",\n \"value\": \"\"\n },\n {\n \"label\": \"\",\n \"originalValue\": \"\",\n \"value\": \"\"\n }\n ]\n }\n },\n {\n \"id\": \"\",\n \"entityType\": \"View\",\n \"propertyType\": \"Number\",\n \"name\": \"\",\n \"label\": \"\",\n \"placeholder\": \"\",\n \"description\": \"\",\n \"isRequired\": \"\",\n \"isVisible\": \"\",\n \"isPartnerEditable\": \"\",\n \"isCustom\": \"\",\n \"isReadOnly\": \"\",\n \"displayOrder\": \"\",\n \"isDealAmountPart\": \"\",\n \"canEditDescription\": \"\",\n \"canEditIsRequired\": \"\",\n \"dropdownConfiguration\": {\n \"options\": [\n {\n \"label\": \"\",\n \"originalValue\": \"\",\n \"value\": \"\"\n },\n {\n \"label\": \"\",\n \"originalValue\": \"\",\n \"value\": \"\"\n }\n ]\n }\n }\n]"}],"_postman_id":"d499e16c-2c84-4215-aea8-692577530206"}],"id":"d4d081a0-34c7-4db8-b535-28f13139b9d2","_postman_id":"d4d081a0-34c7-4db8-b535-28f13139b9d2","description":""},{"name":"DealPipelines","item":[{"name":"List deal stages","id":"eb7020e6-cf54-4b76-a4be-c7d342cc84e0","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"//v3/deals/stages","description":"

List all available stages on the deal board, as defined on your account's settings page.

\n","urlObject":{"path":["v3","deals","stages"],"host":["/"],"query":[],"variable":[]}},"response":[{"id":"fdbc7f91-94d2-487f-a974-cca4c9818384","name":"Stages returned","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"//v3/deals/stages"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\"\n }\n]"}],"_postman_id":"eb7020e6-cf54-4b76-a4be-c7d342cc84e0"}],"id":"0d9e1b57-88f9-411b-bb15-0c8e74d09598","_postman_id":"0d9e1b57-88f9-411b-bb15-0c8e74d09598","description":""},{"name":"DealProperties","item":[{"name":"List deal properties","id":"aadb6672-2104-4cdf-ad43-ddbd9096f6f2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"//v3/deals/properties","description":"

List all custom properties defined on deal object.
You can customize the deal properties from your account's settings page.

\n","urlObject":{"path":["v3","deals","properties"],"host":["/"],"query":[],"variable":[]}},"response":[{"id":"7403ad09-1153-4260-a919-4b89603980ea","name":"Success","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"//v3/deals/properties"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"id\": \"\",\n \"entityType\": \"PartnerDirectory\",\n \"propertyType\": \"Currency\",\n \"name\": \"\",\n \"label\": \"\",\n \"placeholder\": \"\",\n \"description\": \"\",\n \"isRequired\": \"\",\n \"isVisible\": \"\",\n \"isPartnerEditable\": \"\",\n \"isCustom\": \"\",\n \"isReadOnly\": \"\",\n \"displayOrder\": \"\",\n \"isDealAmountPart\": \"\",\n \"canEditDescription\": \"\",\n \"canEditIsRequired\": \"\",\n \"dropdownConfiguration\": {\n \"options\": [\n {\n \"label\": \"\",\n \"originalValue\": \"\",\n \"value\": \"\"\n },\n {\n \"label\": \"\",\n \"originalValue\": \"\",\n \"value\": \"\"\n }\n ]\n }\n },\n {\n \"id\": \"\",\n \"entityType\": \"View\",\n \"propertyType\": \"Number\",\n \"name\": \"\",\n \"label\": \"\",\n \"placeholder\": \"\",\n \"description\": \"\",\n \"isRequired\": \"\",\n \"isVisible\": \"\",\n \"isPartnerEditable\": \"\",\n \"isCustom\": \"\",\n \"isReadOnly\": \"\",\n \"displayOrder\": \"\",\n \"isDealAmountPart\": \"\",\n \"canEditDescription\": \"\",\n \"canEditIsRequired\": \"\",\n \"dropdownConfiguration\": {\n \"options\": [\n {\n \"label\": \"\",\n \"originalValue\": \"\",\n \"value\": \"\"\n },\n {\n \"label\": \"\",\n \"originalValue\": \"\",\n \"value\": \"\"\n }\n ]\n }\n }\n]"}],"_postman_id":"aadb6672-2104-4cdf-ad43-ddbd9096f6f2"}],"id":"c616ea89-ac80-4d36-93ee-40499dfe53cf","_postman_id":"c616ea89-ac80-4d36-93ee-40499dfe53cf","description":""},{"name":"Deals","item":[{"name":"Create deal","id":"79b63ef0-4d2e-4ac3-ab2f-992caecd416e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"contactId\": \"\",\n \"stage\": \"\",\n \"closeDate\": \"\",\n \"properties\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"partners\": [\n {\n \"partnerId\": \"\",\n \"partnerType\": \"\",\n \"userPartnerOwnerId\": \"\"\n },\n {\n \"partnerId\": \"\",\n \"partnerType\": \"\",\n \"userPartnerOwnerId\": \"\"\n }\n ],\n \"contact\": {\n \"properties\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"source\": \"HubSpot\"\n },\n \"source\": \"PartnerDirectory\",\n \"contractStartDate\": \"\",\n \"contractEndDate\": \"\",\n \"currency\": \"\",\n \"sourcePartnerId\": \"\",\n \"status\": \"Pending\",\n \"ownerUserId\": \"\",\n \"assignToPartnerOwner\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"//v3/deals","description":"

Create a new deal and associate roles on it for existing partners.

\n

Body parameters

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterTypeDescription
contactIdintegerID of an existing contact to link to this deal. Mutually exclusive with contact.
stagestringThe deal pipeline stage name. Must match an existing stage configured in your Kiflo account (e.g. New, Qualified, Closed Won).
closeDatestringExpected close date of the deal. ISO 8601 UTC format (e.g. 2025-12-31T00:00:00Z).
propertiesobjectDictionary of custom deal properties defined in your Kiflo account. Keys are the property API names.
partnersarrayList of partner roles on the deal. Each entry links a partner with a specific role type. See partners[] below.
contactobjectInline contact to create and associate with the deal. Mutually exclusive with contactId. See contact below.
sourcestringOrigin of the deal data. Accepted values: Unknown, Website, Partner, Api, Zapier, Tenant, System, HubSpot, Stripe, PartnerDirectory.
contractStartDatestringContract start date. ISO 8601 UTC format.
contractEndDatestringContract end date. ISO 8601 UTC format.
currencystringISO 4217 currency code (e.g. USD, EUR).
sourcePartnerIdintegerID of the partner that sourced this deal. Required when source is set to Partner.
statusstringInitial deal status. Accepted values: Pending, Accepted, Refused, Expired. Defaults to Pending.
ownerUserIdintegerID of the internal user to set as deal owner. Leave null to rely on the assignToPartnerOwner logic instead.
assignToPartnerOwnerbooleanWhen true, automatically assigns the deal owner from the source partner's owner. Only applied when ownerUserId is not set. Defaults to true.
\n

partners[]

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterTypeDescription
partnerIdintegerRequired. ID of the partner to associate with the deal.
partnerTypestringThe partner role name (e.g. Reseller, Business Introducer). Must match an existing partner type in your account.
userPartnerOwnerIdintegerID of the partner's user to set as deal contact on the partner side. Leave null to use the partner's default owner.
\n

contact

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterTypeDescription
propertiesobjectContact properties. Must include at minimum firstName, lastName, and email.
sourcestringOrigin of the contact data. Accepted values: Unknown, Website, Partner, Api, Zapier, Tenant, System, HubSpot, Stripe, PartnerDirectory.
\n
","urlObject":{"path":["v3","deals"],"host":["/"],"query":[],"variable":[]}},"response":[],"_postman_id":"79b63ef0-4d2e-4ac3-ab2f-992caecd416e"},{"name":"List deals","id":"7db45a57-d9c4-4ec8-947a-96d7c0a327ee","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"//v3/deals?offset=0&limit=20&sort_by=&order_by=","description":"

List deals and filter them by custom properties.

\n

To filter deals on custom property, just add the property with its exact value as a query parameter:
myCustomProp=ThisIsAValue
This will return the deals where myCustomProp exactly matches the provided value.

\n","urlObject":{"path":["v3","deals"],"host":["/"],"query":[{"description":{"content":"

The cursor used in pagination. This is the index of the first deal to be returned.

\n","type":"text/plain"},"key":"offset","value":"0"},{"description":{"content":"

The maximum number of deals to be returned. The default is 20.

\n","type":"text/plain"},"key":"limit","value":"20"},{"description":{"content":"

The property used to sort the deals by. The default is CreationDate.

\n","type":"text/plain"},"key":"sort_by","value":""},{"description":{"content":"

The sorting direction for the returned deals. Accepted values: ASC, DESC. The default is DESC.

\n","type":"text/plain"},"key":"order_by","value":""}],"variable":[]}},"response":[],"_postman_id":"7db45a57-d9c4-4ec8-947a-96d7c0a327ee"},{"name":"Get deal","id":"1cf7b7b8-f7f3-44c1-ba60-fb42bea11f6e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"//v3/deals/:id","description":"

Retrieve an existing deal by id.

\n","urlObject":{"path":["v3","deals",":id"],"host":["/"],"query":[],"variable":[{"id":"0eb56615-bdae-4902-8aee-cb5a71b4ba60","description":{"content":"

(Required) The ID of the deal to return.

\n","type":"text/plain"},"type":"any","value":"","key":"id"}]}},"response":[],"_postman_id":"1cf7b7b8-f7f3-44c1-ba60-fb42bea11f6e"},{"name":"Update deal","id":"60ccb91f-9d4a-4125-9eac-bdfffcdfa2a2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PATCH","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"id\": \"\",\n \"stage\": \"\",\n \"closeDate\": \"\",\n \"contractStartDate\": \"\",\n \"contractEndDate\": \"\",\n \"properties\": {\n \"key_0\": \"\",\n \"key_1\": \"\",\n \"key_2\": \"\"\n },\n \"partners\": [\n {\n \"partnerId\": \"\",\n \"partnerType\": \"\",\n \"userPartnerOwnerId\": \"\"\n },\n {\n \"partnerId\": \"\",\n \"partnerType\": \"\",\n \"userPartnerOwnerId\": \"\"\n }\n ],\n \"ownerUserId\": \"\",\n \"currency\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"//v3/deals/:id","description":"

You can only specify properties to update in the properties field as this method will PATCH the existing deal.\nProperties not found in the properties field will not be modified.

\n","urlObject":{"path":["v3","deals",":id"],"host":["/"],"query":[],"variable":[{"id":"a6fd737a-8b52-4c19-bfb1-1e2789f985f4","description":{"content":"

(Required) The ID of the deal to update.

\n","type":"text/plain"},"type":"any","value":"","key":"id"}]}},"response":[],"_postman_id":"60ccb91f-9d4a-4125-9eac-bdfffcdfa2a2"},{"name":"Add partner on a deal","id":"c25f6d45-9dbf-40a8-b441-60a08dd8bcf1","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"dealId\": \"\",\n \"partnerId\": \"\",\n \"partnerTypeId\": \"\",\n \"isSource\": \"\",\n \"useDefaultRewards\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"//v3/deals/:dealId/partners","description":"

Adding a partner with a specific role on a deal will make the deal available for the partner on his partner portal.

\n

Use the isSource property to define whether the partner is also the source of the deal or not. If true, the partner is defined is defined as the source of the deal, no\nmatter what the previous source was.

\n","urlObject":{"path":["v3","deals",":dealId","partners"],"host":["/"],"query":[],"variable":[{"id":"01d795df-1d4b-47d5-ac2d-62e69e7dd899","description":{"content":"

(Required) The existing deal ID to add the partner on.

\n","type":"text/plain"},"type":"any","value":"","key":"dealId"}]}},"response":[{"id":"c3a8a416-5c38-4319-8a72-0cedbd0af522","name":"Success","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"dealId\": \"\",\n \"partnerId\": \"\",\n \"partnerTypeId\": \"\",\n \"isSource\": \"\",\n \"useDefaultRewards\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"//v3/deals/:dealId/partners","host":["/"],"path":["v3","deals",":dealId","partners"],"variable":[{"key":"dealId","value":"","description":"(Required) The existing deal ID to add the partner on."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"\",\n \"dealId\": \"\",\n \"userPartnerOwnerId\": \"\",\n \"userPartnerOwnerName\": \"\",\n \"userPartnerFirstName\": \"\",\n \"userPartnerLastName\": \"\",\n \"userPartnerEmail\": \"\",\n \"userPartnerJobTitle\": \"\",\n \"userPartnerPhoneNumber\": \"\",\n \"userPartnerLinkedInProfileUrl\": \"\",\n \"partnerId\": \"\",\n \"partnerTypeId\": \"\",\n \"creationDate\": \"\",\n \"partnerName\": \"\",\n \"partnerTypeName\": \"\"\n}"}],"_postman_id":"c25f6d45-9dbf-40a8-b441-60a08dd8bcf1"},{"name":"Accept deal","id":"6f1a1823-4b66-4705-848c-bc3f83138ce7","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"note\": \"\",\n \"noteVisibility\": \"Unknown\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"//v3/deals/:id/accept","description":"

Accept a deal and set its status to Accepted

\n","urlObject":{"path":["v3","deals",":id","accept"],"host":["/"],"query":[],"variable":[{"id":"e3ae6f44-fd0c-41ce-bd72-a541aa681753","description":{"content":"

(Required) The ID of the deal to accept.

\n","type":"text/plain"},"type":"any","value":"","key":"id"}]}},"response":[{"id":"b9348ce4-3ce2-4dfc-95df-e6f75aafb1b6","name":"Deal accepted","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"note\": \"\",\n \"noteVisibility\": \"Unknown\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"//v3/deals/:id/accept","host":["/"],"path":["v3","deals",":id","accept"],"variable":[{"key":"id","value":"","description":"(Required) The ID of the deal to accept."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"\",\n \"contactId\": \"\",\n \"sourcePartnerId\": \"\",\n \"stage\": \"\",\n \"creationDate\": \"\",\n \"totalAmount\": \"\",\n \"properties\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"sourceLeadId\": \"\",\n \"status\": \"Pending\",\n \"partners\": [\n {\n \"id\": \"\",\n \"dealId\": \"\",\n \"userPartnerOwnerId\": \"\",\n \"userPartnerOwnerName\": \"\",\n \"userPartnerFirstName\": \"\",\n \"userPartnerLastName\": \"\",\n \"userPartnerEmail\": \"\",\n \"userPartnerJobTitle\": \"\",\n \"userPartnerPhoneNumber\": \"\",\n \"userPartnerLinkedInProfileUrl\": \"\",\n \"partnerId\": \"\",\n \"partnerTypeId\": \"\",\n \"creationDate\": \"\",\n \"partnerName\": \"\",\n \"partnerTypeName\": \"\"\n },\n {\n \"id\": \"\",\n \"dealId\": \"\",\n \"userPartnerOwnerId\": \"\",\n \"userPartnerOwnerName\": \"\",\n \"userPartnerFirstName\": \"\",\n \"userPartnerLastName\": \"\",\n \"userPartnerEmail\": \"\",\n \"userPartnerJobTitle\": \"\",\n \"userPartnerPhoneNumber\": \"\",\n \"userPartnerLinkedInProfileUrl\": \"\",\n \"partnerId\": \"\",\n \"partnerTypeId\": \"\",\n \"creationDate\": \"\",\n \"partnerName\": \"\",\n \"partnerTypeName\": \"\"\n }\n ],\n \"contractStartDate\": \"\",\n \"contractEndDate\": \"\",\n \"ownerUserId\": \"\",\n \"owner\": {\n \"id\": \"\",\n \"email\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\"\n },\n \"closeDate\": \"\",\n \"customerId\": \"\",\n \"currency\": \"\"\n}"},{"id":"510ba0f0-e09d-4bc5-bdf3-692d5fa79681","name":"Deal not found","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"note\": \"\",\n \"noteVisibility\": \"Unknown\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"//v3/deals/:id/accept","host":["/"],"path":["v3","deals",":id","accept"],"variable":[{"key":"id","value":"","description":"(Required) The ID of the deal to accept."}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":null}],"_postman_id":"6f1a1823-4b66-4705-848c-bc3f83138ce7"},{"name":"Refuse deal","id":"1a833553-e6ff-4ff7-878a-4d86756b9638","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"note\": \"\",\n \"noteVisibility\": \"Unknown\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"//v3/deals/:id/refuse","description":"

Refuse a deal and set its status to Refused

\n","urlObject":{"path":["v3","deals",":id","refuse"],"host":["/"],"query":[],"variable":[{"id":"d190db37-e38e-4911-9cfc-61dfbe9295d1","description":{"content":"

(Required) The ID of the deal to refuse.

\n","type":"text/plain"},"type":"any","value":"","key":"id"}]}},"response":[{"id":"46e48778-16c9-4354-a745-4ad898cd33ac","name":"Deal refused","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"note\": \"\",\n \"noteVisibility\": \"Unknown\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"//v3/deals/:id/refuse","host":["/"],"path":["v3","deals",":id","refuse"],"variable":[{"key":"id","value":"","description":"(Required) The ID of the deal to refuse."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"\",\n \"contactId\": \"\",\n \"sourcePartnerId\": \"\",\n \"stage\": \"\",\n \"creationDate\": \"\",\n \"totalAmount\": \"\",\n \"properties\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"sourceLeadId\": \"\",\n \"status\": \"Pending\",\n \"partners\": [\n {\n \"id\": \"\",\n \"dealId\": \"\",\n \"userPartnerOwnerId\": \"\",\n \"userPartnerOwnerName\": \"\",\n \"userPartnerFirstName\": \"\",\n \"userPartnerLastName\": \"\",\n \"userPartnerEmail\": \"\",\n \"userPartnerJobTitle\": \"\",\n \"userPartnerPhoneNumber\": \"\",\n \"userPartnerLinkedInProfileUrl\": \"\",\n \"partnerId\": \"\",\n \"partnerTypeId\": \"\",\n \"creationDate\": \"\",\n \"partnerName\": \"\",\n \"partnerTypeName\": \"\"\n },\n {\n \"id\": \"\",\n \"dealId\": \"\",\n \"userPartnerOwnerId\": \"\",\n \"userPartnerOwnerName\": \"\",\n \"userPartnerFirstName\": \"\",\n \"userPartnerLastName\": \"\",\n \"userPartnerEmail\": \"\",\n \"userPartnerJobTitle\": \"\",\n \"userPartnerPhoneNumber\": \"\",\n \"userPartnerLinkedInProfileUrl\": \"\",\n \"partnerId\": \"\",\n \"partnerTypeId\": \"\",\n \"creationDate\": \"\",\n \"partnerName\": \"\",\n \"partnerTypeName\": \"\"\n }\n ],\n \"contractStartDate\": \"\",\n \"contractEndDate\": \"\",\n \"ownerUserId\": \"\",\n \"owner\": {\n \"id\": \"\",\n \"email\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\"\n },\n \"closeDate\": \"\",\n \"customerId\": \"\",\n \"currency\": \"\"\n}"},{"id":"7b3f158a-28bb-4a83-88a4-9eb483d4eb7f","name":"Deal not found","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"note\": \"\",\n \"noteVisibility\": \"Unknown\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"//v3/deals/:id/refuse","host":["/"],"path":["v3","deals",":id","refuse"],"variable":[{"key":"id","value":"","description":"(Required) The ID of the deal to refuse."}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":null}],"_postman_id":"1a833553-e6ff-4ff7-878a-4d86756b9638"},{"name":"Associate a customer to a deal.\r\n\r\nYou can either:\r\n\r\n* associate an existing customer to and existing deal, by `customerId`\r\n* create a new customer and associate with an existing deal, using `customer` field\r\n\r\nSpecify either the `customerId` field ","id":"ffc4391d-2d42-4d3b-ba02-701c8166bef6","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"customerId\": \"\",\n \"customer\": {\n \"properties\": {\n \"key_0\": \"\",\n \"key_1\": \"\",\n \"key_2\": \"\",\n \"key_3\": \"\"\n },\n \"partnerId\": \"\",\n \"source\": \"Lead\",\n \"status\": \"Unknown\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"//v3/deals/:id/associate/customer","description":"

Associate a customer to a deal

\n","urlObject":{"path":["v3","deals",":id","associate","customer"],"host":["/"],"query":[],"variable":[{"id":"007ed570-e1b4-4c43-9a79-75c6c051f71e","description":{"content":"

(Required) The ID of the deal to associate to customer.

\n","type":"text/plain"},"type":"any","value":"","key":"id"}]}},"response":[{"id":"b4e2f5bf-d959-44d0-b6db-5fa1a0bf1653","name":"Customer associated to deal","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"customerId\": \"\",\n \"customer\": {\n \"properties\": {\n \"key_0\": \"\",\n \"key_1\": \"\",\n \"key_2\": \"\",\n \"key_3\": \"\"\n },\n \"partnerId\": \"\",\n \"source\": \"Lead\",\n \"status\": \"Unknown\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"//v3/deals/:id/associate/customer","host":["/"],"path":["v3","deals",":id","associate","customer"],"variable":[{"key":"id","value":"","description":"(Required) The ID of the deal to associate to customer."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"\",\n \"contactId\": \"\",\n \"sourcePartnerId\": \"\",\n \"stage\": \"\",\n \"creationDate\": \"\",\n \"totalAmount\": \"\",\n \"properties\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"sourceLeadId\": \"\",\n \"status\": \"Pending\",\n \"partners\": [\n {\n \"id\": \"\",\n \"dealId\": \"\",\n \"userPartnerOwnerId\": \"\",\n \"userPartnerOwnerName\": \"\",\n \"userPartnerFirstName\": \"\",\n \"userPartnerLastName\": \"\",\n \"userPartnerEmail\": \"\",\n \"userPartnerJobTitle\": \"\",\n \"userPartnerPhoneNumber\": \"\",\n \"userPartnerLinkedInProfileUrl\": \"\",\n \"partnerId\": \"\",\n \"partnerTypeId\": \"\",\n \"creationDate\": \"\",\n \"partnerName\": \"\",\n \"partnerTypeName\": \"\"\n },\n {\n \"id\": \"\",\n \"dealId\": \"\",\n \"userPartnerOwnerId\": \"\",\n \"userPartnerOwnerName\": \"\",\n \"userPartnerFirstName\": \"\",\n \"userPartnerLastName\": \"\",\n \"userPartnerEmail\": \"\",\n \"userPartnerJobTitle\": \"\",\n \"userPartnerPhoneNumber\": \"\",\n \"userPartnerLinkedInProfileUrl\": \"\",\n \"partnerId\": \"\",\n \"partnerTypeId\": \"\",\n \"creationDate\": \"\",\n \"partnerName\": \"\",\n \"partnerTypeName\": \"\"\n }\n ],\n \"contractStartDate\": \"\",\n \"contractEndDate\": \"\",\n \"ownerUserId\": \"\",\n \"owner\": {\n \"id\": \"\",\n \"email\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\"\n },\n \"closeDate\": \"\",\n \"customerId\": \"\",\n \"currency\": \"\"\n}"},{"id":"224b403e-1f8e-4f09-8679-0148e3569a17","name":"Deal not found","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"customerId\": \"\",\n \"customer\": {\n \"properties\": {\n \"key_0\": \"\",\n \"key_1\": \"\",\n \"key_2\": \"\",\n \"key_3\": \"\"\n },\n \"partnerId\": \"\",\n \"source\": \"Lead\",\n \"status\": \"Unknown\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"//v3/deals/:id/associate/customer","host":["/"],"path":["v3","deals",":id","associate","customer"],"variable":[{"key":"id","value":"","description":"(Required) The ID of the deal to associate to customer."}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":null}],"_postman_id":"ffc4391d-2d42-4d3b-ba02-701c8166bef6"}],"id":"ecb26bb1-1914-4a1b-ab26-8d98bea4a406","_postman_id":"ecb26bb1-1914-4a1b-ab26-8d98bea4a406","description":""},{"name":"EmailTemplates","item":[{"name":"List email templates.","id":"91d4cb4e-f962-4674-927d-340f3db986fa","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"//v3/email-templates?isInvitation=&offset=&limit=&sort_by=&order_by=","description":"

List email templates.

\n","urlObject":{"path":["v3","email-templates"],"host":["/"],"query":[{"key":"isInvitation","value":""},{"description":{"content":"

The cursor used in pagination. This is the index of the first note to be returned.

\n","type":"text/plain"},"key":"offset","value":""},{"description":{"content":"

The maximum number of notes to be returned. The default is 20.

\n","type":"text/plain"},"key":"limit","value":""},{"description":{"content":"

The property used to sort the notes by. The default is CreationDate.

\n","type":"text/plain"},"key":"sort_by","value":""},{"description":{"content":"

The sorting direction for the returned notes. Accepted values: ASC, DESC. The default is DESC.

\n","type":"text/plain"},"key":"order_by","value":""}],"variable":[]}},"response":[{"id":"8766c677-1134-4668-8104-91ffdc632674","name":"Notes returned","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"//v3/email-templates?isInvitation=&offset=&limit=&sort_by=&order_by=","host":["/"],"path":["v3","email-templates"],"query":[{"key":"isInvitation","value":""},{"description":"The cursor used in pagination. This is the index of the first note to be returned.","key":"offset","value":""},{"description":"The maximum number of notes to be returned. The default is 20.","key":"limit","value":""},{"description":"The property used to sort the notes by. The default is CreationDate.","key":"sort_by","value":""},{"description":"The sorting direction for the returned notes. Accepted values: ASC, DESC. The default is DESC.","key":"order_by","value":""}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"items\": [\n {\n \"id\": \"\",\n \"content\": \"\",\n \"creationDate\": \"\",\n \"createdByUser\": {\n \"id\": \"\",\n \"email\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\"\n },\n \"createdByPartnerId\": \"\",\n \"createdByPartnerName\": \"\",\n \"partnerId\": \"\",\n \"customerId\": \"\",\n \"dealId\": \"\",\n \"leadId\": \"\",\n \"payoutId\": \"\",\n \"visibility\": \"Unknown\"\n },\n {\n \"id\": \"\",\n \"content\": \"\",\n \"creationDate\": \"\",\n \"createdByUser\": {\n \"id\": \"\",\n \"email\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\"\n },\n \"createdByPartnerId\": \"\",\n \"createdByPartnerName\": \"\",\n \"partnerId\": \"\",\n \"customerId\": \"\",\n \"dealId\": \"\",\n \"leadId\": \"\",\n \"payoutId\": \"\",\n \"visibility\": \"Private\"\n }\n ],\n \"paginationSkipCount\": \"\",\n \"totalCount\": \"\"\n}"}],"_postman_id":"91d4cb4e-f962-4674-927d-340f3db986fa"}],"id":"ddbde694-8370-4d54-a8d7-8e5921f86a59","_postman_id":"ddbde694-8370-4d54-a8d7-8e5921f86a59","description":""},{"name":"Groups","item":[{"name":"List groups","id":"0290862a-0468-4e4e-8a92-92b195628448","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"//v3/groups?offset=0&limit=20&sort_by=&order_by=","description":"

List groups.

\n","urlObject":{"path":["v3","groups"],"host":["/"],"query":[{"description":{"content":"

The cursor used in pagination. This is the index of the first group to be returned.

\n","type":"text/plain"},"key":"offset","value":"0"},{"description":{"content":"

The maximum number of groups to be returned. The default is 20.

\n","type":"text/plain"},"key":"limit","value":"20"},{"description":{"content":"

The property used to sort the groups by. The default is Name.

\n","type":"text/plain"},"key":"sort_by","value":""},{"description":{"content":"

The sorting direction for the returned groups. Accepted values: ASC, DESC. The default is ASC.

\n","type":"text/plain"},"key":"order_by","value":""}],"variable":[]}},"response":[{"id":"a08bf951-d32e-4cd7-8a74-a747aeab9bc9","name":"Groups returned","originalRequest":{"method":"GET","header":[],"url":{"raw":"//v3/groups?offset=0&limit=20&sort_by=&order_by=","host":["/"],"path":["v3","groups"],"query":[{"description":"The cursor used in pagination. This is the index of the first group to be returned.","key":"offset","value":"0"},{"description":"The maximum number of groups to be returned. The default is 20.","key":"limit","value":"20"},{"description":"The property used to sort the groups by. The default is Name.","key":"sort_by","value":""},{"description":"The sorting direction for the returned groups. Accepted values: ASC, DESC. The default is ASC.","key":"order_by","value":""}]}},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":null}],"_postman_id":"0290862a-0468-4e4e-8a92-92b195628448"}],"id":"fd641897-67af-4342-810a-ae2456a48117","_postman_id":"fd641897-67af-4342-810a-ae2456a48117","description":""},{"name":"HubSpot","item":[{"name":"Issues a short-lived, HubSpot-scoped Kiflo access token.","id":"c7c63719-db55-4aee-8d13-a14af636b09f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"//v3/hubspot/access-token?portalId=&userEmail=","description":"

Called by a HubSpot App Card through hubspot.fetch, which appends portalId\nand signs the request. The signature proves the request originates from HubSpot.

\n","urlObject":{"path":["v3","hubspot","access-token"],"host":["/"],"query":[{"key":"portalId","value":""},{"key":"userEmail","value":""}],"variable":[]}},"response":[{"id":"0c63744d-f998-4e91-8f54-5f473700b53c","name":"A short-lived access token was issued.","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"//v3/hubspot/access-token?portalId=&userEmail=","host":["/"],"path":["v3","hubspot","access-token"],"query":[{"key":"portalId","value":""},{"key":"userEmail","value":""}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"accessToken\": \"\",\n \"expiresInSeconds\": \"\"\n}"},{"id":"9ada82a4-9279-4874-8e04-9624091ff705","name":"The request could not be verified or the portal is not connected.","originalRequest":{"method":"GET","header":[],"url":{"raw":"//v3/hubspot/access-token?portalId=&userEmail=","host":["/"],"path":["v3","hubspot","access-token"],"query":[{"key":"portalId","value":""},{"key":"userEmail","value":""}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":null}],"_postman_id":"c7c63719-db55-4aee-8d13-a14af636b09f"}],"id":"fd6b3c5d-1518-404e-995c-502d3f0af453","_postman_id":"fd6b3c5d-1518-404e-995c-502d3f0af453","description":""},{"name":"LeadProperties","item":[{"name":"List lead properties","id":"c44d7345-b9e7-4d9b-b15a-b07c3360355d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"//v3/leads/properties","description":"

List all custom properties defined on lead object.
You can customize the lead properties from your account's settings page.

\n","urlObject":{"path":["v3","leads","properties"],"host":["/"],"query":[],"variable":[]}},"response":[{"id":"92050266-e1c4-4994-86c4-93dc438aceba","name":"Success","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"//v3/leads/properties"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"id\": \"\",\n \"entityType\": \"PartnerDirectory\",\n \"propertyType\": \"Currency\",\n \"name\": \"\",\n \"label\": \"\",\n \"placeholder\": \"\",\n \"description\": \"\",\n \"isRequired\": \"\",\n \"isVisible\": \"\",\n \"isPartnerEditable\": \"\",\n \"isCustom\": \"\",\n \"isReadOnly\": \"\",\n \"displayOrder\": \"\",\n \"isDealAmountPart\": \"\",\n \"canEditDescription\": \"\",\n \"canEditIsRequired\": \"\",\n \"dropdownConfiguration\": {\n \"options\": [\n {\n \"label\": \"\",\n \"originalValue\": \"\",\n \"value\": \"\"\n },\n {\n \"label\": \"\",\n \"originalValue\": \"\",\n \"value\": \"\"\n }\n ]\n }\n },\n {\n \"id\": \"\",\n \"entityType\": \"View\",\n \"propertyType\": \"Number\",\n \"name\": \"\",\n \"label\": \"\",\n \"placeholder\": \"\",\n \"description\": \"\",\n \"isRequired\": \"\",\n \"isVisible\": \"\",\n \"isPartnerEditable\": \"\",\n \"isCustom\": \"\",\n \"isReadOnly\": \"\",\n \"displayOrder\": \"\",\n \"isDealAmountPart\": \"\",\n \"canEditDescription\": \"\",\n \"canEditIsRequired\": \"\",\n \"dropdownConfiguration\": {\n \"options\": [\n {\n \"label\": \"\",\n \"originalValue\": \"\",\n \"value\": \"\"\n },\n {\n \"label\": \"\",\n \"originalValue\": \"\",\n \"value\": \"\"\n }\n ]\n }\n }\n]"}],"_postman_id":"c44d7345-b9e7-4d9b-b15a-b07c3360355d"}],"id":"62ee164a-44b4-4f16-8e59-7b18339fc637","_postman_id":"62ee164a-44b4-4f16-8e59-7b18339fc637","description":""},{"name":"Leads","item":[{"name":"List leads","id":"12004918-ce19-4bbb-887b-6048a043a8e1","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"//v3/leads?partnerId=&offset=&limit=&sort_by=&order_by=&status=Reassigned&status=Accepted","description":"

List leads and filter them by partner, status or any custom properties.

\n

To filter leads on custom property, just add the property with its exact value as a query parameter:
myCustomProp=ThisIsAValue
This will return the leads where myCustomProp exactly matches the provided value.

\n","urlObject":{"path":["v3","leads"],"host":["/"],"query":[{"description":{"content":"

The list of partner IDs to filter the leads on.

\n","type":"text/plain"},"key":"partnerId","value":""},{"description":{"content":"

The cursor used in pagination. This is the index of the first lead to be returned.

\n","type":"text/plain"},"key":"offset","value":""},{"description":{"content":"

The maximum number of leads to be returned. The default is 20.

\n","type":"text/plain"},"key":"limit","value":""},{"description":{"content":"

The property used to sort the leads by. The default is CreationDate.

\n","type":"text/plain"},"key":"sort_by","value":""},{"description":{"content":"

The sorting direction for the returned leads. Accepted values: ASC, DESC. The default is DESC.

\n","type":"text/plain"},"key":"order_by","value":""},{"key":"status","value":"Reassigned"},{"key":"status","value":"Accepted"}],"variable":[]}},"response":[],"_postman_id":"12004918-ce19-4bbb-887b-6048a043a8e1"},{"name":"Create lead","id":"ab3d7444-9460-4658-90e5-2da2b76d90c3","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"properties\": {\n \"key_0\": \"\"\n },\n \"currency\": \"\",\n \"ownerUserId\": \"\",\n \"partnerId\": \"\",\n \"sourcePartnerId\": \"\",\n \"userPartnerOwnerId\": \"\",\n \"assignedContactEmail\": \"\",\n \"deadLine\": \"\",\n \"note\": \"\",\n \"status\": \"Reassigned\",\n \"assignToPartnerOwner\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"//v3/leads","description":"

Create a new lead.

\n

You can assigned the lead with an existing partner using the partnerId property. You will be the source of the lead and the partner will have to\naccept or refuse the lead.

\n

You can set the source of the lead using the sourcePartnerId property. By doing that, you create the lead on behalf of the partner.\nHe won't have to accept or refuse the lead, the lead will be automatically accepted.

\n

Use the note property to add a new note on create lead.

\n

If the lead comes from your website via a referral link shared by a partner and you want to associate it with the correct partner, use the HTTP header:
Kiflo-Tracking-Code: AABBCCDDEEFF+=

\n

The** tracking code** can be retrieved in javascript from your website using the JS SDK.Please referer to theJS SDK documentation.

\n

The status property is optional and can be used only in conjunction with the header parameter Kiflo-Tracking-Code.\nIt can be one of the following value:

\n
    \n
  • Pending: the lead is assigned to the source partner and must be validated by you
    • \n
  • Accepted: the lead is assigned to the source partner and is automatically accepted
    • \n
  • Unassigned: the lead is not assigned to any partner, but the source partner is set correctly. it can be shared to another partner manually
    • \n
\n","urlObject":{"path":["v3","leads"],"host":["/"],"query":[],"variable":[]}},"response":[],"_postman_id":"ab3d7444-9460-4658-90e5-2da2b76d90c3"},{"name":"Get lead","id":"3a5e389e-7420-41fe-96be-7710e50a0c75","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"//v3/leads/:id","description":"

Retrieve an existing lead by id.

\n","urlObject":{"path":["v3","leads",":id"],"host":["/"],"query":[],"variable":[{"id":"024ab918-b9d9-4859-bc64-8f7ec52acf58","description":{"content":"

(Required) The ID of the lead to return.

\n","type":"text/plain"},"type":"any","value":"","key":"id"}]}},"response":[],"_postman_id":"3a5e389e-7420-41fe-96be-7710e50a0c75"},{"name":"Update lead","id":"4251fd81-4534-481f-aa47-3bbcf37207f5","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PATCH","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"deadLine\": \"\",\n \"properties\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"currency\": \"\",\n \"assignedContactEmail\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"//v3/leads/:id","description":"

Update an existing lead.

\n

You can changed the partner team member assigned on the lead using the assignedContactEmail prop.This has to be the email address of an existing team member in the partner's team.

\n","urlObject":{"path":["v3","leads",":id"],"host":["/"],"query":[],"variable":[{"id":"b3f032f0-9708-4d4f-841e-0e8f2ea3c441","description":{"content":"

(Required) The ID of the lead to update.

\n","type":"text/plain"},"type":"any","value":"","key":"id"}]}},"response":[],"_postman_id":"4251fd81-4534-481f-aa47-3bbcf37207f5"},{"name":"Accept lead","id":"57ce4176-cca0-4d84-9a37-c49492ae0744","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"note\": \"\",\n \"noteVisibility\": \"Unknown\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"//v3/leads/:id/accept","description":"

Accept a lead and set its status to Accepted

\n","urlObject":{"path":["v3","leads",":id","accept"],"host":["/"],"query":[],"variable":[{"id":"3aa04fab-85aa-457c-b63d-5198cd26e6fe","description":{"content":"

(Required) The ID of the lead to accept.

\n","type":"text/plain"},"type":"any","value":"","key":"id"}]}},"response":[{"id":"15b3c851-6947-421f-b43d-dace63864085","name":"Lead accepted","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"note\": \"\",\n \"noteVisibility\": \"Unknown\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"//v3/leads/:id/accept","host":["/"],"path":["v3","leads",":id","accept"],"variable":[{"key":"id","value":"","description":"(Required) The ID of the lead to accept."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"\",\n \"creationDate\": \"\",\n \"properties\": {\n \"key_0\": \"\",\n \"key_1\": \"\",\n \"key_2\": \"\"\n },\n \"partnerId\": \"\",\n \"sourcePartnerId\": \"\",\n \"userPartnerOwnerId\": \"\",\n \"dealId\": \"\",\n \"customerId\": \"\",\n \"deadLine\": \"\",\n \"assignedDate\": \"\",\n \"acceptedDate\": \"\",\n \"refusedDate\": \"\",\n \"convertedDate\": \"\",\n \"abandonedDate\": \"\",\n \"status\": \"Unassigned\",\n \"partnerName\": \"\",\n \"dealName\": \"\",\n \"customerName\": \"\",\n \"source\": \"Zapier\",\n \"transferredLeadId\": \"\",\n \"currency\": \"\",\n \"ownerUserId\": \"\",\n \"owner\": {\n \"id\": \"\",\n \"email\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\"\n }\n}"},{"id":"f6b8c227-f7fb-48a5-9da6-bfc9aa60156d","name":"Lead not found","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"note\": \"\",\n \"noteVisibility\": \"Unknown\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"//v3/leads/:id/accept","host":["/"],"path":["v3","leads",":id","accept"],"variable":[{"key":"id","value":"","description":"(Required) The ID of the lead to accept."}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":null}],"_postman_id":"57ce4176-cca0-4d84-9a37-c49492ae0744"},{"name":"Refuse lead","id":"364be08f-ba51-4a45-b90a-6e9f8c3f561b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"note\": \"\",\n \"noteVisibility\": \"Unknown\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"//v3/leads/:id/refuse","description":"

Refuse a lead and set its status to Refused

\n","urlObject":{"path":["v3","leads",":id","refuse"],"host":["/"],"query":[],"variable":[{"id":"93d75805-619a-4a11-9f7b-4f75b962e0b6","description":{"content":"

(Required) The ID of the lead to refuse.

\n","type":"text/plain"},"type":"any","value":"","key":"id"}]}},"response":[{"id":"f16ccb91-b59f-4983-834e-9f2982c4bcf6","name":"Lead refused","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"note\": \"\",\n \"noteVisibility\": \"Unknown\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"//v3/leads/:id/refuse","host":["/"],"path":["v3","leads",":id","refuse"],"variable":[{"key":"id","value":"","description":"(Required) The ID of the lead to refuse."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"\",\n \"creationDate\": \"\",\n \"properties\": {\n \"key_0\": \"\",\n \"key_1\": \"\",\n \"key_2\": \"\"\n },\n \"partnerId\": \"\",\n \"sourcePartnerId\": \"\",\n \"userPartnerOwnerId\": \"\",\n \"dealId\": \"\",\n \"customerId\": \"\",\n \"deadLine\": \"\",\n \"assignedDate\": \"\",\n \"acceptedDate\": \"\",\n \"refusedDate\": \"\",\n \"convertedDate\": \"\",\n \"abandonedDate\": \"\",\n \"status\": \"Unassigned\",\n \"partnerName\": \"\",\n \"dealName\": \"\",\n \"customerName\": \"\",\n \"source\": \"Zapier\",\n \"transferredLeadId\": \"\",\n \"currency\": \"\",\n \"ownerUserId\": \"\",\n \"owner\": {\n \"id\": \"\",\n \"email\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\"\n }\n}"},{"id":"d75be73f-dea2-4794-af7d-6b833cd812b0","name":"Lead not found","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"note\": \"\",\n \"noteVisibility\": \"Unknown\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"//v3/leads/:id/refuse","host":["/"],"path":["v3","leads",":id","refuse"],"variable":[{"key":"id","value":"","description":"(Required) The ID of the lead to refuse."}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":null}],"_postman_id":"364be08f-ba51-4a45-b90a-6e9f8c3f561b"},{"name":"Abandon lead","id":"3948a798-3521-4b6f-95c8-d3de30167362","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"note\": \"\",\n \"noteVisibility\": \"Unknown\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"//v3/leads/:id/abandon","description":"

Abandon a lead and set its status to Abandoned

\n","urlObject":{"path":["v3","leads",":id","abandon"],"host":["/"],"query":[],"variable":[{"id":"5d438a93-857d-4af5-acc7-2c7f743aff2d","description":{"content":"

(Required) The ID of the lead to abandon.

\n","type":"text/plain"},"type":"any","value":"","key":"id"}]}},"response":[{"id":"25452026-6e46-42b2-8ad1-722a37f4e4e1","name":"Lead abandoned","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"note\": \"\",\n \"noteVisibility\": \"Unknown\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"//v3/leads/:id/abandon","host":["/"],"path":["v3","leads",":id","abandon"],"variable":[{"key":"id","value":"","description":"(Required) The ID of the lead to abandon."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"\",\n \"creationDate\": \"\",\n \"properties\": {\n \"key_0\": \"\",\n \"key_1\": \"\",\n \"key_2\": \"\"\n },\n \"partnerId\": \"\",\n \"sourcePartnerId\": \"\",\n \"userPartnerOwnerId\": \"\",\n \"dealId\": \"\",\n \"customerId\": \"\",\n \"deadLine\": \"\",\n \"assignedDate\": \"\",\n \"acceptedDate\": \"\",\n \"refusedDate\": \"\",\n \"convertedDate\": \"\",\n \"abandonedDate\": \"\",\n \"status\": \"Unassigned\",\n \"partnerName\": \"\",\n \"dealName\": \"\",\n \"customerName\": \"\",\n \"source\": \"Zapier\",\n \"transferredLeadId\": \"\",\n \"currency\": \"\",\n \"ownerUserId\": \"\",\n \"owner\": {\n \"id\": \"\",\n \"email\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\"\n }\n}"},{"id":"5ffbaf51-d6bd-44c5-a60a-0a0b0e6e0b01","name":"Lead not found","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"note\": \"\",\n \"noteVisibility\": \"Unknown\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"//v3/leads/:id/abandon","host":["/"],"path":["v3","leads",":id","abandon"],"variable":[{"key":"id","value":"","description":"(Required) The ID of the lead to abandon."}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":null}],"_postman_id":"3948a798-3521-4b6f-95c8-d3de30167362"},{"name":"Convert lead to deal","id":"9de50bc1-fa2f-4e97-a3cc-c66d97c6801c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"contact\": {\n \"properties\": {\n \"key_0\": \"\",\n \"key_1\": \"\",\n \"key_2\": \"\"\n }\n },\n \"deal\": {\n \"properties\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n },\n \"associateNotes\": \"\",\n \"associateAttachments\": \"\",\n \"associateMeetings\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"//v3/leads/:id/convert/deal","description":"

Convert a lead to a deal and set its status to Converted

\n","urlObject":{"path":["v3","leads",":id","convert","deal"],"host":["/"],"query":[],"variable":[{"id":"b47c6356-c726-401e-a12e-e4a37f4fd406","description":{"content":"

(Required) The ID of the lead to convert to deal.

\n","type":"text/plain"},"type":"any","value":"","key":"id"}]}},"response":[{"id":"74488aa5-3db1-4ffc-b4e0-396fc15a95f9","name":"Lead converted to deal","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"contact\": {\n \"properties\": {\n \"key_0\": \"\",\n \"key_1\": \"\",\n \"key_2\": \"\"\n }\n },\n \"deal\": {\n \"properties\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n },\n \"associateNotes\": \"\",\n \"associateAttachments\": \"\",\n \"associateMeetings\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"//v3/leads/:id/convert/deal","host":["/"],"path":["v3","leads",":id","convert","deal"],"variable":[{"key":"id","value":"","description":"(Required) The ID of the lead to convert to deal."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"\",\n \"creationDate\": \"\",\n \"properties\": {\n \"key_0\": \"\",\n \"key_1\": \"\",\n \"key_2\": \"\"\n },\n \"partnerId\": \"\",\n \"sourcePartnerId\": \"\",\n \"userPartnerOwnerId\": \"\",\n \"dealId\": \"\",\n \"customerId\": \"\",\n \"deadLine\": \"\",\n \"assignedDate\": \"\",\n \"acceptedDate\": \"\",\n \"refusedDate\": \"\",\n \"convertedDate\": \"\",\n \"abandonedDate\": \"\",\n \"status\": \"Unassigned\",\n \"partnerName\": \"\",\n \"dealName\": \"\",\n \"customerName\": \"\",\n \"source\": \"Zapier\",\n \"transferredLeadId\": \"\",\n \"currency\": \"\",\n \"ownerUserId\": \"\",\n \"owner\": {\n \"id\": \"\",\n \"email\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\"\n }\n}"},{"id":"c9451cee-a384-4d0c-90b2-eafe92e01021","name":"Lead not found","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"contact\": {\n \"properties\": {\n \"key_0\": \"\",\n \"key_1\": \"\",\n \"key_2\": \"\"\n }\n },\n \"deal\": {\n \"properties\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n },\n \"associateNotes\": \"\",\n \"associateAttachments\": \"\",\n \"associateMeetings\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"//v3/leads/:id/convert/deal","host":["/"],"path":["v3","leads",":id","convert","deal"],"variable":[{"key":"id","value":"","description":"(Required) The ID of the lead to convert to deal."}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":null}],"_postman_id":"9de50bc1-fa2f-4e97-a3cc-c66d97c6801c"},{"name":"Convert lead to customer","id":"5fb3a6c9-d56e-40f5-96a3-6694a15fb101","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"customer\": {\n \"sourcePartnerId\": \"\",\n \"properties\": {\n \"key_0\": \"\",\n \"key_1\": \"\",\n \"key_2\": \"\"\n }\n },\n \"associateNotes\": \"\",\n \"associateAttachments\": \"\",\n \"associateMeetings\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"//v3/leads/:id/convert/customer","description":"

Convert a lead to a customer and set its status to Converted.

\n","urlObject":{"path":["v3","leads",":id","convert","customer"],"host":["/"],"query":[],"variable":[{"id":"6caa0832-b84f-487e-aede-077328fa0a54","description":{"content":"

(Required) The ID of the lead to convert to customer.

\n","type":"text/plain"},"type":"any","value":"","key":"id"}]}},"response":[{"id":"313de990-d62e-4dbd-8f43-d44f5e28d7f0","name":"Lead converted to customer","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"customer\": {\n \"sourcePartnerId\": \"\",\n \"properties\": {\n \"key_0\": \"\",\n \"key_1\": \"\",\n \"key_2\": \"\"\n }\n },\n \"associateNotes\": \"\",\n \"associateAttachments\": \"\",\n \"associateMeetings\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"//v3/leads/:id/convert/customer","host":["/"],"path":["v3","leads",":id","convert","customer"],"variable":[{"key":"id","value":"","description":"(Required) The ID of the lead to convert to customer."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"\",\n \"creationDate\": \"\",\n \"properties\": {\n \"key_0\": \"\",\n \"key_1\": \"\",\n \"key_2\": \"\"\n },\n \"partnerId\": \"\",\n \"sourcePartnerId\": \"\",\n \"userPartnerOwnerId\": \"\",\n \"dealId\": \"\",\n \"customerId\": \"\",\n \"deadLine\": \"\",\n \"assignedDate\": \"\",\n \"acceptedDate\": \"\",\n \"refusedDate\": \"\",\n \"convertedDate\": \"\",\n \"abandonedDate\": \"\",\n \"status\": \"Unassigned\",\n \"partnerName\": \"\",\n \"dealName\": \"\",\n \"customerName\": \"\",\n \"source\": \"Zapier\",\n \"transferredLeadId\": \"\",\n \"currency\": \"\",\n \"ownerUserId\": \"\",\n \"owner\": {\n \"id\": \"\",\n \"email\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\"\n }\n}"},{"id":"a5c6fad8-33c2-4f90-a7a8-d35e9bc67919","name":"Lead not found","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"customer\": {\n \"sourcePartnerId\": \"\",\n \"properties\": {\n \"key_0\": \"\",\n \"key_1\": \"\",\n \"key_2\": \"\"\n }\n },\n \"associateNotes\": \"\",\n \"associateAttachments\": \"\",\n \"associateMeetings\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"//v3/leads/:id/convert/customer","host":["/"],"path":["v3","leads",":id","convert","customer"],"variable":[{"key":"id","value":"","description":"(Required) The ID of the lead to convert to customer."}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":null}],"_postman_id":"5fb3a6c9-d56e-40f5-96a3-6694a15fb101"}],"id":"157595eb-e5a9-4ed2-a810-a586aca3b545","_postman_id":"157595eb-e5a9-4ed2-a810-a586aca3b545","description":""},{"name":"LineItems","item":[{"name":"Create line item","id":"b929f714-9a9d-43a4-b732-8b37629daa54","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"productId\": \"\",\n \"partnerId\": \"\",\n \"quantity\": \"\",\n \"unitPrice\": \"\",\n \"suggestedPrice\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"//v3/deals/:dealId/line-items","description":"

Create a new line item on a given deal.

\n","urlObject":{"path":["v3","deals",":dealId","line-items"],"host":["/"],"query":[],"variable":[{"id":"c8b109af-1cf7-4e8b-bb8a-003f6c4c2b88","description":{"content":"

(Required) The ID of the deal containing the line item.

\n","type":"text/plain"},"type":"any","value":"","key":"dealId"}]}},"response":[{"id":"67029c63-fdee-46df-a433-4c4f01343a0a","name":"Line item created","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"productId\": \"\",\n \"partnerId\": \"\",\n \"quantity\": \"\",\n \"unitPrice\": \"\",\n \"suggestedPrice\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"//v3/deals/:dealId/line-items","host":["/"],"path":["v3","deals",":dealId","line-items"],"variable":[{"key":"dealId","value":"","description":"(Required) The ID of the deal containing the line item."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"\",\n \"productId\": \"\",\n \"dealId\": \"\",\n \"unitPrice\": {\n \"value\": \"\",\n \"currency\": \"\"\n },\n \"price\": {\n \"value\": \"\",\n \"currency\": \"\"\n },\n \"suggestedPrice\": {\n \"value\": \"\",\n \"currency\": \"\"\n },\n \"quantity\": \"\",\n \"properties\": {\n \"key_0\": \"\"\n },\n \"creationDate\": \"\"\n}"},{"id":"54540345-9d32-43db-822f-3bf1d28f8e5a","name":"Invalid request","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"productId\": \"\",\n \"partnerId\": \"\",\n \"quantity\": \"\",\n \"unitPrice\": \"\",\n \"suggestedPrice\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"//v3/deals/:dealId/line-items","host":["/"],"path":["v3","deals",":dealId","line-items"],"variable":[{"key":"dealId","value":"","description":"(Required) The ID of the deal containing the line item."}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":null},{"id":"11e83696-1ac7-41e7-a632-43ff6deb5822","name":"You do not have access to this functionality in your current plan","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"productId\": \"\",\n \"partnerId\": \"\",\n \"quantity\": \"\",\n \"unitPrice\": \"\",\n \"suggestedPrice\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"//v3/deals/:dealId/line-items","host":["/"],"path":["v3","deals",":dealId","line-items"],"variable":[{"key":"dealId","value":"","description":"(Required) The ID of the deal containing the line item."}]}},"status":"Forbidden","code":403,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":null}],"_postman_id":"b929f714-9a9d-43a4-b732-8b37629daa54"},{"name":"List line items on a given deal","id":"c9aabf75-cf03-4d2b-8291-9fc14f80ca55","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"//v3/deals/:dealId/line-items?sort_by=&order_by=&offset=&limit=","description":"

List line items on a given deal.

\n","urlObject":{"path":["v3","deals",":dealId","line-items"],"host":["/"],"query":[{"description":{"content":"

Property to sort by.

\n","type":"text/plain"},"key":"sort_by","value":""},{"description":{"content":"

Order by direction. Can be ASC or DESC.

\n","type":"text/plain"},"key":"order_by","value":""},{"description":{"content":"

Start offset used to paginate results.

\n","type":"text/plain"},"key":"offset","value":""},{"description":{"content":"

Maximum number of items to be returned.

\n","type":"text/plain"},"key":"limit","value":""}],"variable":[{"id":"03822d58-b1b4-4b5c-b3c1-9a4b8368ff55","description":{"content":"

(Required) The ID of the deal containing the line items to retrieve.

\n","type":"text/plain"},"type":"any","value":"","key":"dealId"}]}},"response":[{"id":"439c8631-ae0c-45f5-97d5-b98da05d6fed","name":"Line items returned","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"//v3/deals/:dealId/line-items?sort_by=&order_by=&offset=&limit=","host":["/"],"path":["v3","deals",":dealId","line-items"],"query":[{"description":"Property to sort by.","key":"sort_by","value":""},{"description":"Order by direction. Can be ASC or DESC.","key":"order_by","value":""},{"description":"Start offset used to paginate results.","key":"offset","value":""},{"description":"Maximum number of items to be returned.","key":"limit","value":""}],"variable":[{"key":"dealId","value":"","description":"(Required) The ID of the deal containing the line items to retrieve."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"items\": [\n {\n \"id\": \"\",\n \"productId\": \"\",\n \"dealId\": \"\",\n \"unitPrice\": {\n \"value\": \"\",\n \"currency\": \"\"\n },\n \"price\": {\n \"value\": \"\",\n \"currency\": \"\"\n },\n \"suggestedPrice\": {\n \"value\": \"\",\n \"currency\": \"\"\n },\n \"quantity\": \"\",\n \"properties\": {\n \"key_0\": \"\",\n \"key_1\": \"\",\n \"key_2\": \"\"\n },\n \"creationDate\": \"\"\n },\n {\n \"id\": \"\",\n \"productId\": \"\",\n \"dealId\": \"\",\n \"unitPrice\": {\n \"value\": \"\",\n \"currency\": \"\"\n },\n \"price\": {\n \"value\": \"\",\n \"currency\": \"\"\n },\n \"suggestedPrice\": {\n \"value\": \"\",\n \"currency\": \"\"\n },\n \"quantity\": \"\",\n \"properties\": {\n \"key_0\": \"\"\n },\n \"creationDate\": \"\"\n }\n ],\n \"paginationSkipCount\": \"\",\n \"totalCount\": \"\"\n}"},{"id":"5e4e5ff0-2c7b-4812-8510-916196d8ca16","name":"You do not have access to this functionality in your current plan","originalRequest":{"method":"GET","header":[],"url":{"raw":"//v3/deals/:dealId/line-items?sort_by=&order_by=&offset=&limit=","host":["/"],"path":["v3","deals",":dealId","line-items"],"query":[{"description":"Property to sort by.","key":"sort_by","value":""},{"description":"Order by direction. Can be ASC or DESC.","key":"order_by","value":""},{"description":"Start offset used to paginate results.","key":"offset","value":""},{"description":"Maximum number of items to be returned.","key":"limit","value":""}],"variable":[{"key":"dealId","value":"","description":"(Required) The ID of the deal containing the line items to retrieve."}]}},"status":"Forbidden","code":403,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":null}],"_postman_id":"c9aabf75-cf03-4d2b-8291-9fc14f80ca55"},{"name":"Patch line item","id":"0ab7e9a5-d0eb-4c5e-84bc-1f60dbd2ab4f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PATCH","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"productId\": \"\",\n \"partnerId\": \"\",\n \"quantity\": \"\",\n \"unitPrice\": \"\",\n \"suggestedPrice\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"//v3/deals/:dealId/line-items/:id","description":"

This method patches an existing line item. You can leave some properties empty in the request body, they won't be modified.

\n","urlObject":{"path":["v3","deals",":dealId","line-items",":id"],"host":["/"],"query":[],"variable":[{"id":"b0bc83e7-8d4f-4c05-b0d0-ea2ad9b2bebd","description":{"content":"

(Required) The ID of the deal containing the line item.

\n","type":"text/plain"},"type":"any","value":"","key":"dealId"},{"id":"4d870b2c-4eb9-491b-aad1-e54a98eaf1d7","description":{"content":"

(Required) The ID of the line item to delete.

\n","type":"text/plain"},"type":"any","value":"","key":"id"}]}},"response":[{"id":"8c85e348-eb8d-4db5-888f-82341a93f575","name":"Line item updated","originalRequest":{"method":"PATCH","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"productId\": \"\",\n \"partnerId\": \"\",\n \"quantity\": \"\",\n \"unitPrice\": \"\",\n \"suggestedPrice\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"//v3/deals/:dealId/line-items/:id","host":["/"],"path":["v3","deals",":dealId","line-items",":id"],"variable":[{"key":"dealId","value":"","description":"(Required) The ID of the deal containing the line item."},{"key":"id","value":"","description":"(Required) The ID of the line item to delete."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"\",\n \"productId\": \"\",\n \"dealId\": \"\",\n \"unitPrice\": {\n \"value\": \"\",\n \"currency\": \"\"\n },\n \"price\": {\n \"value\": \"\",\n \"currency\": \"\"\n },\n \"suggestedPrice\": {\n \"value\": \"\",\n \"currency\": \"\"\n },\n \"quantity\": \"\",\n \"properties\": {\n \"key_0\": \"\"\n },\n \"creationDate\": \"\"\n}"},{"id":"8d123ec5-d382-4d74-ad55-095192f0887c","name":"You do not have access to this functionality in your current plan","originalRequest":{"method":"PATCH","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"productId\": \"\",\n \"partnerId\": \"\",\n \"quantity\": \"\",\n \"unitPrice\": \"\",\n \"suggestedPrice\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"//v3/deals/:dealId/line-items/:id","host":["/"],"path":["v3","deals",":dealId","line-items",":id"],"variable":[{"key":"dealId","value":"","description":"(Required) The ID of the deal containing the line item."},{"key":"id","value":"","description":"(Required) The ID of the line item to delete."}]}},"status":"Forbidden","code":403,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":null},{"id":"f659d334-77fb-449f-a2c3-bdb7c1ed605a","name":"Line item not found","originalRequest":{"method":"PATCH","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"productId\": \"\",\n \"partnerId\": \"\",\n \"quantity\": \"\",\n \"unitPrice\": \"\",\n \"suggestedPrice\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"//v3/deals/:dealId/line-items/:id","host":["/"],"path":["v3","deals",":dealId","line-items",":id"],"variable":[{"key":"dealId","value":"","description":"(Required) The ID of the deal containing the line item."},{"key":"id","value":"","description":"(Required) The ID of the line item to delete."}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":null}],"_postman_id":"0ab7e9a5-d0eb-4c5e-84bc-1f60dbd2ab4f"},{"name":"Delete line item","id":"bb774234-7ca3-4397-b1c7-f779b9e49ee6","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"key":"Accept","value":"application/json"}],"url":"//v3/deals/:dealId/line-items/:id","urlObject":{"path":["v3","deals",":dealId","line-items",":id"],"host":["/"],"query":[],"variable":[{"id":"51656bd2-91d5-4056-89df-ef2eb7b9f205","description":{"content":"

(Required) The ID of the deal containing the line item to delete.

\n","type":"text/plain"},"type":"any","value":"","key":"dealId"},{"id":"8e332034-b457-408c-855c-678500a35470","description":{"content":"

(Required) The ID of the line item to delete.

\n","type":"text/plain"},"type":"any","value":"","key":"id"}]}},"response":[{"id":"ad63c68b-a232-41c3-9533-00dd8d9a4f4e","name":"Line item deleted","originalRequest":{"method":"DELETE","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"//v3/deals/:dealId/line-items/:id","host":["/"],"path":["v3","deals",":dealId","line-items",":id"],"variable":[{"key":"dealId","value":"","description":"(Required) The ID of the deal containing the line item to delete."},{"key":"id","value":"","description":"(Required) The ID of the line item to delete."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"\",\n \"productId\": \"\",\n \"dealId\": \"\",\n \"unitPrice\": {\n \"value\": \"\",\n \"currency\": \"\"\n },\n \"price\": {\n \"value\": \"\",\n \"currency\": \"\"\n },\n \"suggestedPrice\": {\n \"value\": \"\",\n \"currency\": \"\"\n },\n \"quantity\": \"\",\n \"properties\": {\n \"key_0\": \"\"\n },\n \"creationDate\": \"\"\n}"},{"id":"8c6fca06-6119-4866-885b-270c1fe299a6","name":"You do not have access to this functionality in your current plan","originalRequest":{"method":"DELETE","header":[],"url":{"raw":"//v3/deals/:dealId/line-items/:id","host":["/"],"path":["v3","deals",":dealId","line-items",":id"],"variable":[{"key":"dealId","value":"","description":"(Required) The ID of the deal containing the line item to delete."},{"key":"id","value":"","description":"(Required) The ID of the line item to delete."}]}},"status":"Forbidden","code":403,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":null}],"_postman_id":"bb774234-7ca3-4397-b1c7-f779b9e49ee6"}],"id":"f598e6d9-31c0-48fb-93e1-f0b14268aa08","_postman_id":"f598e6d9-31c0-48fb-93e1-f0b14268aa08","description":""},{"name":"Notes","item":[{"name":"Create note","id":"18bdbde4-6202-4b5c-8d1e-4843bef048ca","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"content\": \"\",\n \"partnerId\": \"\",\n \"dealId\": \"\",\n \"leadId\": \"\",\n \"payoutId\": \"\",\n \"customerId\": \"\",\n \"isSynced\": \"\",\n \"taskName\": \"\",\n \"taskDueDate\": \"\",\n \"visibility\": \"Private\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"//v3/notes","description":"

Create a new note and assign it with an existing partner, leads, deal, customer or payout.\nThe content prop can be formatted using simple HTML formatting.

\n","urlObject":{"path":["v3","notes"],"host":["/"],"query":[],"variable":[]}},"response":[{"id":"a80cf5bd-37db-495c-bad2-eedcdf45fae9","name":"Note created","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"content\": \"\",\n \"partnerId\": \"\",\n \"dealId\": \"\",\n \"leadId\": \"\",\n \"payoutId\": \"\",\n \"customerId\": \"\",\n \"isSynced\": \"\",\n \"taskName\": \"\",\n \"taskDueDate\": \"\",\n \"visibility\": \"Private\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"//v3/notes"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"\",\n \"content\": \"\",\n \"creationDate\": \"\",\n \"createdByUser\": {\n \"id\": \"\",\n \"email\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\"\n },\n \"createdByPartnerId\": \"\",\n \"createdByPartnerName\": \"\",\n \"partnerId\": \"\",\n \"customerId\": \"\",\n \"dealId\": \"\",\n \"leadId\": \"\",\n \"payoutId\": \"\",\n \"visibility\": \"Private\"\n}"},{"id":"a46acd94-a610-4db6-99a3-e0557e8ccea4","name":"Invalid request","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"content\": \"\",\n \"partnerId\": \"\",\n \"dealId\": \"\",\n \"leadId\": \"\",\n \"payoutId\": \"\",\n \"customerId\": \"\",\n \"isSynced\": \"\",\n \"taskName\": \"\",\n \"taskDueDate\": \"\",\n \"visibility\": \"Private\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"//v3/notes"},"status":"Bad Request","code":400,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":null}],"_postman_id":"18bdbde4-6202-4b5c-8d1e-4843bef048ca"},{"name":"Get notes","id":"8702108d-26ab-4ce3-aaac-662a6617ea66","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"//v3/notes?dealId=&leadId=&partnerId=&payoutId=&customerId=&offset=&limit=&sort_by=&order_by=","description":"

Get all notes defined in your account

\n","urlObject":{"path":["v3","notes"],"host":["/"],"query":[{"description":{"content":"

A deal ID to filter the note on.

\n","type":"text/plain"},"key":"dealId","value":""},{"description":{"content":"

A lead ID to filter the note on.

\n","type":"text/plain"},"key":"leadId","value":""},{"description":{"content":"

A partner ID to filter the note on.

\n","type":"text/plain"},"key":"partnerId","value":""},{"description":{"content":"

A payout ID to filter the note on.

\n","type":"text/plain"},"key":"payoutId","value":""},{"description":{"content":"

A customer ID to filter the note on.

\n","type":"text/plain"},"key":"customerId","value":""},{"description":{"content":"

The cursor used in pagination. This is the index of the first note to be returned.

\n","type":"text/plain"},"key":"offset","value":""},{"description":{"content":"

The maximum number of notes to be returned. The default is 20.

\n","type":"text/plain"},"key":"limit","value":""},{"description":{"content":"

The property used to sort the notes by. The default is CreationDate.

\n","type":"text/plain"},"key":"sort_by","value":""},{"description":{"content":"

The sorting direction for the returned notes. Accepted values: ASC, DESC. The default is DESC.

\n","type":"text/plain"},"key":"order_by","value":""}],"variable":[]}},"response":[{"id":"51f482af-1abd-429d-8c8d-e5e33224816e","name":"Notes returned","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"//v3/notes?dealId=&leadId=&partnerId=&payoutId=&customerId=&offset=&limit=&sort_by=&order_by=","host":["/"],"path":["v3","notes"],"query":[{"description":"A deal ID to filter the note on.","key":"dealId","value":""},{"description":"A lead ID to filter the note on.","key":"leadId","value":""},{"description":"A partner ID to filter the note on.","key":"partnerId","value":""},{"description":"A payout ID to filter the note on.","key":"payoutId","value":""},{"description":"A customer ID to filter the note on.","key":"customerId","value":""},{"description":"The cursor used in pagination. This is the index of the first note to be returned.","key":"offset","value":""},{"description":"The maximum number of notes to be returned. The default is 20.","key":"limit","value":""},{"description":"The property used to sort the notes by. The default is CreationDate.","key":"sort_by","value":""},{"description":"The sorting direction for the returned notes. Accepted values: ASC, DESC. The default is DESC.","key":"order_by","value":""}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"items\": [\n {\n \"id\": \"\",\n \"content\": \"\",\n \"creationDate\": \"\",\n \"createdByUser\": {\n \"id\": \"\",\n \"email\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\"\n },\n \"createdByPartnerId\": \"\",\n \"createdByPartnerName\": \"\",\n \"partnerId\": \"\",\n \"customerId\": \"\",\n \"dealId\": \"\",\n \"leadId\": \"\",\n \"payoutId\": \"\",\n \"visibility\": \"Unknown\"\n },\n {\n \"id\": \"\",\n \"content\": \"\",\n \"creationDate\": \"\",\n \"createdByUser\": {\n \"id\": \"\",\n \"email\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\"\n },\n \"createdByPartnerId\": \"\",\n \"createdByPartnerName\": \"\",\n \"partnerId\": \"\",\n \"customerId\": \"\",\n \"dealId\": \"\",\n \"leadId\": \"\",\n \"payoutId\": \"\",\n \"visibility\": \"Private\"\n }\n ],\n \"paginationSkipCount\": \"\",\n \"totalCount\": \"\"\n}"}],"_postman_id":"8702108d-26ab-4ce3-aaac-662a6617ea66"}],"id":"d67a8ac5-c568-47f1-9722-a8339a144740","_postman_id":"d67a8ac5-c568-47f1-9722-a8339a144740","description":""},{"name":"Onboarding","item":[{"name":"Get partner onboarding stages","id":"bf26955b-2ff1-4214-a4c4-adf2af45f8b4","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"//v3/onboarding/stages","description":"

Get all partner onboarding stages.

\n","urlObject":{"path":["v3","onboarding","stages"],"host":["/"],"query":[],"variable":[]}},"response":[{"id":"fa84d589-86f5-4c28-a322-55c4b49ec99d","name":"Onboarding stages returned","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"//v3/onboarding/stages"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"id\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"order\": \"\",\n \"onboardingPipelineId\": \"\",\n \"onboardingPipelineName\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"order\": \"\",\n \"onboardingPipelineId\": \"\",\n \"onboardingPipelineName\": \"\"\n }\n]"}],"_postman_id":"bf26955b-2ff1-4214-a4c4-adf2af45f8b4"},{"name":"List onboarding stages for a given onboarding pipeline","id":"554cd587-7c72-4356-82b4-76782eb77ce7","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"//v3/onboarding/pipelines/:pipelineId/stages?pipeline_id=&offset=&limit=&sort_by=&order_by=&key_0=","urlObject":{"path":["v3","onboarding","pipelines",":pipelineId","stages"],"host":["/"],"query":[{"description":{"content":"

The ID of the onboarding pipeline you want to filter on.

\n","type":"text/plain"},"key":"pipeline_id","value":""},{"description":{"content":"

The cursor used in pagination. This is the index of the first lead to be returned.

\n","type":"text/plain"},"key":"offset","value":""},{"description":{"content":"

The maximum number of leads to be returned. The default is 20.

\n","type":"text/plain"},"key":"limit","value":""},{"description":{"content":"

The property used to sort the leads by. The default is Name.

\n","type":"text/plain"},"key":"sort_by","value":""},{"description":{"content":"

The sorting direction for the returned leads. Accepted values: ASC, DESC. The default is DESC.

\n","type":"text/plain"},"key":"order_by","value":""},{"key":"key_0","value":""}],"variable":[{"id":"e6d5454e-c411-4854-8b48-d93cb72590ba","description":{"content":"

(Required)

\n","type":"text/plain"},"type":"any","value":"","key":"pipelineId"}]}},"response":[{"id":"f6cdec27-0c7f-473a-995f-aa428b294dc9","name":"Onboarding stages returned","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"//v3/onboarding/pipelines/:pipelineId/stages?pipeline_id=&offset=&limit=&sort_by=&order_by=&key_0=","host":["/"],"path":["v3","onboarding","pipelines",":pipelineId","stages"],"query":[{"description":"The ID of the onboarding pipeline you want to filter on.","key":"pipeline_id","value":""},{"description":"The cursor used in pagination. This is the index of the first lead to be returned.","key":"offset","value":""},{"description":"The maximum number of leads to be returned. The default is 20.","key":"limit","value":""},{"description":"The property used to sort the leads by. The default is Name.","key":"sort_by","value":""},{"description":"The sorting direction for the returned leads. Accepted values: ASC, DESC. The default is DESC.","key":"order_by","value":""},{"key":"key_0","value":""}],"variable":[{"key":"pipelineId","value":"","description":"(Required) "}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"items\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"order\": \"\",\n \"onboardingPipelineId\": \"\",\n \"onboardingPipelineName\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"order\": \"\",\n \"onboardingPipelineId\": \"\",\n \"onboardingPipelineName\": \"\"\n }\n ],\n \"paginationSkipCount\": \"\",\n \"totalCount\": \"\"\n}"}],"_postman_id":"554cd587-7c72-4356-82b4-76782eb77ce7"},{"name":"List onboarding pipelines","id":"c76a27b3-5d2a-4474-93df-6fd1a303b6fc","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"//v3/onboarding/pipelines?partner_id=&offset=&limit=&sort_by=&order_by=&key_0=","urlObject":{"path":["v3","onboarding","pipelines"],"host":["/"],"query":[{"description":{"content":"

Only return onboarding pipelines available for the given partner ID.

\n","type":"text/plain"},"key":"partner_id","value":""},{"description":{"content":"

The cursor used in pagination. This is the index of the first onboarding pipeline to be returned.

\n","type":"text/plain"},"key":"offset","value":""},{"description":{"content":"

The maximum number of onboarding pipelines to be returned. The default is 20.

\n","type":"text/plain"},"key":"limit","value":""},{"description":{"content":"

The property used to sort the onboarding pipelines by. The default is Name.

\n","type":"text/plain"},"key":"sort_by","value":""},{"description":{"content":"

The sorting direction for the returned onboarding pipelines. Accepted values: ASC, DESC. The default is DESC.

\n","type":"text/plain"},"key":"order_by","value":""},{"key":"key_0","value":""}],"variable":[]}},"response":[{"id":"86af3fc0-75ef-479b-8bd8-244a799c5dcc","name":"Onboarding pipelines returned","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"//v3/onboarding/pipelines?partner_id=&offset=&limit=&sort_by=&order_by=&key_0=","host":["/"],"path":["v3","onboarding","pipelines"],"query":[{"description":"Only return onboarding pipelines available for the given partner ID.","key":"partner_id","value":""},{"description":"The cursor used in pagination. This is the index of the first onboarding pipeline to be returned.","key":"offset","value":""},{"description":"The maximum number of onboarding pipelines to be returned. The default is 20.","key":"limit","value":""},{"description":"The property used to sort the onboarding pipelines by. The default is Name.","key":"sort_by","value":""},{"description":"The sorting direction for the returned onboarding pipelines. Accepted values: ASC, DESC. The default is DESC.","key":"order_by","value":""},{"key":"key_0","value":""}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"items\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"isVisibleToPartners\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"isVisibleToPartners\": \"\"\n }\n ],\n \"paginationSkipCount\": \"\",\n \"totalCount\": \"\"\n}"}],"_postman_id":"c76a27b3-5d2a-4474-93df-6fd1a303b6fc"}],"id":"6fafede6-d5db-4091-84dc-36208d60763f","_postman_id":"6fafede6-d5db-4091-84dc-36208d60763f","description":""},{"name":"PartnerApplications","item":[{"name":"List partner applications","id":"00507f0e-b705-47f8-9b59-969e1b8a8992","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"//v3/partner-applications?status=Unknown&status=Accepted&partner_name=&partner_id=&partner_email=&offset=&limit=&sort_by=&order_by=","description":"

List partner applications and filter them.

\n","urlObject":{"path":["v3","partner-applications"],"host":["/"],"query":[{"description":{"content":"

The list of status to filter partner applications.

\n","type":"text/plain"},"key":"status","value":"Unknown"},{"description":{"content":"

The list of status to filter partner applications.

\n","type":"text/plain"},"key":"status","value":"Accepted"},{"description":{"content":"

Filter by partner name

\n","type":"text/plain"},"key":"partner_name","value":""},{"description":{"content":"

Filter by partner id

\n","type":"text/plain"},"key":"partner_id","value":""},{"description":{"content":"

Filter by partner email

\n","type":"text/plain"},"key":"partner_email","value":""},{"description":{"content":"

The cursor used in pagination. This is the index of the first transaction to be returned.

\n","type":"text/plain"},"key":"offset","value":""},{"description":{"content":"

The maximum number of transactions to be returned. The default is 20.

\n","type":"text/plain"},"key":"limit","value":""},{"description":{"content":"

The property used to sort partner applications by. The default is ApplicationDate.

\n","type":"text/plain"},"key":"sort_by","value":""},{"description":{"content":"

The sorting direction for the returned partner applications. Accepted values: ASC, DESC. The default is DESC.

\n","type":"text/plain"},"key":"order_by","value":""}],"variable":[]}},"response":[{"id":"5b6a02d3-c1f9-4770-8a99-d8886e03f52a","name":"Partner Applications returned","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"//v3/partner-applications?status=Accepted&partner_name=&partner_id=&partner_email=&offset=&limit=&sort_by=&order_by=","host":["/"],"path":["v3","partner-applications"],"query":[{"description":"The list of status to filter partner applications.","key":"status","value":"Accepted"},{"description":"Filter by partner name","key":"partner_name","value":""},{"description":"Filter by partner id","key":"partner_id","value":""},{"description":"Filter by partner email","key":"partner_email","value":""},{"description":"The cursor used in pagination. This is the index of the first transaction to be returned.","key":"offset","value":""},{"description":"The maximum number of transactions to be returned. The default is 20.","key":"limit","value":""},{"description":"The property used to sort partner applications by. The default is ApplicationDate.","key":"sort_by","value":""},{"description":"The sorting direction for the returned partner applications. Accepted values: ASC, DESC. The default is DESC.","key":"order_by","value":""}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"items\": [\n {\n \"id\": \"\",\n \"partnerId\": \"\",\n \"partnerProgramId\": \"\",\n \"partnerProgramLevelId\": \"\",\n \"status\": \"Pending\",\n \"applicationDate\": \"\",\n \"acceptedDate\": \"\",\n \"rejectedDate\": \"\",\n \"partnerName\": \"\",\n \"teamMemberEmail\": \"\"\n },\n {\n \"id\": \"\",\n \"partnerId\": \"\",\n \"partnerProgramId\": \"\",\n \"partnerProgramLevelId\": \"\",\n \"status\": \"Pending\",\n \"applicationDate\": \"\",\n \"acceptedDate\": \"\",\n \"rejectedDate\": \"\",\n \"partnerName\": \"\",\n \"teamMemberEmail\": \"\"\n }\n ]\n}"}],"_postman_id":"00507f0e-b705-47f8-9b59-969e1b8a8992"},{"name":"Get partner application","id":"d4ef76f5-fc4c-4d81-a858-7184cf7dc034","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"//v3/partner-applications/:id","urlObject":{"path":["v3","partner-applications",":id"],"host":["/"],"query":[],"variable":[{"id":"3feb4178-438b-4b5d-852e-1c98f6dc86e7","description":{"content":"

(Required)

\n","type":"text/plain"},"type":"any","value":"","key":"id"}]}},"response":[{"id":"26c499a8-454c-481d-9569-e91d592a75dd","name":"Partner Application returned","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"//v3/partner-applications/:id","host":["/"],"path":["v3","partner-applications",":id"],"variable":[{"key":"id","value":"","description":"(Required) "}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"\",\n \"partnerId\": \"\",\n \"partnerProgramId\": \"\",\n \"partnerProgramLevelId\": \"\",\n \"status\": \"Rejected\",\n \"applicationDate\": \"\",\n \"acceptedDate\": \"\",\n \"rejectedDate\": \"\",\n \"partnerName\": \"\",\n \"teamMemberEmail\": \"\"\n}"}],"_postman_id":"d4ef76f5-fc4c-4d81-a858-7184cf7dc034"},{"name":"Accept a pending Partner Application","id":"e47016b6-a90d-4b47-b708-213e7015e67c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"partnerApplicationId\": \"\",\n \"createAccount\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"//v3/partner-applications/:id/accept","urlObject":{"path":["v3","partner-applications",":id","accept"],"host":["/"],"query":[],"variable":[{"id":"a43457d2-6e94-4b6b-ac50-52f2df90e529","description":{"content":"

(Required)

\n","type":"text/plain"},"type":"any","value":"","key":"id"}]}},"response":[{"id":"38ddfd53-3e09-4507-a06b-e712870985b4","name":"Partner Application returned","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"partnerApplicationId\": \"\",\n \"createAccount\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"//v3/partner-applications/:id/accept","host":["/"],"path":["v3","partner-applications",":id","accept"],"variable":[{"key":"id","value":"","description":"(Required) "}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"\",\n \"partnerId\": \"\",\n \"partnerProgramId\": \"\",\n \"partnerProgramLevelId\": \"\",\n \"status\": \"Rejected\",\n \"applicationDate\": \"\",\n \"acceptedDate\": \"\",\n \"rejectedDate\": \"\",\n \"partnerName\": \"\",\n \"teamMemberEmail\": \"\"\n}"}],"_postman_id":"e47016b6-a90d-4b47-b708-213e7015e67c"},{"name":"Reject a pending Partner Application","id":"332640a2-74b6-438d-b973-e43ad2eedbc5","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Accept","value":"application/json"}],"url":"//v3/partner-applications/:id/reject","urlObject":{"path":["v3","partner-applications",":id","reject"],"host":["/"],"query":[],"variable":[{"id":"69b769ba-b54d-4d8d-9bd1-e968e67ab72b","description":{"content":"

(Required)

\n","type":"text/plain"},"type":"any","value":"","key":"id"}]}},"response":[{"id":"6d5742da-2267-4e23-a90e-b9505750c19a","name":"Partner Application returned","originalRequest":{"method":"POST","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"//v3/partner-applications/:id/reject","host":["/"],"path":["v3","partner-applications",":id","reject"],"variable":[{"key":"id","value":"","description":"(Required) "}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"\",\n \"partnerId\": \"\",\n \"partnerProgramId\": \"\",\n \"partnerProgramLevelId\": \"\",\n \"status\": \"Rejected\",\n \"applicationDate\": \"\",\n \"acceptedDate\": \"\",\n \"rejectedDate\": \"\",\n \"partnerName\": \"\",\n \"teamMemberEmail\": \"\"\n}"}],"_postman_id":"332640a2-74b6-438d-b973-e43ad2eedbc5"}],"id":"62b99152-8d24-4f09-899c-b67c35af99a9","_postman_id":"62b99152-8d24-4f09-899c-b67c35af99a9","description":""},{"name":"PartnerContactCertifications","item":[{"name":"List certifications given to partner contacts.","id":"e737fa92-7b7a-4a05-ad98-ab2ddd3cb7b1","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"//v3/partner-contact-certifications?partner_id=&partner_contact_id=&certification_id=&status=Renewed&status=Unknown&offset=&limit=&sort_by=&order_by=&email=","description":"

List the certifications for all partners, all partner contacts of one given partner of just one partner contact only.

\n","urlObject":{"path":["v3","partner-contact-certifications"],"host":["/"],"query":[{"description":{"content":"

The specific partner for which certifications must be returned.

\n","type":"text/plain"},"key":"partner_id","value":""},{"description":{"content":"

The specific partner contact (team members) for which certifications must be returned.

\n","type":"text/plain"},"key":"partner_contact_id","value":""},{"description":{"content":"

The specific certification for which all partner contacts must be returned.

\n","type":"text/plain"},"key":"certification_id","value":""},{"description":{"content":"

Only returned certifications given to partner contacts with the specific status.

\n","type":"text/plain"},"key":"status","value":"Renewed"},{"description":{"content":"

Only returned certifications given to partner contacts with the specific status.

\n","type":"text/plain"},"key":"status","value":"Unknown"},{"description":{"content":"

The cursor used in pagination. This is the index of the first partner contact to be returned.

\n","type":"text/plain"},"key":"offset","value":""},{"description":{"content":"

The maximum number of partner contacts to be returned. The default is 20.

\n","type":"text/plain"},"key":"limit","value":""},{"description":{"content":"

The property used to sort the partner contacts by. The default is CreationDate.

\n","type":"text/plain"},"key":"sort_by","value":""},{"description":{"content":"

The sorting direction for the returned partner contacts. Accepted values: ASC, DESC. The default is DESC.

\n","type":"text/plain"},"key":"order_by","value":""},{"description":{"content":"

The exact email address of the partner contact for which certifications must be returned.

\n","type":"text/plain"},"key":"email","value":""}],"variable":[]}},"response":[{"id":"3991bd0a-d94c-4386-8e6b-06414120ae90","name":"Partner certifications returned","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"//v3/partner-contact-certifications?partner_id=&partner_contact_id=&certification_id=&status=Unknown&offset=&limit=&sort_by=&order_by=&email=","host":["/"],"path":["v3","partner-contact-certifications"],"query":[{"description":"The specific partner for which certifications must be returned.","key":"partner_id","value":""},{"description":"The specific partner contact (team members) for which certifications must be returned.","key":"partner_contact_id","value":""},{"description":"The specific certification for which all partner contacts must be returned.","key":"certification_id","value":""},{"description":"Only returned certifications given to partner contacts with the specific status.","key":"status","value":"Unknown"},{"description":"The cursor used in pagination. This is the index of the first partner contact to be returned.","key":"offset","value":""},{"description":"The maximum number of partner contacts to be returned. The default is 20.","key":"limit","value":""},{"description":"The property used to sort the partner contacts by. The default is CreationDate.","key":"sort_by","value":""},{"description":"The sorting direction for the returned partner contacts. Accepted values: ASC, DESC. The default is DESC.","key":"order_by","value":""},{"description":"The exact email address of the partner contact for which certifications must be returned.","key":"email","value":""}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"items\": [\n {\n \"id\": \"\",\n \"creationDate\": \"\",\n \"acquisitionDate\": \"\",\n \"expirationDate\": \"\",\n \"status\": \"Renewed\",\n \"partnerContactId\": \"\",\n \"certificationId\": \"\"\n },\n {\n \"id\": \"\",\n \"creationDate\": \"\",\n \"acquisitionDate\": \"\",\n \"expirationDate\": \"\",\n \"status\": \"Expired\",\n \"partnerContactId\": \"\",\n \"certificationId\": \"\"\n }\n ],\n \"paginationSkipCount\": \"\",\n \"totalCount\": \"\"\n}"}],"_postman_id":"e737fa92-7b7a-4a05-ad98-ab2ddd3cb7b1"},{"name":"Give a certification to a partner team member","id":"a870be00-df15-4952-af66-afc33e6ab100","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"certificationId\": \"\",\n \"partnerContactId\": \"\",\n \"status\": \"Expired\",\n \"acquisitionDate\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"//v3/partner-contact-certifications","description":"

Associate a certification to a partner team member

\n","urlObject":{"path":["v3","partner-contact-certifications"],"host":["/"],"query":[],"variable":[]}},"response":[{"id":"d41ae4b9-0a61-46ac-8731-4f13b687cebc","name":"Certifications given to the specified partner team member","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"certificationId\": \"\",\n \"partnerContactId\": \"\",\n \"status\": \"Expired\",\n \"acquisitionDate\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"//v3/partner-contact-certifications"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"\",\n \"creationDate\": \"\",\n \"acquisitionDate\": \"\",\n \"expirationDate\": \"\",\n \"status\": \"Unknown\",\n \"partnerContactId\": \"\",\n \"certificationId\": \"\"\n}"}],"_postman_id":"a870be00-df15-4952-af66-afc33e6ab100"}],"id":"20e116fa-c6a8-4f63-ac72-5650f02fc305","_postman_id":"20e116fa-c6a8-4f63-ac72-5650f02fc305","description":""},{"name":"PartnerContacts","item":[{"name":"List partner contacts","id":"c6165dc6-b609-42f6-aea6-399f673b8e7d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"//v3/partner_contacts?partner_id=&level_id=&level_id=&offset=&limit=&sort_by=&order_by=&email=","description":"

List the contacts for all partners and filter them by partner or email.

\n","urlObject":{"path":["v3","partner_contacts"],"host":["/"],"query":[{"description":{"content":"

The specific partner for which contacts must be returned.

\n","type":"text/plain"},"key":"partner_id","value":""},{"description":{"content":"

The specific program level for which contacts must be returned.

\n","type":"text/plain"},"key":"level_id","value":""},{"description":{"content":"

The specific program level for which contacts must be returned.

\n","type":"text/plain"},"key":"level_id","value":""},{"description":{"content":"

The cursor used in pagination. This is the index of the first partner contact to be returned.

\n","type":"text/plain"},"key":"offset","value":""},{"description":{"content":"

The maximum number of partner contacts to be returned. The default is 20.

\n","type":"text/plain"},"key":"limit","value":""},{"description":{"content":"

The property used to sort the partner contacts by. The default is CreationDate.

\n","type":"text/plain"},"key":"sort_by","value":""},{"description":{"content":"

The sorting direction for the returned partner contacts. Accepted values: ASC, DESC. The default is DESC.

\n","type":"text/plain"},"key":"order_by","value":""},{"description":{"content":"

The exact email of the partner contact to return.

\n","type":"text/plain"},"key":"email","value":""}],"variable":[]}},"response":[{"id":"463a78d3-0b35-4d24-ac59-940d6fb490dd","name":"Partner contacts returned","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"//v3/partner_contacts?partner_id=&level_id=&offset=&limit=&sort_by=&order_by=&email=","host":["/"],"path":["v3","partner_contacts"],"query":[{"description":"The specific partner for which contacts must be returned.","key":"partner_id","value":""},{"description":"The specific program level for which contacts must be returned.","key":"level_id","value":""},{"description":"The cursor used in pagination. This is the index of the first partner contact to be returned.","key":"offset","value":""},{"description":"The maximum number of partner contacts to be returned. The default is 20.","key":"limit","value":""},{"description":"The property used to sort the partner contacts by. The default is CreationDate.","key":"sort_by","value":""},{"description":"The sorting direction for the returned partner contacts. Accepted values: ASC, DESC. The default is DESC.","key":"order_by","value":""},{"description":"The exact email of the partner contact to return.","key":"email","value":""}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"items\": [\n {\n \"id\": \"\",\n \"email\": \"\",\n \"firstname\": \"\",\n \"lastname\": \"\",\n \"creationDate\": \"\",\n \"isMainContact\": \"\",\n \"partnerId\": \"\",\n \"userId\": \"\"\n },\n {\n \"id\": \"\",\n \"email\": \"\",\n \"firstname\": \"\",\n \"lastname\": \"\",\n \"creationDate\": \"\",\n \"isMainContact\": \"\",\n \"partnerId\": \"\",\n \"userId\": \"\"\n }\n ],\n \"paginationSkipCount\": \"\",\n \"totalCount\": \"\"\n}"}],"_postman_id":"c6165dc6-b609-42f6-aea6-399f673b8e7d"},{"name":"List partner contacts","id":"28901fd1-0671-43dc-bdf9-bde47d0e7eb5","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"//v3/partner-contacts?partner_id=&level_id=&level_id=&offset=&limit=&sort_by=&order_by=&email=","description":"

List the contacts for all partners and filter them by partner or email.

\n","urlObject":{"path":["v3","partner-contacts"],"host":["/"],"query":[{"description":{"content":"

The specific partner for which contacts must be returned.

\n","type":"text/plain"},"key":"partner_id","value":""},{"description":{"content":"

The specific program level for which contacts must be returned.

\n","type":"text/plain"},"key":"level_id","value":""},{"description":{"content":"

The specific program level for which contacts must be returned.

\n","type":"text/plain"},"key":"level_id","value":""},{"description":{"content":"

The cursor used in pagination. This is the index of the first partner contact to be returned.

\n","type":"text/plain"},"key":"offset","value":""},{"description":{"content":"

The maximum number of partner contacts to be returned. The default is 20.

\n","type":"text/plain"},"key":"limit","value":""},{"description":{"content":"

The property used to sort the partner contacts by. The default is CreationDate.

\n","type":"text/plain"},"key":"sort_by","value":""},{"description":{"content":"

The sorting direction for the returned partner contacts. Accepted values: ASC, DESC. The default is DESC.

\n","type":"text/plain"},"key":"order_by","value":""},{"description":{"content":"

The exact email of the partner contact to return.

\n","type":"text/plain"},"key":"email","value":""}],"variable":[]}},"response":[{"id":"2f1a7d80-8c8b-40bc-80e2-a0a3cbcf159c","name":"Partner contacts returned","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"//v3/partner-contacts?partner_id=&level_id=&offset=&limit=&sort_by=&order_by=&email=","host":["/"],"path":["v3","partner-contacts"],"query":[{"description":"The specific partner for which contacts must be returned.","key":"partner_id","value":""},{"description":"The specific program level for which contacts must be returned.","key":"level_id","value":""},{"description":"The cursor used in pagination. This is the index of the first partner contact to be returned.","key":"offset","value":""},{"description":"The maximum number of partner contacts to be returned. The default is 20.","key":"limit","value":""},{"description":"The property used to sort the partner contacts by. The default is CreationDate.","key":"sort_by","value":""},{"description":"The sorting direction for the returned partner contacts. Accepted values: ASC, DESC. The default is DESC.","key":"order_by","value":""},{"description":"The exact email of the partner contact to return.","key":"email","value":""}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"items\": [\n {\n \"id\": \"\",\n \"email\": \"\",\n \"firstname\": \"\",\n \"lastname\": \"\",\n \"creationDate\": \"\",\n \"isMainContact\": \"\",\n \"partnerId\": \"\",\n \"userId\": \"\"\n },\n {\n \"id\": \"\",\n \"email\": \"\",\n \"firstname\": \"\",\n \"lastname\": \"\",\n \"creationDate\": \"\",\n \"isMainContact\": \"\",\n \"partnerId\": \"\",\n \"userId\": \"\"\n }\n ],\n \"paginationSkipCount\": \"\",\n \"totalCount\": \"\"\n}"}],"_postman_id":"28901fd1-0671-43dc-bdf9-bde47d0e7eb5"},{"name":"Send invitation email to join the partner portal.","id":"db07d2f6-cc55-446b-8ba1-aac6c6ec96e2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"partnerContactId\": \"\",\n \"emailTemplateId\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"//v3/partner_contacts/:partnerContactId/invite","description":"

It only sends the email if the team member was not already invited to the partner portal.

\n","urlObject":{"path":["v3","partner_contacts",":partnerContactId","invite"],"host":["/"],"query":[],"variable":[{"id":"853cee64-c075-4dc1-a716-31139f576a18","description":{"content":"

(Required)

\n","type":"text/plain"},"type":"any","value":"","key":"partnerContactId"}]}},"response":[{"id":"f7c6513e-8cfc-4ac2-8f8b-4bf74122af8d","name":"Partner contact returned","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"partnerContactId\": \"\",\n \"emailTemplateId\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"//v3/partner_contacts/:partnerContactId/invite","host":["/"],"path":["v3","partner_contacts",":partnerContactId","invite"],"variable":[{"key":"partnerContactId","value":"","description":"(Required) "}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"partnerContact\": {\n \"id\": \"\",\n \"email\": \"\",\n \"firstname\": \"\",\n \"lastname\": \"\",\n \"creationDate\": \"\",\n \"isMainContact\": \"\",\n \"partnerId\": \"\",\n \"userId\": \"\"\n },\n \"invitationUrl\": \"\"\n}"}],"_postman_id":"db07d2f6-cc55-446b-8ba1-aac6c6ec96e2"},{"name":"Send invitation email to join the partner portal.","id":"b5e26da3-2ba1-405a-ae58-d7e9db7f81cc","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"partnerContactId\": \"\",\n \"emailTemplateId\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"//v3/partner-contacts/:partnerContactId/invite","description":"

It only sends the email if the team member was not already invited to the partner portal.

\n","urlObject":{"path":["v3","partner-contacts",":partnerContactId","invite"],"host":["/"],"query":[],"variable":[{"id":"a42fbd79-2c53-4788-ac0f-2b0d762c8cb6","description":{"content":"

(Required)

\n","type":"text/plain"},"type":"any","value":"","key":"partnerContactId"}]}},"response":[{"id":"af2a7245-eb50-43c2-b538-a8882b9bcab8","name":"Partner contact returned","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"partnerContactId\": \"\",\n \"emailTemplateId\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"//v3/partner-contacts/:partnerContactId/invite","host":["/"],"path":["v3","partner-contacts",":partnerContactId","invite"],"variable":[{"key":"partnerContactId","value":"","description":"(Required) "}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"partnerContact\": {\n \"id\": \"\",\n \"email\": \"\",\n \"firstname\": \"\",\n \"lastname\": \"\",\n \"creationDate\": \"\",\n \"isMainContact\": \"\",\n \"partnerId\": \"\",\n \"userId\": \"\"\n },\n \"invitationUrl\": \"\"\n}"}],"_postman_id":"b5e26da3-2ba1-405a-ae58-d7e9db7f81cc"}],"id":"96c39bc7-b73d-4f55-a5cd-85228bb8fe10","_postman_id":"96c39bc7-b73d-4f55-a5cd-85228bb8fe10","description":""},{"name":"PartnerProperties","item":[{"name":"List partner properties","id":"51693558-eb1d-4e61-903c-396d8b1bb341","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"//v3/partners/properties","description":"

List all custom properties defined on partner object.
You can customize the partner properties from your account's settings page.

\n","urlObject":{"path":["v3","partners","properties"],"host":["/"],"query":[],"variable":[]}},"response":[{"id":"53088274-68de-450a-aec9-b92530f12bdc","name":"Success","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"//v3/partners/properties"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"id\": \"\",\n \"entityType\": \"PartnerDirectory\",\n \"propertyType\": \"Currency\",\n \"name\": \"\",\n \"label\": \"\",\n \"placeholder\": \"\",\n \"description\": \"\",\n \"isRequired\": \"\",\n \"isVisible\": \"\",\n \"isPartnerEditable\": \"\",\n \"isCustom\": \"\",\n \"isReadOnly\": \"\",\n \"displayOrder\": \"\",\n \"isDealAmountPart\": \"\",\n \"canEditDescription\": \"\",\n \"canEditIsRequired\": \"\",\n \"dropdownConfiguration\": {\n \"options\": [\n {\n \"label\": \"\",\n \"originalValue\": \"\",\n \"value\": \"\"\n },\n {\n \"label\": \"\",\n \"originalValue\": \"\",\n \"value\": \"\"\n }\n ]\n }\n },\n {\n \"id\": \"\",\n \"entityType\": \"View\",\n \"propertyType\": \"Number\",\n \"name\": \"\",\n \"label\": \"\",\n \"placeholder\": \"\",\n \"description\": \"\",\n \"isRequired\": \"\",\n \"isVisible\": \"\",\n \"isPartnerEditable\": \"\",\n \"isCustom\": \"\",\n \"isReadOnly\": \"\",\n \"displayOrder\": \"\",\n \"isDealAmountPart\": \"\",\n \"canEditDescription\": \"\",\n \"canEditIsRequired\": \"\",\n \"dropdownConfiguration\": {\n \"options\": [\n {\n \"label\": \"\",\n \"originalValue\": \"\",\n \"value\": \"\"\n },\n {\n \"label\": \"\",\n \"originalValue\": \"\",\n \"value\": \"\"\n }\n ]\n }\n }\n]"}],"_postman_id":"51693558-eb1d-4e61-903c-396d8b1bb341"}],"id":"3dbefd45-42ed-4454-be4e-a51236496400","_postman_id":"3dbefd45-42ed-4454-be4e-a51236496400","description":""},{"name":"Partners","item":[{"name":"Create partner","id":"d105edc6-a33d-4c56-84c9-1a2458dbd8ef","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"name\": \"\",\n \"properties\": {\n \"key_0\": \"\"\n },\n \"status\": \"Onboarding\",\n \"source\": \"SignupForm\",\n \"mainContact\": {\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"email\": \"\",\n \"jobTitle\": \"\",\n \"phoneNumber\": \"\",\n \"linkedInProfileUrl\": \"\",\n \"createAccount\": \"\",\n \"sendInvitationEmail\": \"\"\n },\n \"groupId\": \"\",\n \"programLevelId\": \"\",\n \"onboardingStageId\": \"\",\n \"partnerTypeId\": \"\",\n \"payoutProvider\": {\n \"type\": \"Paypal\",\n \"details\": {}\n },\n \"paypalEmail\": \"\",\n \"currency\": \"\",\n \"language\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"//v3/partners","description":"

Create a new partner.

\n","urlObject":{"path":["v3","partners"],"host":["/"],"query":[],"variable":[]}},"response":[{"id":"21f9f443-4c2d-44e3-a0b3-604efd90ea3c","name":"Partner created","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"name\": \"\",\n \"properties\": {\n \"key_0\": \"\"\n },\n \"status\": \"Onboarding\",\n \"source\": \"SignupForm\",\n \"mainContact\": {\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"email\": \"\",\n \"jobTitle\": \"\",\n \"phoneNumber\": \"\",\n \"linkedInProfileUrl\": \"\",\n \"createAccount\": \"\",\n \"sendInvitationEmail\": \"\"\n },\n \"groupId\": \"\",\n \"programLevelId\": \"\",\n \"onboardingStageId\": \"\",\n \"partnerTypeId\": \"\",\n \"payoutProvider\": {\n \"type\": \"Paypal\",\n \"details\": {}\n },\n \"paypalEmail\": \"\",\n \"currency\": \"\",\n \"language\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"//v3/partners"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"\",\n \"name\": \"\",\n \"groupId\": \"\",\n \"onboardingStatus\": \"Unknown\",\n \"status\": \"Unknown\",\n \"source\": \"SignupForm\",\n \"company\": {\n \"id\": \"\",\n \"name\": \"\",\n \"websiteUrls\": [\n \"\",\n \"\"\n ]\n },\n \"mainContact\": {\n \"id\": \"\",\n \"email\": \"\",\n \"firstname\": \"\",\n \"lastname\": \"\",\n \"jobTitle\": \"\",\n \"phoneNumber\": \"\",\n \"linkedInProfileUrl\": \"\",\n \"creationDate\": \"\",\n \"isMainContact\": \"\"\n },\n \"onboardingStage\": {\n \"id\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"order\": \"\",\n \"onboardingPipelineId\": \"\",\n \"onboardingPipelineName\": \"\"\n },\n \"onboardingStages\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"order\": \"\",\n \"onboardingPipelineId\": \"\",\n \"onboardingPipelineName\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"order\": \"\",\n \"onboardingPipelineId\": \"\",\n \"onboardingPipelineName\": \"\"\n }\n ],\n \"levels\": [\n {\n \"programLevelId\": \"\",\n \"programLevelName\": \"\",\n \"programId\": \"\",\n \"programName\": \"\"\n },\n {\n \"programLevelId\": \"\",\n \"programLevelName\": \"\",\n \"programId\": \"\",\n \"programName\": \"\"\n }\n ],\n \"sinceDate\": \"\",\n \"partnerTypeId\": \"\",\n \"partnerTypeName\": \"\",\n \"properties\": {\n \"key_0\": \"\"\n },\n \"ownerUserId\": \"\",\n \"owner\": {\n \"id\": \"\",\n \"email\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\"\n },\n \"referralCode\": \"\",\n \"paypalEmail\": \"\",\n \"currency\": \"\",\n \"payoutProvider\": {\n \"type\": \"Payoneer\",\n \"details\": {}\n },\n \"language\": \"\"\n}"},{"id":"d7a51a65-353c-4cea-9ea2-3253346c0e1c","name":"Invalid request","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"name\": \"\",\n \"properties\": {\n \"key_0\": \"\"\n },\n \"status\": \"Onboarding\",\n \"source\": \"SignupForm\",\n \"mainContact\": {\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"email\": \"\",\n \"jobTitle\": \"\",\n \"phoneNumber\": \"\",\n \"linkedInProfileUrl\": \"\",\n \"createAccount\": \"\",\n \"sendInvitationEmail\": \"\"\n },\n \"groupId\": \"\",\n \"programLevelId\": \"\",\n \"onboardingStageId\": \"\",\n \"partnerTypeId\": \"\",\n \"payoutProvider\": {\n \"type\": \"Paypal\",\n \"details\": {}\n },\n \"paypalEmail\": \"\",\n \"currency\": \"\",\n \"language\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"//v3/partners"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"errorCode\": \"\",\n \"errorMessage\": \"\"\n}"}],"_postman_id":"d105edc6-a33d-4c56-84c9-1a2458dbd8ef"},{"name":"List partners","id":"e795054f-254d-463c-a2e9-80a7365326ed","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"//v3/partners?name=&email=&referral_code=&offset=&limit=&sort_by=&order_by=","description":"

List partners and filter them by name, email or any custom properties.

\n

To filter partners on custom property, just add the property with its exact value as a query parameter: myCustomProp=ThisIsAValue
This will return the partners where myCustomProp exactly matches the provided value.

\n","urlObject":{"path":["v3","partners"],"host":["/"],"query":[{"description":{"content":"

The exact name of the partner.

\n","type":"text/plain"},"key":"name","value":""},{"description":{"content":"

The email of one of the team member used to search the partner.

\n","type":"text/plain"},"key":"email","value":""},{"description":{"content":"

The exact referral code of the partner.

\n","type":"text/plain"},"key":"referral_code","value":""},{"description":{"content":"

The cursor used in pagination. This is the index of the first lead to be returned.

\n","type":"text/plain"},"key":"offset","value":""},{"description":{"content":"

The maximum number of leads to be returned. The default is 20.

\n","type":"text/plain"},"key":"limit","value":""},{"description":{"content":"

The property used to sort the leads by. The default is CreationDate.

\n","type":"text/plain"},"key":"sort_by","value":""},{"description":{"content":"

The sorting direction for the returned leads. Accepted values: ASC, DESC. The default is DESC.

\n","type":"text/plain"},"key":"order_by","value":""}],"variable":[]}},"response":[{"id":"42738b9d-baaa-4177-aa7c-488cf8cd9368","name":"Partners returned","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"//v3/partners?name=&email=&referral_code=&offset=&limit=&sort_by=&order_by=","host":["/"],"path":["v3","partners"],"query":[{"description":"The exact name of the partner.","key":"name","value":""},{"description":"The email of one of the team member used to search the partner.","key":"email","value":""},{"description":"The exact referral code of the partner.","key":"referral_code","value":""},{"description":"The cursor used in pagination. This is the index of the first lead to be returned.","key":"offset","value":""},{"description":"The maximum number of leads to be returned. The default is 20.","key":"limit","value":""},{"description":"The property used to sort the leads by. The default is CreationDate.","key":"sort_by","value":""},{"description":"The sorting direction for the returned leads. Accepted values: ASC, DESC. The default is DESC.","key":"order_by","value":""}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"items\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"groupId\": \"\",\n \"onboardingStatus\": \"Completed\",\n \"status\": \"Prospect\",\n \"source\": \"Unknown\",\n \"company\": {\n \"id\": \"\",\n \"name\": \"\",\n \"websiteUrls\": [\n \"\",\n \"\"\n ]\n },\n \"mainContact\": {\n \"id\": \"\",\n \"email\": \"\",\n \"firstname\": \"\",\n \"lastname\": \"\",\n \"jobTitle\": \"\",\n \"phoneNumber\": \"\",\n \"linkedInProfileUrl\": \"\",\n \"creationDate\": \"\",\n \"isMainContact\": \"\"\n },\n \"onboardingStage\": {\n \"id\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"order\": \"\",\n \"onboardingPipelineId\": \"\",\n \"onboardingPipelineName\": \"\"\n },\n \"onboardingStages\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"order\": \"\",\n \"onboardingPipelineId\": \"\",\n \"onboardingPipelineName\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"order\": \"\",\n \"onboardingPipelineId\": \"\",\n \"onboardingPipelineName\": \"\"\n }\n ],\n \"levels\": [\n {\n \"programLevelId\": \"\",\n \"programLevelName\": \"\",\n \"programId\": \"\",\n \"programName\": \"\"\n },\n {\n \"programLevelId\": \"\",\n \"programLevelName\": \"\",\n \"programId\": \"\",\n \"programName\": \"\"\n }\n ],\n \"sinceDate\": \"\",\n \"partnerTypeId\": \"\",\n \"partnerTypeName\": \"\",\n \"properties\": {\n \"key_0\": \"\"\n },\n \"ownerUserId\": \"\",\n \"owner\": {\n \"id\": \"\",\n \"email\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\"\n },\n \"referralCode\": \"\",\n \"paypalEmail\": \"\",\n \"currency\": \"\",\n \"payoutProvider\": {\n \"type\": \"Payoneer\",\n \"details\": {}\n },\n \"language\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"groupId\": \"\",\n \"onboardingStatus\": \"InProgress\",\n \"status\": \"Inactive\",\n \"source\": \"SignupForm\",\n \"company\": {\n \"id\": \"\",\n \"name\": \"\",\n \"websiteUrls\": [\n \"\",\n \"\"\n ]\n },\n \"mainContact\": {\n \"id\": \"\",\n \"email\": \"\",\n \"firstname\": \"\",\n \"lastname\": \"\",\n \"jobTitle\": \"\",\n \"phoneNumber\": \"\",\n \"linkedInProfileUrl\": \"\",\n \"creationDate\": \"\",\n \"isMainContact\": \"\"\n },\n \"onboardingStage\": {\n \"id\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"order\": \"\",\n \"onboardingPipelineId\": \"\",\n \"onboardingPipelineName\": \"\"\n },\n \"onboardingStages\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"order\": \"\",\n \"onboardingPipelineId\": \"\",\n \"onboardingPipelineName\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"order\": \"\",\n \"onboardingPipelineId\": \"\",\n \"onboardingPipelineName\": \"\"\n }\n ],\n \"levels\": [\n {\n \"programLevelId\": \"\",\n \"programLevelName\": \"\",\n \"programId\": \"\",\n \"programName\": \"\"\n },\n {\n \"programLevelId\": \"\",\n \"programLevelName\": \"\",\n \"programId\": \"\",\n \"programName\": \"\"\n }\n ],\n \"sinceDate\": \"\",\n \"partnerTypeId\": \"\",\n \"partnerTypeName\": \"\",\n \"properties\": {\n \"key_0\": \"\"\n },\n \"ownerUserId\": \"\",\n \"owner\": {\n \"id\": \"\",\n \"email\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\"\n },\n \"referralCode\": \"\",\n \"paypalEmail\": \"\",\n \"currency\": \"\",\n \"payoutProvider\": {\n \"type\": \"Chargebee\",\n \"details\": {}\n },\n \"language\": \"\"\n }\n ],\n \"paginationSkipCount\": \"\",\n \"totalCount\": \"\"\n}"}],"_postman_id":"e795054f-254d-463c-a2e9-80a7365326ed"},{"name":"Update partner","id":"4e91dfff-0679-45d6-bc46-d119bc7063e7","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PATCH","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"id\": \"\",\n \"name\": \"\",\n \"status\": \"Rejected\",\n \"onboardingStageId\": \"\",\n \"onboardingStageIds\": [\n \"\",\n \"\"\n ],\n \"programLevelIds\": [\n \"\",\n \"\"\n ],\n \"properties\": {\n \"key_0\": \"\"\n },\n \"currency\": \"\",\n \"groupId\": \"\",\n \"ownerUserId\": \"\",\n \"sinceDate\": \"\",\n \"referralCode\": \"\",\n \"payoutProvider\": {\n \"type\": \"Payoneer\",\n \"details\": {}\n },\n \"paypalEmail\": \"\",\n \"language\": \"\",\n \"prospectionStage\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"//v3/partners/:id","description":"

You can only specify properties to update in the properties field as this method will PATCH the existing partner.\nProperties not found in the properties field will not be modified.

\n","urlObject":{"path":["v3","partners",":id"],"host":["/"],"query":[],"variable":[{"id":"8895cc35-4575-4a5f-a895-429148b957a7","description":{"content":"

(Required) The ID of the partner to update.

\n","type":"text/plain"},"type":"any","value":"","key":"id"}]}},"response":[{"id":"1b003199-eeb5-4ed4-93e2-0f855eb23e3d","name":"Partner updated","originalRequest":{"method":"PATCH","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"id\": \"\",\n \"name\": \"\",\n \"status\": \"Rejected\",\n \"onboardingStageId\": \"\",\n \"onboardingStageIds\": [\n \"\",\n \"\"\n ],\n \"programLevelIds\": [\n \"\",\n \"\"\n ],\n \"properties\": {\n \"key_0\": \"\"\n },\n \"currency\": \"\",\n \"groupId\": \"\",\n \"ownerUserId\": \"\",\n \"sinceDate\": \"\",\n \"referralCode\": \"\",\n \"payoutProvider\": {\n \"type\": \"Payoneer\",\n \"details\": {}\n },\n \"paypalEmail\": \"\",\n \"language\": \"\",\n \"prospectionStage\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"//v3/partners/:id","host":["/"],"path":["v3","partners",":id"],"variable":[{"key":"id","value":"","description":"(Required) The ID of the partner to update."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"\",\n \"name\": \"\",\n \"groupId\": \"\",\n \"onboardingStatus\": \"Unknown\",\n \"status\": \"Unknown\",\n \"source\": \"SignupForm\",\n \"company\": {\n \"id\": \"\",\n \"name\": \"\",\n \"websiteUrls\": [\n \"\",\n \"\"\n ]\n },\n \"mainContact\": {\n \"id\": \"\",\n \"email\": \"\",\n \"firstname\": \"\",\n \"lastname\": \"\",\n \"jobTitle\": \"\",\n \"phoneNumber\": \"\",\n \"linkedInProfileUrl\": \"\",\n \"creationDate\": \"\",\n \"isMainContact\": \"\"\n },\n \"onboardingStage\": {\n \"id\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"order\": \"\",\n \"onboardingPipelineId\": \"\",\n \"onboardingPipelineName\": \"\"\n },\n \"onboardingStages\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"order\": \"\",\n \"onboardingPipelineId\": \"\",\n \"onboardingPipelineName\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"order\": \"\",\n \"onboardingPipelineId\": \"\",\n \"onboardingPipelineName\": \"\"\n }\n ],\n \"levels\": [\n {\n \"programLevelId\": \"\",\n \"programLevelName\": \"\",\n \"programId\": \"\",\n \"programName\": \"\"\n },\n {\n \"programLevelId\": \"\",\n \"programLevelName\": \"\",\n \"programId\": \"\",\n \"programName\": \"\"\n }\n ],\n \"sinceDate\": \"\",\n \"partnerTypeId\": \"\",\n \"partnerTypeName\": \"\",\n \"properties\": {\n \"key_0\": \"\"\n },\n \"ownerUserId\": \"\",\n \"owner\": {\n \"id\": \"\",\n \"email\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\"\n },\n \"referralCode\": \"\",\n \"paypalEmail\": \"\",\n \"currency\": \"\",\n \"payoutProvider\": {\n \"type\": \"Payoneer\",\n \"details\": {}\n },\n \"language\": \"\"\n}"},{"id":"edc056f8-e78e-463e-8845-89a727d9d52f","name":"Partner not found","originalRequest":{"method":"PATCH","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"id\": \"\",\n \"name\": \"\",\n \"status\": \"Rejected\",\n \"onboardingStageId\": \"\",\n \"onboardingStageIds\": [\n \"\",\n \"\"\n ],\n \"programLevelIds\": [\n \"\",\n \"\"\n ],\n \"properties\": {\n \"key_0\": \"\"\n },\n \"currency\": \"\",\n \"groupId\": \"\",\n \"ownerUserId\": \"\",\n \"sinceDate\": \"\",\n \"referralCode\": \"\",\n \"payoutProvider\": {\n \"type\": \"Payoneer\",\n \"details\": {}\n },\n \"paypalEmail\": \"\",\n \"language\": \"\",\n \"prospectionStage\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"//v3/partners/:id","host":["/"],"path":["v3","partners",":id"],"variable":[{"key":"id","value":"","description":"(Required) The ID of the partner to update."}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":null}],"_postman_id":"4e91dfff-0679-45d6-bc46-d119bc7063e7"},{"name":"Get partner","id":"e068d735-da9c-4313-894c-eb94f293c57e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"//v3/partners/:id","description":"

Retrieve an existing partner by id.

\n","urlObject":{"path":["v3","partners",":id"],"host":["/"],"query":[],"variable":[{"id":"5002694b-77b9-455a-9ad5-e2680ce5262f","description":{"content":"

(Required) The ID of the partner to return.

\n","type":"text/plain"},"type":"any","value":"","key":"id"}]}},"response":[{"id":"4924b230-18d9-4205-8c13-718395b2f293","name":"Partner found","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"//v3/partners/:id","host":["/"],"path":["v3","partners",":id"],"variable":[{"key":"id","value":"","description":"(Required) The ID of the partner to return."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"\",\n \"name\": \"\",\n \"groupId\": \"\",\n \"onboardingStatus\": \"Unknown\",\n \"status\": \"Unknown\",\n \"source\": \"SignupForm\",\n \"company\": {\n \"id\": \"\",\n \"name\": \"\",\n \"websiteUrls\": [\n \"\",\n \"\"\n ]\n },\n \"mainContact\": {\n \"id\": \"\",\n \"email\": \"\",\n \"firstname\": \"\",\n \"lastname\": \"\",\n \"jobTitle\": \"\",\n \"phoneNumber\": \"\",\n \"linkedInProfileUrl\": \"\",\n \"creationDate\": \"\",\n \"isMainContact\": \"\"\n },\n \"onboardingStage\": {\n \"id\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"order\": \"\",\n \"onboardingPipelineId\": \"\",\n \"onboardingPipelineName\": \"\"\n },\n \"onboardingStages\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"order\": \"\",\n \"onboardingPipelineId\": \"\",\n \"onboardingPipelineName\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"order\": \"\",\n \"onboardingPipelineId\": \"\",\n \"onboardingPipelineName\": \"\"\n }\n ],\n \"levels\": [\n {\n \"programLevelId\": \"\",\n \"programLevelName\": \"\",\n \"programId\": \"\",\n \"programName\": \"\"\n },\n {\n \"programLevelId\": \"\",\n \"programLevelName\": \"\",\n \"programId\": \"\",\n \"programName\": \"\"\n }\n ],\n \"sinceDate\": \"\",\n \"partnerTypeId\": \"\",\n \"partnerTypeName\": \"\",\n \"properties\": {\n \"key_0\": \"\"\n },\n \"ownerUserId\": \"\",\n \"owner\": {\n \"id\": \"\",\n \"email\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\"\n },\n \"referralCode\": \"\",\n \"paypalEmail\": \"\",\n \"currency\": \"\",\n \"payoutProvider\": {\n \"type\": \"Payoneer\",\n \"details\": {}\n },\n \"language\": \"\"\n}"},{"id":"9d253ca1-f136-4b88-9de8-0b9dd192bbc3","name":"Partner not found","originalRequest":{"method":"GET","header":[],"url":{"raw":"//v3/partners/:id","host":["/"],"path":["v3","partners",":id"],"variable":[{"key":"id","value":"","description":"(Required) The ID of the partner to return."}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":null}],"_postman_id":"e068d735-da9c-4313-894c-eb94f293c57e"},{"name":"Get partner types","id":"3199157a-836c-4116-ba25-45c51ed3dc62","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"//v3/partners/types","description":"

Get all partner types.

\n","urlObject":{"path":["v3","partners","types"],"host":["/"],"query":[],"variable":[]}},"response":[{"id":"a2bf7490-8fd5-483e-a9c6-7e6c12366cd0","name":"Partner types returned","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"//v3/partners/types"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\"\n }\n]"}],"_postman_id":"3199157a-836c-4116-ba25-45c51ed3dc62"},{"name":"Get partner prospection stages","id":"ad669c88-9d87-48a5-8f0d-9375e71d4563","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"//v3/partners/prospection-stages","description":"

Get all partner prospection stages.

\n","urlObject":{"path":["v3","partners","prospection-stages"],"host":["/"],"query":[],"variable":[]}},"response":[{"id":"4b59058c-4149-45ea-a5ad-7b42adbc94ff","name":"Prospection stages returned","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"//v3/partners/prospection-stages"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\"\n }\n]"}],"_postman_id":"ad669c88-9d87-48a5-8f0d-9375e71d4563"},{"name":"Get partner links","id":"a2e1ff6f-9997-41aa-b875-a2b880ab025a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"//v3/partners/:id/links","description":"

Get all partner links.

\n","urlObject":{"path":["v3","partners",":id","links"],"host":["/"],"query":[],"variable":[{"id":"9a40e419-8550-4c36-ae2d-5b70478de905","description":{"content":"

(Required) The ID of the partner to get the links.

\n","type":"text/plain"},"type":"any","value":"","key":"id"}]}},"response":[{"id":"2cf78915-b076-4a48-9a50-3b8f35219ff1","name":"Partner links returned","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"//v3/partners/:id/links","host":["/"],"path":["v3","partners",":id","links"],"variable":[{"key":"id","value":"","description":"(Required) The ID of the partner to get the links."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"linkId\": \"\",\n \"linkName\": \"\",\n \"targetUrl\": \"\",\n \"programId\": \"\"\n },\n {\n \"linkId\": \"\",\n \"linkName\": \"\",\n \"targetUrl\": \"\",\n \"programId\": \"\"\n }\n]"},{"id":"005c0e09-9403-49a1-b240-c40b62df89d0","name":"Partner not found","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"//v3/partners/:id/links","host":["/"],"path":["v3","partners",":id","links"],"variable":[{"key":"id","value":"","description":"(Required) The ID of the partner to get the links."}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"errorCode\": \"\",\n \"errorMessage\": \"\"\n}"}],"_postman_id":"a2e1ff6f-9997-41aa-b875-a2b880ab025a"},{"name":"Get partner link statistics","id":"6f6041ed-3b7e-47d9-87b6-7f0659d21717","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"//v3/partners/:id/links/stats?currency=","description":"

Get all statistics relative to links for a partner.

\n","urlObject":{"path":["v3","partners",":id","links","stats"],"host":["/"],"query":[{"description":{"content":"

The currency used to convert aggregated amounts

\n","type":"text/plain"},"key":"currency","value":""}],"variable":[{"id":"4a98e29d-c8f6-4f8d-bae2-5c5a7cd6d744","description":{"content":"

(Required) Partner ID for which to return link statistics

\n","type":"text/plain"},"type":"any","value":"","key":"id"}]}},"response":[{"id":"92631df5-7fc5-415e-8a3c-51f68e28fba9","name":"Partner link statistics returned","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"//v3/partners/:id/links/stats?currency=","host":["/"],"path":["v3","partners",":id","links","stats"],"query":[{"description":"The currency used to convert aggregated amounts","key":"currency","value":""}],"variable":[{"key":"id","value":"","description":"(Required) Partner ID for which to return link statistics"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"partnerId\": \"\",\n \"partnerName\": \"\",\n \"uniqueVisitorsCount\": \"\",\n \"customersCount\": \"\",\n \"transactionsCount\": \"\",\n \"totalTransactionAmount\": {\n \"value\": \"\",\n \"currency\": \"\"\n },\n \"byLink\": [\n {\n \"linkId\": \"\",\n \"targetUrl\": \"\",\n \"uniqueVisitorsCount\": \"\",\n \"customersCount\": \"\",\n \"transactionsCount\": \"\",\n \"totalTransactionAmount\": {\n \"value\": \"\",\n \"currency\": \"\"\n }\n },\n {\n \"linkId\": \"\",\n \"targetUrl\": \"\",\n \"uniqueVisitorsCount\": \"\",\n \"customersCount\": \"\",\n \"transactionsCount\": \"\",\n \"totalTransactionAmount\": {\n \"value\": \"\",\n \"currency\": \"\"\n }\n }\n ]\n}"},{"id":"225f4f1e-5278-4951-9a3c-00316d01c016","name":"Partner not found","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"//v3/partners/:id/links/stats?currency=","host":["/"],"path":["v3","partners",":id","links","stats"],"query":[{"description":"The currency used to convert aggregated amounts","key":"currency","value":""}],"variable":[{"key":"id","value":"","description":"(Required) Partner ID for which to return link statistics"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"errorCode\": \"\",\n \"errorMessage\": \"\"\n}"}],"_postman_id":"6f6041ed-3b7e-47d9-87b6-7f0659d21717"},{"name":"Start an onboarding for a partner.","id":"a17c060b-daa8-418c-ae01-518d5e91db5b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"onboardingPipelineId\": \"\",\n \"onboardingStageId\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"//v3/partners/:id/onboard","description":"

Move the given partner in the specified onboarding pipeline and optionally start at a given stage.

\n","urlObject":{"path":["v3","partners",":id","onboard"],"host":["/"],"query":[],"variable":[{"id":"a4b1b4c8-4272-4865-bc7b-03b04c5b2c64","description":{"content":"

(Required) ID of the partner to onboard

\n","type":"text/plain"},"type":"any","value":"","key":"id"}]}},"response":[{"id":"4da70595-49c5-400f-abad-e999ad8bb6a6","name":"Partner onboarded successfully","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"onboardingPipelineId\": \"\",\n \"onboardingStageId\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"//v3/partners/:id/onboard","host":["/"],"path":["v3","partners",":id","onboard"],"variable":[{"key":"id","value":"","description":"(Required) ID of the partner to onboard"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"\",\n \"name\": \"\",\n \"groupId\": \"\",\n \"onboardingStatus\": \"Unknown\",\n \"status\": \"Unknown\",\n \"source\": \"SignupForm\",\n \"company\": {\n \"id\": \"\",\n \"name\": \"\",\n \"websiteUrls\": [\n \"\",\n \"\"\n ]\n },\n \"mainContact\": {\n \"id\": \"\",\n \"email\": \"\",\n \"firstname\": \"\",\n \"lastname\": \"\",\n \"jobTitle\": \"\",\n \"phoneNumber\": \"\",\n \"linkedInProfileUrl\": \"\",\n \"creationDate\": \"\",\n \"isMainContact\": \"\"\n },\n \"onboardingStage\": {\n \"id\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"order\": \"\",\n \"onboardingPipelineId\": \"\",\n \"onboardingPipelineName\": \"\"\n },\n \"onboardingStages\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"order\": \"\",\n \"onboardingPipelineId\": \"\",\n \"onboardingPipelineName\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"order\": \"\",\n \"onboardingPipelineId\": \"\",\n \"onboardingPipelineName\": \"\"\n }\n ],\n \"levels\": [\n {\n \"programLevelId\": \"\",\n \"programLevelName\": \"\",\n \"programId\": \"\",\n \"programName\": \"\"\n },\n {\n \"programLevelId\": \"\",\n \"programLevelName\": \"\",\n \"programId\": \"\",\n \"programName\": \"\"\n }\n ],\n \"sinceDate\": \"\",\n \"partnerTypeId\": \"\",\n \"partnerTypeName\": \"\",\n \"properties\": {\n \"key_0\": \"\"\n },\n \"ownerUserId\": \"\",\n \"owner\": {\n \"id\": \"\",\n \"email\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\"\n },\n \"referralCode\": \"\",\n \"paypalEmail\": \"\",\n \"currency\": \"\",\n \"payoutProvider\": {\n \"type\": \"Payoneer\",\n \"details\": {}\n },\n \"language\": \"\"\n}"},{"id":"0601d124-e118-4fb6-a3b9-60abcf9bc537","name":"Partner not found","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"onboardingPipelineId\": \"\",\n \"onboardingStageId\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"//v3/partners/:id/onboard","host":["/"],"path":["v3","partners",":id","onboard"],"variable":[{"key":"id","value":"","description":"(Required) ID of the partner to onboard"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":null}],"_postman_id":"a17c060b-daa8-418c-ae01-518d5e91db5b"}],"id":"1a2d4eaa-7cf5-4d20-9798-54809fda2fbc","_postman_id":"1a2d4eaa-7cf5-4d20-9798-54809fda2fbc","description":""},{"name":"PayoutProperties","item":[{"name":"List payout properties","id":"72b639db-e45c-443a-b96b-7bed30e013a2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"//v3/payouts/properties","description":"

List all custom properties defined on payout object.
You can customize the payout properties from your account's settings page.

\n","urlObject":{"path":["v3","payouts","properties"],"host":["/"],"query":[],"variable":[]}},"response":[{"id":"7f52e287-8014-4c94-9e0e-7c1a3d87aabd","name":"Success","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"//v3/payouts/properties"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"id\": \"\",\n \"entityType\": \"PartnerDirectory\",\n \"propertyType\": \"Currency\",\n \"name\": \"\",\n \"label\": \"\",\n \"placeholder\": \"\",\n \"description\": \"\",\n \"isRequired\": \"\",\n \"isVisible\": \"\",\n \"isPartnerEditable\": \"\",\n \"isCustom\": \"\",\n \"isReadOnly\": \"\",\n \"displayOrder\": \"\",\n \"isDealAmountPart\": \"\",\n \"canEditDescription\": \"\",\n \"canEditIsRequired\": \"\",\n \"dropdownConfiguration\": {\n \"options\": [\n {\n \"label\": \"\",\n \"originalValue\": \"\",\n \"value\": \"\"\n },\n {\n \"label\": \"\",\n \"originalValue\": \"\",\n \"value\": \"\"\n }\n ]\n }\n },\n {\n \"id\": \"\",\n \"entityType\": \"View\",\n \"propertyType\": \"Number\",\n \"name\": \"\",\n \"label\": \"\",\n \"placeholder\": \"\",\n \"description\": \"\",\n \"isRequired\": \"\",\n \"isVisible\": \"\",\n \"isPartnerEditable\": \"\",\n \"isCustom\": \"\",\n \"isReadOnly\": \"\",\n \"displayOrder\": \"\",\n \"isDealAmountPart\": \"\",\n \"canEditDescription\": \"\",\n \"canEditIsRequired\": \"\",\n \"dropdownConfiguration\": {\n \"options\": [\n {\n \"label\": \"\",\n \"originalValue\": \"\",\n \"value\": \"\"\n },\n {\n \"label\": \"\",\n \"originalValue\": \"\",\n \"value\": \"\"\n }\n ]\n }\n }\n]"}],"_postman_id":"72b639db-e45c-443a-b96b-7bed30e013a2"}],"id":"7578a1c2-726d-4378-ac25-ec54ed24d7fe","_postman_id":"7578a1c2-726d-4378-ac25-ec54ed24d7fe","description":""},{"name":"Payouts","item":[{"name":"List payouts","id":"9b8bd907-be0c-4dde-945f-632d7a9702f1","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"//v3/payouts?partner_id=&partner_id=&from=&to=&offset=&limit=&sort_by=&order_by=","description":"

List payouts and filter them by partner or any custom properties.

\n

To filter payouts on custom property, just add the property with its exact value as a query parameter:\nmyCustomProp=ThisIsAValue\nThis will return the payout where myCustomProp exactly matches the provided value.

\n","urlObject":{"path":["v3","payouts"],"host":["/"],"query":[{"description":{"content":"

The list of partner IDs to filter the payouts on.

\n","type":"text/plain"},"key":"partner_id","value":""},{"description":{"content":"

The list of partner IDs to filter the payouts on.

\n","type":"text/plain"},"key":"partner_id","value":""},{"description":{"content":"

Filter payouts created after this date (Inclusive)

\n","type":"text/plain"},"key":"from","value":""},{"description":{"content":"

Filter payouts created before this date (Exclusive)

\n","type":"text/plain"},"key":"to","value":""},{"description":{"content":"

The cursor used in pagination. This is the index of the first payout to be returned.

\n","type":"text/plain"},"key":"offset","value":""},{"description":{"content":"

The maximum number of payouts to be returned. The default is 20.

\n","type":"text/plain"},"key":"limit","value":""},{"description":{"content":"

The property used to sort the payouts by. The default is CreationDate.

\n","type":"text/plain"},"key":"sort_by","value":""},{"description":{"content":"

The sorting direction for the returned payouts. Accepted values: ASC, DESC. The default is DESC.

\n","type":"text/plain"},"key":"order_by","value":""}],"variable":[]}},"response":[],"_postman_id":"9b8bd907-be0c-4dde-945f-632d7a9702f1"},{"name":"Create payouts","id":"47a7e524-0fcc-4383-90d4-f215a8c51087","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"partnerIds\": [\n \"\",\n \"\"\n ],\n \"currency\": \"\",\n \"rewardType\": \"Cash\",\n \"rewardStatus\": \"Pending\",\n \"fromDate\": \"\",\n \"toDate\": \"\",\n \"threshold\": \"\",\n \"properties\": {\n \"key_0\": \"\",\n \"key_1\": \"\",\n \"key_2\": \"\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"//v3/payouts","description":"

It creates payouts from rewards matching the specified criteria.\nIf no rewards match the given criteria no payout is created.

\n

Examples:\nTo create payouts for all partners from all pending rewards within a specific date range:\n{ \"fromDate\": \"2022-01-01T00:00:00Z\", \"toDate\": \"2022-04-01T00:00:00Z\" }

\n

To create payouts for two specific partners:\n{ \"partnerIds\": [21, 42] }\nWhere 21 and 42 are the partner IDs.

\n","urlObject":{"path":["v3","payouts"],"host":["/"],"query":[],"variable":[]}},"response":[{"id":"4bcfa9cc-6d7b-429a-8cb1-21907e17d49f","name":"Payouts created","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"partnerIds\": [\n \"\",\n \"\"\n ],\n \"currency\": \"\",\n \"rewardType\": \"Cash\",\n \"rewardStatus\": \"Pending\",\n \"fromDate\": \"\",\n \"toDate\": \"\",\n \"threshold\": \"\",\n \"properties\": {\n \"key_0\": \"\",\n \"key_1\": \"\",\n \"key_2\": \"\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"//v3/payouts"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"items\": [\n {\n \"id\": \"\",\n \"partnerId\": \"\",\n \"partnerName\": \"\",\n \"name\": \"\",\n \"uniqueId\": \"\",\n \"currency\": \"\",\n \"rewardType\": \"Cash\",\n \"fromDate\": \"\",\n \"toDate\": \"\",\n \"amount\": {\n \"value\": \"\",\n \"currency\": \"\"\n },\n \"taxAmount\": {\n \"value\": \"\",\n \"currency\": \"\"\n },\n \"grossAmount\": {\n \"value\": \"\",\n \"currency\": \"\"\n },\n \"rewardCount\": \"\",\n \"creationDate\": \"\",\n \"paidDate\": \"\",\n \"acceptedDate\": \"\",\n \"validatedDate\": \"\",\n \"paidByUserId\": \"\",\n \"acceptedByUserId\": \"\",\n \"validatedByUserId\": \"\",\n \"invalidatedDate\": \"\",\n \"invalidatedByUserId\": \"\",\n \"status\": \"Ready\",\n \"source\": \"Unknown\",\n \"shouldValidateRewards\": \"\",\n \"shouldAttachInvoice\": \"\",\n \"isSelfInvoice\": \"\",\n \"properties\": {\n \"key_0\": \"\"\n },\n \"rewards\": [\n {\n \"id\": \"\",\n \"uniqueId\": \"\",\n \"partnerId\": \"\",\n \"dealId\": \"\",\n \"status\": \"Pending\",\n \"creationDate\": \"\",\n \"amount\": {\n \"value\": \"\",\n \"currency\": \"\"\n },\n \"payoutId\": \"\",\n \"comment\": \"\",\n \"rewardType\": \"Credit\",\n \"properties\": {\n \"key_0\": \"\"\n }\n },\n {\n \"id\": \"\",\n \"uniqueId\": \"\",\n \"partnerId\": \"\",\n \"dealId\": \"\",\n \"status\": \"Paid\",\n \"creationDate\": \"\",\n \"amount\": {\n \"value\": \"\",\n \"currency\": \"\"\n },\n \"payoutId\": \"\",\n \"comment\": \"\",\n \"rewardType\": \"Unknown\",\n \"properties\": {\n \"key_0\": \"\",\n \"key_1\": \"\",\n \"key_2\": \"\"\n }\n }\n ]\n },\n {\n \"id\": \"\",\n \"partnerId\": \"\",\n \"partnerName\": \"\",\n \"name\": \"\",\n \"uniqueId\": \"\",\n \"currency\": \"\",\n \"rewardType\": \"Credit\",\n \"fromDate\": \"\",\n \"toDate\": \"\",\n \"amount\": {\n \"value\": \"\",\n \"currency\": \"\"\n },\n \"taxAmount\": {\n \"value\": \"\",\n \"currency\": \"\"\n },\n \"grossAmount\": {\n \"value\": \"\",\n \"currency\": \"\"\n },\n \"rewardCount\": \"\",\n \"creationDate\": \"\",\n \"paidDate\": \"\",\n \"acceptedDate\": \"\",\n \"validatedDate\": \"\",\n \"paidByUserId\": \"\",\n \"acceptedByUserId\": \"\",\n \"validatedByUserId\": \"\",\n \"invalidatedDate\": \"\",\n \"invalidatedByUserId\": \"\",\n \"status\": \"Ready\",\n \"source\": \"Automatic\",\n \"shouldValidateRewards\": \"\",\n \"shouldAttachInvoice\": \"\",\n \"isSelfInvoice\": \"\",\n \"properties\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"rewards\": [\n {\n \"id\": \"\",\n \"uniqueId\": \"\",\n \"partnerId\": \"\",\n \"dealId\": \"\",\n \"status\": \"Unknown\",\n \"creationDate\": \"\",\n \"amount\": {\n \"value\": \"\",\n \"currency\": \"\"\n },\n \"payoutId\": \"\",\n \"comment\": \"\",\n \"rewardType\": \"GiftCard\",\n \"properties\": {\n \"key_0\": \"\"\n }\n },\n {\n \"id\": \"\",\n \"uniqueId\": \"\",\n \"partnerId\": \"\",\n \"dealId\": \"\",\n \"status\": \"Unknown\",\n \"creationDate\": \"\",\n \"amount\": {\n \"value\": \"\",\n \"currency\": \"\"\n },\n \"payoutId\": \"\",\n \"comment\": \"\",\n \"rewardType\": \"GiftCard\",\n \"properties\": {\n \"key_0\": \"\"\n }\n }\n ]\n }\n ],\n \"paginationSkipCount\": \"\",\n \"totalCount\": \"\"\n}"},{"id":"0f923d5f-d9bc-4715-8a30-15fc7fcfadd0","name":"Invalid request","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"partnerIds\": [\n \"\",\n \"\"\n ],\n \"currency\": \"\",\n \"rewardType\": \"Cash\",\n \"rewardStatus\": \"Pending\",\n \"fromDate\": \"\",\n \"toDate\": \"\",\n \"threshold\": \"\",\n \"properties\": {\n \"key_0\": \"\",\n \"key_1\": \"\",\n \"key_2\": \"\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"//v3/payouts"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"errorCode\": \"\",\n \"errorMessage\": \"\"\n}"}],"_postman_id":"47a7e524-0fcc-4383-90d4-f215a8c51087"},{"name":"Get payout","id":"62ed9e4c-9bb3-4fd2-b332-a5fe9b3748a5","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"//v3/payouts/:id","description":"

Retrieve an existing payout by id.

\n","urlObject":{"path":["v3","payouts",":id"],"host":["/"],"query":[],"variable":[{"id":"84e0af6d-0107-4551-8d72-a641cb5b7d41","description":{"content":"

(Required) The ID of the payout to return.

\n","type":"text/plain"},"type":"any","value":"","key":"id"}]}},"response":[],"_postman_id":"62ed9e4c-9bb3-4fd2-b332-a5fe9b3748a5"},{"name":"Update Payout","id":"8ef8e683-1f8e-42a0-96ff-3f31ef5f1758","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PATCH","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"id\": \"\",\n \"name\": \"\",\n \"properties\": {\n \"key_0\": \"\",\n \"key_1\": \"\",\n \"key_2\": \"\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"//v3/payouts/:id","description":"

You can only specify properties to update in the properties field as this method will PATCH the existing payout.\nProperties not found in the properties field will not be modified.

\n","urlObject":{"path":["v3","payouts",":id"],"host":["/"],"query":[],"variable":[{"id":"a81c9c7c-841f-4762-826b-45571054ca4d","description":{"content":"

(Required) The ID of the payout to update.

\n","type":"text/plain"},"type":"any","value":"","key":"id"}]}},"response":[{"id":"f00538a9-40a4-4fd6-b0fb-55c78dd58aa9","name":"Payout updated","originalRequest":{"method":"PATCH","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"id\": \"\",\n \"name\": \"\",\n \"properties\": {\n \"key_0\": \"\",\n \"key_1\": \"\",\n \"key_2\": \"\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"//v3/payouts/:id","host":["/"],"path":["v3","payouts",":id"],"variable":[{"key":"id","value":"","description":"(Required) The ID of the payout to update."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"\",\n \"partnerId\": \"\",\n \"partnerName\": \"\",\n \"name\": \"\",\n \"uniqueId\": \"\",\n \"currency\": \"\",\n \"rewardType\": \"Cash\",\n \"fromDate\": \"\",\n \"toDate\": \"\",\n \"amount\": {\n \"value\": \"\",\n \"currency\": \"\"\n },\n \"taxAmount\": {\n \"value\": \"\",\n \"currency\": \"\"\n },\n \"grossAmount\": {\n \"value\": \"\",\n \"currency\": \"\"\n },\n \"rewardCount\": \"\",\n \"creationDate\": \"\",\n \"paidDate\": \"\",\n \"acceptedDate\": \"\",\n \"validatedDate\": \"\",\n \"paidByUserId\": \"\",\n \"acceptedByUserId\": \"\",\n \"validatedByUserId\": \"\",\n \"invalidatedDate\": \"\",\n \"invalidatedByUserId\": \"\",\n \"status\": \"Paid\",\n \"source\": \"Manual\",\n \"shouldValidateRewards\": \"\",\n \"shouldAttachInvoice\": \"\",\n \"isSelfInvoice\": \"\",\n \"properties\": {\n \"key_0\": \"\",\n \"key_1\": \"\",\n \"key_2\": \"\"\n },\n \"rewards\": [\n {\n \"id\": \"\",\n \"uniqueId\": \"\",\n \"partnerId\": \"\",\n \"dealId\": \"\",\n \"status\": \"Paid\",\n \"creationDate\": \"\",\n \"amount\": {\n \"value\": \"\",\n \"currency\": \"\"\n },\n \"payoutId\": \"\",\n \"comment\": \"\",\n \"rewardType\": \"Coupon\",\n \"properties\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n },\n {\n \"id\": \"\",\n \"uniqueId\": \"\",\n \"partnerId\": \"\",\n \"dealId\": \"\",\n \"status\": \"Pending\",\n \"creationDate\": \"\",\n \"amount\": {\n \"value\": \"\",\n \"currency\": \"\"\n },\n \"payoutId\": \"\",\n \"comment\": \"\",\n \"rewardType\": \"Credit\",\n \"properties\": {\n \"key_0\": \"\"\n }\n }\n ]\n}"},{"id":"02318ba9-ef5f-4f33-8715-d18b3191a5a7","name":"Payout not found","originalRequest":{"method":"PATCH","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"id\": \"\",\n \"name\": \"\",\n \"properties\": {\n \"key_0\": \"\",\n \"key_1\": \"\",\n \"key_2\": \"\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"//v3/payouts/:id","host":["/"],"path":["v3","payouts",":id"],"variable":[{"key":"id","value":"","description":"(Required) The ID of the payout to update."}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"errorCode\": \"\",\n \"errorMessage\": \"\"\n}"}],"_postman_id":"8ef8e683-1f8e-42a0-96ff-3f31ef5f1758"},{"name":"Validate a payout","id":"aa73ee6d-f794-46f1-adee-9670382e1d73","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"payoutId\": \"\",\n \"shouldValidateRewards\": \"\",\n \"shouldAttachInvoice\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"//v3/payouts/:id/validate","description":"

When validating a payout you can ask your partner to:

\n
    \n
  • Validate all rewards
    • \n
  • Attach an invoice\nYou can ask your partner to do both actions or none of them.
    • \n
\n

Examples:\nTo validate a payout and ask your partner to attach an invoice:\n{ \"shouldAttachInvoice\": true, }

\n

To validate a payout and ask your partner to attach an invoice and validate all rewards:\n{ \"shouldAttachInvoice\": true, \"shouldValidateRewards \": true, }.

\n","urlObject":{"path":["v3","payouts",":id","validate"],"host":["/"],"query":[],"variable":[{"id":"e2af34be-c62b-467a-a2e0-67265f497b16","description":{"content":"

(Required)

\n","type":"text/plain"},"type":"any","value":"","key":"id"}]}},"response":[{"id":"b2f4d9e9-0f41-4597-8e1e-036456514003","name":"Payout validated","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"payoutId\": \"\",\n \"shouldValidateRewards\": \"\",\n \"shouldAttachInvoice\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"//v3/payouts/:id/validate","host":["/"],"path":["v3","payouts",":id","validate"],"variable":[{"key":"id","value":"","description":"(Required) "}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"\",\n \"partnerId\": \"\",\n \"partnerName\": \"\",\n \"name\": \"\",\n \"uniqueId\": \"\",\n \"currency\": \"\",\n \"rewardType\": \"Cash\",\n \"fromDate\": \"\",\n \"toDate\": \"\",\n \"amount\": {\n \"value\": \"\",\n \"currency\": \"\"\n },\n \"taxAmount\": {\n \"value\": \"\",\n \"currency\": \"\"\n },\n \"grossAmount\": {\n \"value\": \"\",\n \"currency\": \"\"\n },\n \"rewardCount\": \"\",\n \"creationDate\": \"\",\n \"paidDate\": \"\",\n \"acceptedDate\": \"\",\n \"validatedDate\": \"\",\n \"paidByUserId\": \"\",\n \"acceptedByUserId\": \"\",\n \"validatedByUserId\": \"\",\n \"invalidatedDate\": \"\",\n \"invalidatedByUserId\": \"\",\n \"status\": \"Paid\",\n \"source\": \"Manual\",\n \"shouldValidateRewards\": \"\",\n \"shouldAttachInvoice\": \"\",\n \"isSelfInvoice\": \"\",\n \"properties\": {\n \"key_0\": \"\",\n \"key_1\": \"\",\n \"key_2\": \"\"\n },\n \"rewards\": [\n {\n \"id\": \"\",\n \"uniqueId\": \"\",\n \"partnerId\": \"\",\n \"dealId\": \"\",\n \"status\": \"Paid\",\n \"creationDate\": \"\",\n \"amount\": {\n \"value\": \"\",\n \"currency\": \"\"\n },\n \"payoutId\": \"\",\n \"comment\": \"\",\n \"rewardType\": \"Coupon\",\n \"properties\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n },\n {\n \"id\": \"\",\n \"uniqueId\": \"\",\n \"partnerId\": \"\",\n \"dealId\": \"\",\n \"status\": \"Pending\",\n \"creationDate\": \"\",\n \"amount\": {\n \"value\": \"\",\n \"currency\": \"\"\n },\n \"payoutId\": \"\",\n \"comment\": \"\",\n \"rewardType\": \"Credit\",\n \"properties\": {\n \"key_0\": \"\"\n }\n }\n ]\n}"},{"id":"5709423f-1f7d-492e-b6fb-61b7fdfac932","name":"Invalid request","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"payoutId\": \"\",\n \"shouldValidateRewards\": \"\",\n \"shouldAttachInvoice\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"//v3/payouts/:id/validate","host":["/"],"path":["v3","payouts",":id","validate"],"variable":[{"key":"id","value":"","description":"(Required) "}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"errorCode\": \"\",\n \"errorMessage\": \"\"\n}"}],"_postman_id":"aa73ee6d-f794-46f1-adee-9670382e1d73"},{"name":"Invalidate a payout","id":"7bfcb3fe-c70f-4dcc-800e-6945b17ef12f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Accept","value":"application/json"}],"url":"//v3/payouts/:id/invalidate","description":"

Moves a Ready or Pending payout back to Draft status, clearing its validation state.\nOnly payouts in the Ready or Pending status can be invalidated.

\n","urlObject":{"path":["v3","payouts",":id","invalidate"],"host":["/"],"query":[],"variable":[{"id":"d2a6f9d5-19ed-45ec-9f81-3efa456be21c","description":{"content":"

(Required) The ID of the payout to invalidate.

\n","type":"text/plain"},"type":"any","value":"","key":"id"}]}},"response":[{"id":"823304f1-708a-4f2a-ba75-cb5591b1a211","name":"Payout invalidated","originalRequest":{"method":"POST","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"//v3/payouts/:id/invalidate","host":["/"],"path":["v3","payouts",":id","invalidate"],"variable":[{"key":"id","value":"","description":"(Required) The ID of the payout to invalidate."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"\",\n \"partnerId\": \"\",\n \"partnerName\": \"\",\n \"name\": \"\",\n \"uniqueId\": \"\",\n \"currency\": \"\",\n \"rewardType\": \"Cash\",\n \"fromDate\": \"\",\n \"toDate\": \"\",\n \"amount\": {\n \"value\": \"\",\n \"currency\": \"\"\n },\n \"taxAmount\": {\n \"value\": \"\",\n \"currency\": \"\"\n },\n \"grossAmount\": {\n \"value\": \"\",\n \"currency\": \"\"\n },\n \"rewardCount\": \"\",\n \"creationDate\": \"\",\n \"paidDate\": \"\",\n \"acceptedDate\": \"\",\n \"validatedDate\": \"\",\n \"paidByUserId\": \"\",\n \"acceptedByUserId\": \"\",\n \"validatedByUserId\": \"\",\n \"invalidatedDate\": \"\",\n \"invalidatedByUserId\": \"\",\n \"status\": \"Paid\",\n \"source\": \"Manual\",\n \"shouldValidateRewards\": \"\",\n \"shouldAttachInvoice\": \"\",\n \"isSelfInvoice\": \"\",\n \"properties\": {\n \"key_0\": \"\",\n \"key_1\": \"\",\n \"key_2\": \"\"\n },\n \"rewards\": [\n {\n \"id\": \"\",\n \"uniqueId\": \"\",\n \"partnerId\": \"\",\n \"dealId\": \"\",\n \"status\": \"Paid\",\n \"creationDate\": \"\",\n \"amount\": {\n \"value\": \"\",\n \"currency\": \"\"\n },\n \"payoutId\": \"\",\n \"comment\": \"\",\n \"rewardType\": \"Coupon\",\n \"properties\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n },\n {\n \"id\": \"\",\n \"uniqueId\": \"\",\n \"partnerId\": \"\",\n \"dealId\": \"\",\n \"status\": \"Pending\",\n \"creationDate\": \"\",\n \"amount\": {\n \"value\": \"\",\n \"currency\": \"\"\n },\n \"payoutId\": \"\",\n \"comment\": \"\",\n \"rewardType\": \"Credit\",\n \"properties\": {\n \"key_0\": \"\"\n }\n }\n ]\n}"},{"id":"8c577e7b-896a-41c3-9118-ceafe20535d9","name":"Not Found","originalRequest":{"method":"POST","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"//v3/payouts/:id/invalidate","host":["/"],"path":["v3","payouts",":id","invalidate"],"variable":[{"key":"id","value":"","description":"(Required) The ID of the payout to invalidate."}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"errorCode\": \"\",\n \"errorMessage\": \"\"\n}"}],"_postman_id":"7bfcb3fe-c70f-4dcc-800e-6945b17ef12f"},{"name":"Accept a payout","id":"aef8556b-82b0-474d-814e-014a55f12886","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Accept","value":"application/json"}],"url":"//v3/payouts/:id/accept","urlObject":{"path":["v3","payouts",":id","accept"],"host":["/"],"query":[],"variable":[{"id":"0fc8a923-270a-4a44-8241-a343fc92f5dd","description":{"content":"

(Required)

\n","type":"text/plain"},"type":"any","value":"","key":"id"}]}},"response":[{"id":"b0f39c9c-2cb1-47a0-9374-210e6707dafc","name":"Payout accepted","originalRequest":{"method":"POST","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"//v3/payouts/:id/accept","host":["/"],"path":["v3","payouts",":id","accept"],"variable":[{"key":"id","value":"","description":"(Required) "}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"\",\n \"partnerId\": \"\",\n \"partnerName\": \"\",\n \"name\": \"\",\n \"uniqueId\": \"\",\n \"currency\": \"\",\n \"rewardType\": \"Cash\",\n \"fromDate\": \"\",\n \"toDate\": \"\",\n \"amount\": {\n \"value\": \"\",\n \"currency\": \"\"\n },\n \"taxAmount\": {\n \"value\": \"\",\n \"currency\": \"\"\n },\n \"grossAmount\": {\n \"value\": \"\",\n \"currency\": \"\"\n },\n \"rewardCount\": \"\",\n \"creationDate\": \"\",\n \"paidDate\": \"\",\n \"acceptedDate\": \"\",\n \"validatedDate\": \"\",\n \"paidByUserId\": \"\",\n \"acceptedByUserId\": \"\",\n \"validatedByUserId\": \"\",\n \"invalidatedDate\": \"\",\n \"invalidatedByUserId\": \"\",\n \"status\": \"Paid\",\n \"source\": \"Manual\",\n \"shouldValidateRewards\": \"\",\n \"shouldAttachInvoice\": \"\",\n \"isSelfInvoice\": \"\",\n \"properties\": {\n \"key_0\": \"\",\n \"key_1\": \"\",\n \"key_2\": \"\"\n },\n \"rewards\": [\n {\n \"id\": \"\",\n \"uniqueId\": \"\",\n \"partnerId\": \"\",\n \"dealId\": \"\",\n \"status\": \"Paid\",\n \"creationDate\": \"\",\n \"amount\": {\n \"value\": \"\",\n \"currency\": \"\"\n },\n \"payoutId\": \"\",\n \"comment\": \"\",\n \"rewardType\": \"Coupon\",\n \"properties\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n },\n {\n \"id\": \"\",\n \"uniqueId\": \"\",\n \"partnerId\": \"\",\n \"dealId\": \"\",\n \"status\": \"Pending\",\n \"creationDate\": \"\",\n \"amount\": {\n \"value\": \"\",\n \"currency\": \"\"\n },\n \"payoutId\": \"\",\n \"comment\": \"\",\n \"rewardType\": \"Credit\",\n \"properties\": {\n \"key_0\": \"\"\n }\n }\n ]\n}"},{"id":"018d40d1-840c-488a-8a53-eba815cd971e","name":"Invalid request","originalRequest":{"method":"POST","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"//v3/payouts/:id/accept","host":["/"],"path":["v3","payouts",":id","accept"],"variable":[{"key":"id","value":"","description":"(Required) "}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"errorCode\": \"\",\n \"errorMessage\": \"\"\n}"}],"_postman_id":"aef8556b-82b0-474d-814e-014a55f12886"},{"name":"Pay a payout","id":"332b7043-e910-46ad-89fe-0ef12c7d85eb","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Accept","value":"application/json"}],"url":"//v3/payouts/:id/pay","urlObject":{"path":["v3","payouts",":id","pay"],"host":["/"],"query":[],"variable":[{"id":"1d9eb024-ecab-4a5a-9efb-00292b314e59","description":{"content":"

(Required)

\n","type":"text/plain"},"type":"any","value":"","key":"id"}]}},"response":[{"id":"1dd0da8e-a677-4016-a382-a11ff48e3cbf","name":"Payout paid","originalRequest":{"method":"POST","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"//v3/payouts/:id/pay","host":["/"],"path":["v3","payouts",":id","pay"],"variable":[{"key":"id","value":"","description":"(Required) "}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"\",\n \"partnerId\": \"\",\n \"partnerName\": \"\",\n \"name\": \"\",\n \"uniqueId\": \"\",\n \"currency\": \"\",\n \"rewardType\": \"Cash\",\n \"fromDate\": \"\",\n \"toDate\": \"\",\n \"amount\": {\n \"value\": \"\",\n \"currency\": \"\"\n },\n \"taxAmount\": {\n \"value\": \"\",\n \"currency\": \"\"\n },\n \"grossAmount\": {\n \"value\": \"\",\n \"currency\": \"\"\n },\n \"rewardCount\": \"\",\n \"creationDate\": \"\",\n \"paidDate\": \"\",\n \"acceptedDate\": \"\",\n \"validatedDate\": \"\",\n \"paidByUserId\": \"\",\n \"acceptedByUserId\": \"\",\n \"validatedByUserId\": \"\",\n \"invalidatedDate\": \"\",\n \"invalidatedByUserId\": \"\",\n \"status\": \"Paid\",\n \"source\": \"Manual\",\n \"shouldValidateRewards\": \"\",\n \"shouldAttachInvoice\": \"\",\n \"isSelfInvoice\": \"\",\n \"properties\": {\n \"key_0\": \"\",\n \"key_1\": \"\",\n \"key_2\": \"\"\n },\n \"rewards\": [\n {\n \"id\": \"\",\n \"uniqueId\": \"\",\n \"partnerId\": \"\",\n \"dealId\": \"\",\n \"status\": \"Paid\",\n \"creationDate\": \"\",\n \"amount\": {\n \"value\": \"\",\n \"currency\": \"\"\n },\n \"payoutId\": \"\",\n \"comment\": \"\",\n \"rewardType\": \"Coupon\",\n \"properties\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n },\n {\n \"id\": \"\",\n \"uniqueId\": \"\",\n \"partnerId\": \"\",\n \"dealId\": \"\",\n \"status\": \"Pending\",\n \"creationDate\": \"\",\n \"amount\": {\n \"value\": \"\",\n \"currency\": \"\"\n },\n \"payoutId\": \"\",\n \"comment\": \"\",\n \"rewardType\": \"Credit\",\n \"properties\": {\n \"key_0\": \"\"\n }\n }\n ]\n}"},{"id":"2fa49cee-f699-4760-b6d2-13452181759d","name":"Invalid request","originalRequest":{"method":"POST","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"//v3/payouts/:id/pay","host":["/"],"path":["v3","payouts",":id","pay"],"variable":[{"key":"id","value":"","description":"(Required) "}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"errorCode\": \"\",\n \"errorMessage\": \"\"\n}"}],"_postman_id":"332b7043-e910-46ad-89fe-0ef12c7d85eb"}],"id":"72230948-294e-4b80-917b-ed7164ec3c9b","_postman_id":"72230948-294e-4b80-917b-ed7164ec3c9b","description":""},{"name":"ProductPrices","item":[{"name":"List product prices","id":"0c356eee-b13f-46f5-a4ef-b0e393ba765a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"//v3/products/:productId/prices?offset=&limit=","description":"

List all prices associated with a given product.

\n","urlObject":{"path":["v3","products",":productId","prices"],"host":["/"],"query":[{"key":"offset","value":""},{"key":"limit","value":""}],"variable":[{"id":"c28ad731-54b5-4b79-9ba6-e5b12d1ee1b7","description":{"content":"

(Required) The ID of the product whose prices to retrieve.

\n","type":"text/plain"},"type":"any","value":"","key":"productId"}]}},"response":[{"id":"18512b2a-989a-42ed-800d-f7a9e71d4550","name":"Products returned","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"//v3/products/:productId/prices?offset=&limit=","host":["/"],"path":["v3","products",":productId","prices"],"query":[{"key":"offset","value":""},{"key":"limit","value":""}],"variable":[{"key":"productId","value":"","description":"(Required) The ID of the product whose prices to retrieve."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"items\": [\n {\n \"id\": \"\",\n \"properties\": {\n \"key_0\": \"\"\n },\n \"creationDate\": \"\"\n },\n {\n \"id\": \"\",\n \"properties\": {\n \"key_0\": \"\"\n },\n \"creationDate\": \"\"\n }\n ],\n \"paginationSkipCount\": \"\",\n \"totalCount\": \"\"\n}"},{"id":"ed633620-198b-4c54-ac64-9e8f11f1e9be","name":"You do not have access to this functionality in your current plan","originalRequest":{"method":"GET","header":[],"url":{"raw":"//v3/products/:productId/prices?offset=&limit=","host":["/"],"path":["v3","products",":productId","prices"],"query":[{"key":"offset","value":""},{"key":"limit","value":""}],"variable":[{"key":"productId","value":"","description":"(Required) The ID of the product whose prices to retrieve."}]}},"status":"Forbidden","code":403,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":null}],"_postman_id":"0c356eee-b13f-46f5-a4ef-b0e393ba765a"},{"name":"Create product price","id":"dc526d40-f258-4a6a-a9e9-e7ac1506a383","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"productId\": \"\",\n \"name\": \"\",\n \"programLevelId\": \"\",\n \"unitPrice\": \"\",\n \"suggestedPrice\": \"\",\n \"currency\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"//v3/products/:productId/prices","description":"

Create a new price for a given product.

\n","urlObject":{"path":["v3","products",":productId","prices"],"host":["/"],"query":[],"variable":[{"id":"81ca3379-305b-40e2-a2e1-8e6632421d2c","description":{"content":"

(Required)

\n","type":"text/plain"},"type":"any","value":"","key":"productId"}]}},"response":[{"id":"db3dc152-3780-48f5-9f15-f315b495d83f","name":"Product price created","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"productId\": \"\",\n \"name\": \"\",\n \"programLevelId\": \"\",\n \"unitPrice\": \"\",\n \"suggestedPrice\": \"\",\n \"currency\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"//v3/products/:productId/prices","host":["/"],"path":["v3","products",":productId","prices"],"variable":[{"key":"productId","value":"","description":"(Required) "}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"\",\n \"productId\": \"\",\n \"name\": \"\",\n \"programLevel\": {\n \"programLevelId\": \"\",\n \"programLevelName\": \"\",\n \"programId\": \"\",\n \"programName\": \"\"\n },\n \"unitPrice\": \"\",\n \"suggestedPrice\": \"\",\n \"currency\": \"\",\n \"creationDate\": \"\"\n}"},{"id":"d2e7f1b3-10fd-4622-b1d3-2f1c7d3996e6","name":"Invalid request","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"productId\": \"\",\n \"name\": \"\",\n \"programLevelId\": \"\",\n \"unitPrice\": \"\",\n \"suggestedPrice\": \"\",\n \"currency\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"//v3/products/:productId/prices","host":["/"],"path":["v3","products",":productId","prices"],"variable":[{"key":"productId","value":"","description":"(Required) "}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":null},{"id":"e8894af5-3d6f-45c8-9ca6-f13d7d5cf9b5","name":"You do not have access to this functionality in your current plan","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"productId\": \"\",\n \"name\": \"\",\n \"programLevelId\": \"\",\n \"unitPrice\": \"\",\n \"suggestedPrice\": \"\",\n \"currency\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"//v3/products/:productId/prices","host":["/"],"path":["v3","products",":productId","prices"],"variable":[{"key":"productId","value":"","description":"(Required) "}]}},"status":"Forbidden","code":403,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":null}],"_postman_id":"dc526d40-f258-4a6a-a9e9-e7ac1506a383"},{"name":"Update product price","id":"cdd3d620-5eef-4276-b173-7b24e75b6899","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"id\": \"\",\n \"name\": \"\",\n \"unitPrice\": \"\",\n \"suggestedPrice\": \"\",\n \"currency\": \"\",\n \"programLevelId\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"//v3/products/:productId/prices/:id","description":"

Update an existing price for a given product.

\n","urlObject":{"path":["v3","products",":productId","prices",":id"],"host":["/"],"query":[],"variable":[{"id":"bc84f555-cad4-43af-bc10-a811a7ec11e4","description":{"content":"

(Required)

\n","type":"text/plain"},"type":"any","value":"","key":"productId"},{"id":"97cfdcbd-1266-42b0-8edf-82ac0fca53bd","description":{"content":"

(Required)

\n","type":"text/plain"},"type":"any","value":"","key":"id"}]}},"response":[{"id":"63b84a54-cf37-49ee-99b3-5caeedfbd22f","name":"Product price created","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"id\": \"\",\n \"name\": \"\",\n \"unitPrice\": \"\",\n \"suggestedPrice\": \"\",\n \"currency\": \"\",\n \"programLevelId\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"//v3/products/:productId/prices/:id","host":["/"],"path":["v3","products",":productId","prices",":id"],"variable":[{"key":"productId","value":"","description":"(Required) "},{"key":"id","value":"","description":"(Required) "}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"\",\n \"productId\": \"\",\n \"name\": \"\",\n \"programLevel\": {\n \"programLevelId\": \"\",\n \"programLevelName\": \"\",\n \"programId\": \"\",\n \"programName\": \"\"\n },\n \"unitPrice\": \"\",\n \"suggestedPrice\": \"\",\n \"currency\": \"\",\n \"creationDate\": \"\"\n}"},{"id":"85885b5b-ce92-4e27-8b11-cf4965c65ebb","name":"Invalid request","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"id\": \"\",\n \"name\": \"\",\n \"unitPrice\": \"\",\n \"suggestedPrice\": \"\",\n \"currency\": \"\",\n \"programLevelId\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"//v3/products/:productId/prices/:id","host":["/"],"path":["v3","products",":productId","prices",":id"],"variable":[{"key":"productId","value":"","description":"(Required) "},{"key":"id","value":"","description":"(Required) "}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":null},{"id":"8acd7f92-6cce-44c9-b387-670d83c3b294","name":"You do not have access to this functionality in your current plan","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"id\": \"\",\n \"name\": \"\",\n \"unitPrice\": \"\",\n \"suggestedPrice\": \"\",\n \"currency\": \"\",\n \"programLevelId\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"//v3/products/:productId/prices/:id","host":["/"],"path":["v3","products",":productId","prices",":id"],"variable":[{"key":"productId","value":"","description":"(Required) "},{"key":"id","value":"","description":"(Required) "}]}},"status":"Forbidden","code":403,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":null}],"_postman_id":"cdd3d620-5eef-4276-b173-7b24e75b6899"},{"name":"Delete product price","id":"ab636b72-b387-41ae-bb24-4ad837a737e6","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[],"url":"//v3/products/:productId/prices/:id","description":"

Delete a price for a given product.

\n","urlObject":{"path":["v3","products",":productId","prices",":id"],"host":["/"],"query":[],"variable":[{"id":"c26295a1-ef8a-47e3-86df-8b363951c8a9","description":{"content":"

(Required)

\n","type":"text/plain"},"type":"any","value":"","key":"productId"},{"id":"0ee91260-6fa0-4d56-a857-1fbda2c26df8","description":{"content":"

(Required)

\n","type":"text/plain"},"type":"any","value":"","key":"id"}]}},"response":[{"id":"4e7a15b6-e1c2-4849-b97c-688806463fc9","name":"Product created","originalRequest":{"method":"DELETE","header":[],"url":{"raw":"//v3/products/:productId/prices/:id","host":["/"],"path":["v3","products",":productId","prices",":id"],"variable":[{"key":"productId","value":"","description":"(Required) "},{"key":"id","value":"","description":"(Required) "}]}},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":null},{"id":"a1f2c414-13ca-4344-8c25-819194ff6b50","name":"Invalid request","originalRequest":{"method":"DELETE","header":[],"url":{"raw":"//v3/products/:productId/prices/:id","host":["/"],"path":["v3","products",":productId","prices",":id"],"variable":[{"key":"productId","value":"","description":"(Required) "},{"key":"id","value":"","description":"(Required) "}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":null},{"id":"e7ba41f7-8023-49f3-8ea4-dd021fc551fd","name":"You do not have access to this functionality in your current plan","originalRequest":{"method":"DELETE","header":[],"url":{"raw":"//v3/products/:productId/prices/:id","host":["/"],"path":["v3","products",":productId","prices",":id"],"variable":[{"key":"productId","value":"","description":"(Required) "},{"key":"id","value":"","description":"(Required) "}]}},"status":"Forbidden","code":403,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":null}],"_postman_id":"ab636b72-b387-41ae-bb24-4ad837a737e6"}],"id":"b574d236-1b58-4df5-ad55-207b43fc098f","_postman_id":"b574d236-1b58-4df5-ad55-207b43fc098f","description":""},{"name":"Products","item":[{"name":"List products","id":"0b1e61ab-d4fd-4070-a91b-9cae22ff23d6","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"//v3/products?sort_by=&order_by=&offset=&limit=","description":"

List products and filter them by any custom properties.

\n

To filter products on custom property, just add the property with its exact value as a query parameter:
myCustomProp=ThisIsAValue
This will return the products where myCustomProp exactly matches the provided value.

\n","urlObject":{"path":["v3","products"],"host":["/"],"query":[{"description":{"content":"

Property to sort by.

\n","type":"text/plain"},"key":"sort_by","value":""},{"description":{"content":"

Order by direction. Can be ASC or DESC.

\n","type":"text/plain"},"key":"order_by","value":""},{"description":{"content":"

Start offset used to paginate results.

\n","type":"text/plain"},"key":"offset","value":""},{"description":{"content":"

Maximum number of items to be returned.

\n","type":"text/plain"},"key":"limit","value":""}],"variable":[]}},"response":[{"id":"f0d1b85e-b898-450b-b2f3-b39620be7769","name":"Products returned","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"//v3/products?sort_by=&order_by=&offset=&limit=","host":["/"],"path":["v3","products"],"query":[{"description":"Property to sort by.","key":"sort_by","value":""},{"description":"Order by direction. Can be ASC or DESC.","key":"order_by","value":""},{"description":"Start offset used to paginate results.","key":"offset","value":""},{"description":"Maximum number of items to be returned.","key":"limit","value":""}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"items\": [\n {\n \"id\": \"\",\n \"properties\": {\n \"key_0\": \"\"\n },\n \"creationDate\": \"\"\n },\n {\n \"id\": \"\",\n \"properties\": {\n \"key_0\": \"\"\n },\n \"creationDate\": \"\"\n }\n ],\n \"paginationSkipCount\": \"\",\n \"totalCount\": \"\"\n}"},{"id":"3a72934b-4aea-4feb-9447-61ce23f4e189","name":"You do not have access to this functionality in your current plan","originalRequest":{"method":"GET","header":[],"url":{"raw":"//v3/products?sort_by=&order_by=&offset=&limit=","host":["/"],"path":["v3","products"],"query":[{"description":"Property to sort by.","key":"sort_by","value":""},{"description":"Order by direction. Can be ASC or DESC.","key":"order_by","value":""},{"description":"Start offset used to paginate results.","key":"offset","value":""},{"description":"Maximum number of items to be returned.","key":"limit","value":""}]}},"status":"Forbidden","code":403,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":null}],"_postman_id":"0b1e61ab-d4fd-4070-a91b-9cae22ff23d6"},{"name":"Create product","id":"223808da-4cd7-4e4e-b06a-116968dcf293","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"properties\": {\n \"key_0\": \"\",\n \"key_1\": \"\",\n \"key_2\": \"\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"//v3/products","description":"

Create a new product.

\n","urlObject":{"path":["v3","products"],"host":["/"],"query":[],"variable":[]}},"response":[{"id":"c4a879ce-8822-4e24-bd89-3139f7e8f41d","name":"Product created","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"properties\": {\n \"key_0\": \"\",\n \"key_1\": \"\",\n \"key_2\": \"\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"//v3/products"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"\",\n \"properties\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"creationDate\": \"\"\n}"},{"id":"93f66977-62a1-4971-abcf-601277d91fc8","name":"Invalid request","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"properties\": {\n \"key_0\": \"\",\n \"key_1\": \"\",\n \"key_2\": \"\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"//v3/products"},"status":"Bad Request","code":400,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":null},{"id":"c86566d7-274c-465d-97ee-8fe5b4f825e9","name":"You do not have access to this functionality in your current plan","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"properties\": {\n \"key_0\": \"\",\n \"key_1\": \"\",\n \"key_2\": \"\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"//v3/products"},"status":"Forbidden","code":403,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":null}],"_postman_id":"223808da-4cd7-4e4e-b06a-116968dcf293"},{"name":"Patch product","id":"03bee89e-e7d1-4b22-b2ea-b453f49001dd","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PATCH","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"id\": \"\",\n \"properties\": {\n \"key_0\": \"\",\n \"key_1\": \"\",\n \"key_2\": \"\",\n \"key_3\": \"\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"//v3/products/:id","urlObject":{"path":["v3","products",":id"],"host":["/"],"query":[],"variable":[{"id":"d89eb8c2-902e-487a-a241-903b8f5102ce","description":{"content":"

(Required) The ID of the product to patch.

\n","type":"text/plain"},"type":"any","value":"","key":"id"}]}},"response":[{"id":"81af5946-c228-4caa-a6e2-b036c0e217b5","name":"Product updated","originalRequest":{"method":"PATCH","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"id\": \"\",\n \"properties\": {\n \"key_0\": \"\",\n \"key_1\": \"\",\n \"key_2\": \"\",\n \"key_3\": \"\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"//v3/products/:id","host":["/"],"path":["v3","products",":id"],"variable":[{"key":"id","value":"","description":"(Required) The ID of the product to patch."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"\",\n \"properties\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"creationDate\": \"\"\n}"},{"id":"38900e56-9129-4a1d-b79a-a15b94330867","name":"Invalid request","originalRequest":{"method":"PATCH","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"id\": \"\",\n \"properties\": {\n \"key_0\": \"\",\n \"key_1\": \"\",\n \"key_2\": \"\",\n \"key_3\": \"\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"//v3/products/:id","host":["/"],"path":["v3","products",":id"],"variable":[{"key":"id","value":"","description":"(Required) The ID of the product to patch."}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":null},{"id":"ad40b40f-a8df-471f-b391-52385b717645","name":"You do not have access to this functionality in your current plan","originalRequest":{"method":"PATCH","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"id\": \"\",\n \"properties\": {\n \"key_0\": \"\",\n \"key_1\": \"\",\n \"key_2\": \"\",\n \"key_3\": \"\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"//v3/products/:id","host":["/"],"path":["v3","products",":id"],"variable":[{"key":"id","value":"","description":"(Required) The ID of the product to patch."}]}},"status":"Forbidden","code":403,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":null},{"id":"7190ae64-d969-4ff3-9d41-8ae3a0892219","name":"Product not found","originalRequest":{"method":"PATCH","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"id\": \"\",\n \"properties\": {\n \"key_0\": \"\",\n \"key_1\": \"\",\n \"key_2\": \"\",\n \"key_3\": \"\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"//v3/products/:id","host":["/"],"path":["v3","products",":id"],"variable":[{"key":"id","value":"","description":"(Required) The ID of the product to patch."}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":null}],"_postman_id":"03bee89e-e7d1-4b22-b2ea-b453f49001dd"},{"name":"Delete product","id":"d9581d1f-aeb1-4a51-921b-d45327898e2c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[],"url":"//v3/products/:id","description":"

Delete an existing product.

\n","urlObject":{"path":["v3","products",":id"],"host":["/"],"query":[],"variable":[{"id":"bce6893a-ae9d-4d32-91bd-0844d62fda14","description":{"content":"

(Required)

\n","type":"text/plain"},"type":"any","value":"","key":"id"}]}},"response":[{"id":"db3e988e-720e-4215-8eb0-c55c7dc10398","name":"Product deleted","originalRequest":{"method":"DELETE","header":[],"url":{"raw":"//v3/products/:id","host":["/"],"path":["v3","products",":id"],"variable":[{"key":"id","value":"","description":"(Required) "}]}},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":null},{"id":"0dde9408-0fef-4c10-a368-b37baa7a0679","name":"You do not have access to this functionality in your current plan","originalRequest":{"method":"DELETE","header":[],"url":{"raw":"//v3/products/:id","host":["/"],"path":["v3","products",":id"],"variable":[{"key":"id","value":"","description":"(Required) "}]}},"status":"Forbidden","code":403,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":null},{"id":"40211415-4cdf-4b1a-8366-5ed8459e15bf","name":"Product not found","originalRequest":{"method":"DELETE","header":[],"url":{"raw":"//v3/products/:id","host":["/"],"path":["v3","products",":id"],"variable":[{"key":"id","value":"","description":"(Required) "}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":null}],"_postman_id":"d9581d1f-aeb1-4a51-921b-d45327898e2c"}],"id":"72488e0b-2bd2-41ea-be5f-24595045030c","_postman_id":"72488e0b-2bd2-41ea-be5f-24595045030c","description":""},{"name":"Programs","item":[{"name":"List partner programs","id":"eb8cf536-10eb-4c6b-b6d7-f2a058f11cb0","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"//v3/programs","description":"

List partner programs.\nWarning: the BadgeUrl is a temporary link that works only for 72 hours for each request.

\n","urlObject":{"path":["v3","programs"],"host":["/"],"query":[],"variable":[]}},"response":[{"id":"fa882acd-56ba-4b32-a3b8-d7bb7aac7c80","name":"Programs returned","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"//v3/programs"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"items\": [\n {\n \"name\": \"\",\n \"id\": \"\",\n \"levels\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"badgeUrl\": \"\",\n \"requirements\": [\n {\n \"id\": \"\",\n \"programLevelId\": \"\",\n \"name\": \"\",\n \"label\": \"\",\n \"description\": \"\",\n \"displayOrder\": \"\"\n },\n {\n \"id\": \"\",\n \"programLevelId\": \"\",\n \"name\": \"\",\n \"label\": \"\",\n \"description\": \"\",\n \"displayOrder\": \"\"\n }\n ],\n \"benefits\": [\n {\n \"id\": \"\",\n \"programLevelId\": \"\",\n \"name\": \"\",\n \"label\": \"\",\n \"description\": \"\",\n \"displayOrder\": \"\"\n },\n {\n \"id\": \"\",\n \"programLevelId\": \"\",\n \"name\": \"\",\n \"label\": \"\",\n \"description\": \"\",\n \"displayOrder\": \"\"\n }\n ],\n \"rewards\": [\n {\n \"id\": \"\",\n \"programLevelId\": \"\",\n \"name\": \"\",\n \"label\": \"\",\n \"description\": \"\",\n \"displayOrder\": \"\"\n },\n {\n \"id\": \"\",\n \"programLevelId\": \"\",\n \"name\": \"\",\n \"label\": \"\",\n \"description\": \"\",\n \"displayOrder\": \"\"\n }\n ]\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"badgeUrl\": \"\",\n \"requirements\": [\n {\n \"id\": \"\",\n \"programLevelId\": \"\",\n \"name\": \"\",\n \"label\": \"\",\n \"description\": \"\",\n \"displayOrder\": \"\"\n },\n {\n \"id\": \"\",\n \"programLevelId\": \"\",\n \"name\": \"\",\n \"label\": \"\",\n \"description\": \"\",\n \"displayOrder\": \"\"\n }\n ],\n \"benefits\": [\n {\n \"id\": \"\",\n \"programLevelId\": \"\",\n \"name\": \"\",\n \"label\": \"\",\n \"description\": \"\",\n \"displayOrder\": \"\"\n },\n {\n \"id\": \"\",\n \"programLevelId\": \"\",\n \"name\": \"\",\n \"label\": \"\",\n \"description\": \"\",\n \"displayOrder\": \"\"\n }\n ],\n \"rewards\": [\n {\n \"id\": \"\",\n \"programLevelId\": \"\",\n \"name\": \"\",\n \"label\": \"\",\n \"description\": \"\",\n \"displayOrder\": \"\"\n },\n {\n \"id\": \"\",\n \"programLevelId\": \"\",\n \"name\": \"\",\n \"label\": \"\",\n \"description\": \"\",\n \"displayOrder\": \"\"\n }\n ]\n }\n ],\n \"mustAcceptTerms\": \"\",\n \"termsUrl\": \"\"\n },\n {\n \"name\": \"\",\n \"id\": \"\",\n \"levels\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"badgeUrl\": \"\",\n \"requirements\": [\n {\n \"id\": \"\",\n \"programLevelId\": \"\",\n \"name\": \"\",\n \"label\": \"\",\n \"description\": \"\",\n \"displayOrder\": \"\"\n },\n {\n \"id\": \"\",\n \"programLevelId\": \"\",\n \"name\": \"\",\n \"label\": \"\",\n \"description\": \"\",\n \"displayOrder\": \"\"\n }\n ],\n \"benefits\": [\n {\n \"id\": \"\",\n \"programLevelId\": \"\",\n \"name\": \"\",\n \"label\": \"\",\n \"description\": \"\",\n \"displayOrder\": \"\"\n },\n {\n \"id\": \"\",\n \"programLevelId\": \"\",\n \"name\": \"\",\n \"label\": \"\",\n \"description\": \"\",\n \"displayOrder\": \"\"\n }\n ],\n \"rewards\": [\n {\n \"id\": \"\",\n \"programLevelId\": \"\",\n \"name\": \"\",\n \"label\": \"\",\n \"description\": \"\",\n \"displayOrder\": \"\"\n },\n {\n \"id\": \"\",\n \"programLevelId\": \"\",\n \"name\": \"\",\n \"label\": \"\",\n \"description\": \"\",\n \"displayOrder\": \"\"\n }\n ]\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"badgeUrl\": \"\",\n \"requirements\": [\n {\n \"id\": \"\",\n \"programLevelId\": \"\",\n \"name\": \"\",\n \"label\": \"\",\n \"description\": \"\",\n \"displayOrder\": \"\"\n },\n {\n \"id\": \"\",\n \"programLevelId\": \"\",\n \"name\": \"\",\n \"label\": \"\",\n \"description\": \"\",\n \"displayOrder\": \"\"\n }\n ],\n \"benefits\": [\n {\n \"id\": \"\",\n \"programLevelId\": \"\",\n \"name\": \"\",\n \"label\": \"\",\n \"description\": \"\",\n \"displayOrder\": \"\"\n },\n {\n \"id\": \"\",\n \"programLevelId\": \"\",\n \"name\": \"\",\n \"label\": \"\",\n \"description\": \"\",\n \"displayOrder\": \"\"\n }\n ],\n \"rewards\": [\n {\n \"id\": \"\",\n \"programLevelId\": \"\",\n \"name\": \"\",\n \"label\": \"\",\n \"description\": \"\",\n \"displayOrder\": \"\"\n },\n {\n \"id\": \"\",\n \"programLevelId\": \"\",\n \"name\": \"\",\n \"label\": \"\",\n \"description\": \"\",\n \"displayOrder\": \"\"\n }\n ]\n }\n ],\n \"mustAcceptTerms\": \"\",\n \"termsUrl\": \"\"\n }\n ]\n}"}],"_postman_id":"eb8cf536-10eb-4c6b-b6d7-f2a058f11cb0"}],"id":"6f58e395-2152-49ef-8070-6780d3988ec0","_postman_id":"6f58e395-2152-49ef-8070-6780d3988ec0","description":""},{"name":"RewardProperties","item":[{"name":"List partner properties","id":"42248818-3fe9-4908-a890-e6bcaee579d9","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"//v3/rewards/properties","description":"

List all custom properties defined on partner object.
You can customize the partner properties from your account's settings page.

\n","urlObject":{"path":["v3","rewards","properties"],"host":["/"],"query":[],"variable":[]}},"response":[{"id":"871fa732-2a7a-4370-88df-89b0271ceb35","name":"Success","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"//v3/rewards/properties"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"id\": \"\",\n \"entityType\": \"PartnerDirectory\",\n \"propertyType\": \"Currency\",\n \"name\": \"\",\n \"label\": \"\",\n \"placeholder\": \"\",\n \"description\": \"\",\n \"isRequired\": \"\",\n \"isVisible\": \"\",\n \"isPartnerEditable\": \"\",\n \"isCustom\": \"\",\n \"isReadOnly\": \"\",\n \"displayOrder\": \"\",\n \"isDealAmountPart\": \"\",\n \"canEditDescription\": \"\",\n \"canEditIsRequired\": \"\",\n \"dropdownConfiguration\": {\n \"options\": [\n {\n \"label\": \"\",\n \"originalValue\": \"\",\n \"value\": \"\"\n },\n {\n \"label\": \"\",\n \"originalValue\": \"\",\n \"value\": \"\"\n }\n ]\n }\n },\n {\n \"id\": \"\",\n \"entityType\": \"View\",\n \"propertyType\": \"Number\",\n \"name\": \"\",\n \"label\": \"\",\n \"placeholder\": \"\",\n \"description\": \"\",\n \"isRequired\": \"\",\n \"isVisible\": \"\",\n \"isPartnerEditable\": \"\",\n \"isCustom\": \"\",\n \"isReadOnly\": \"\",\n \"displayOrder\": \"\",\n \"isDealAmountPart\": \"\",\n \"canEditDescription\": \"\",\n \"canEditIsRequired\": \"\",\n \"dropdownConfiguration\": {\n \"options\": [\n {\n \"label\": \"\",\n \"originalValue\": \"\",\n \"value\": \"\"\n },\n {\n \"label\": \"\",\n \"originalValue\": \"\",\n \"value\": \"\"\n }\n ]\n }\n }\n]"}],"_postman_id":"42248818-3fe9-4908-a890-e6bcaee579d9"}],"id":"37cc15f5-1a3f-4be9-b8b7-105a646031a8","_postman_id":"37cc15f5-1a3f-4be9-b8b7-105a646031a8","description":""},{"name":"Rewards","item":[{"name":"List rewards","id":"beb53dc1-9247-4759-ad43-600f21f8669f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"//v3/rewards?offset=&limit=&sort_by=&order_by=&from=&to=&partner_id=","description":"

List rewards and filter them by partner and/or date range.

\n","urlObject":{"path":["v3","rewards"],"host":["/"],"query":[{"description":{"content":"

The cursor used in pagination. This is the index of the first transaction to be returned.

\n","type":"text/plain"},"key":"offset","value":""},{"description":{"content":"

The maximum number of transactions to be returned. The default is 20.

\n","type":"text/plain"},"key":"limit","value":""},{"description":{"content":"

The property used to sort the transactions by. The default is CreationDate.

\n","type":"text/plain"},"key":"sort_by","value":""},{"description":{"content":"

The sorting direction for the returned transactions. Accepted values: ASC, DESC. The default is DESC.

\n","type":"text/plain"},"key":"order_by","value":""},{"description":{"content":"

From date inclusive

\n","type":"text/plain"},"key":"from","value":""},{"description":{"content":"

To date exclusive

\n","type":"text/plain"},"key":"to","value":""},{"description":{"content":"

The partner ID

\n","type":"text/plain"},"key":"partner_id","value":""}],"variable":[]}},"response":[],"_postman_id":"beb53dc1-9247-4759-ad43-600f21f8669f"},{"name":"Create reward","id":"d092d3d4-8515-4e93-8812-5390331b38bd","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"amount\": \"\",\n \"comment\": \"\",\n \"partnerId\": \"\",\n \"rewardType\": \"Credit\",\n \"currency\": \"\",\n \"properties\": {\n \"key_0\": \"\",\n \"key_1\": \"\",\n \"key_2\": \"\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"//v3/rewards","description":"

Create a new reward.

\n","urlObject":{"path":["v3","rewards"],"host":["/"],"query":[],"variable":[]}},"response":[{"id":"4a71cb4e-0a31-41a1-b97b-32a369e5fae5","name":"Reward created","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"amount\": \"\",\n \"comment\": \"\",\n \"partnerId\": \"\",\n \"rewardType\": \"Credit\",\n \"currency\": \"\",\n \"properties\": {\n \"key_0\": \"\",\n \"key_1\": \"\",\n \"key_2\": \"\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"//v3/rewards"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"\",\n \"uniqueId\": \"\",\n \"partnerId\": \"\",\n \"dealId\": \"\",\n \"status\": \"Accepted\",\n \"creationDate\": \"\",\n \"amount\": {\n \"value\": \"\",\n \"currency\": \"\"\n },\n \"payoutId\": \"\",\n \"comment\": \"\",\n \"rewardType\": \"Credit\",\n \"properties\": {\n \"key_0\": \"\",\n \"key_1\": \"\",\n \"key_2\": \"\",\n \"key_3\": \"\"\n }\n}"},{"id":"854b5ad0-47a9-4945-be58-4daafc8a8ed4","name":"Invalid request","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"amount\": \"\",\n \"comment\": \"\",\n \"partnerId\": \"\",\n \"rewardType\": \"Credit\",\n \"currency\": \"\",\n \"properties\": {\n \"key_0\": \"\",\n \"key_1\": \"\",\n \"key_2\": \"\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"//v3/rewards"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"errorCode\": \"\",\n \"errorMessage\": \"\"\n}"}],"_postman_id":"d092d3d4-8515-4e93-8812-5390331b38bd"}],"id":"c394a957-8d0d-4843-b99b-2be8d53cfd53","_postman_id":"c394a957-8d0d-4843-b99b-2be8d53cfd53","description":""},{"name":"TransactionProperties","item":[{"name":"List transaction properties","id":"bc7b03f6-68ff-49b7-b028-bf5d20fcd2d5","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"//v3/transactions/properties","description":"

List all custom properties defined on transaction object.
You can customize the transaction properties from your account's settings page.

\n","urlObject":{"path":["v3","transactions","properties"],"host":["/"],"query":[],"variable":[]}},"response":[{"id":"918530ff-db31-42f4-abee-4b8355022fbc","name":"Success","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"//v3/transactions/properties"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"id\": \"\",\n \"entityType\": \"PartnerDirectory\",\n \"propertyType\": \"Currency\",\n \"name\": \"\",\n \"label\": \"\",\n \"placeholder\": \"\",\n \"description\": \"\",\n \"isRequired\": \"\",\n \"isVisible\": \"\",\n \"isPartnerEditable\": \"\",\n \"isCustom\": \"\",\n \"isReadOnly\": \"\",\n \"displayOrder\": \"\",\n \"isDealAmountPart\": \"\",\n \"canEditDescription\": \"\",\n \"canEditIsRequired\": \"\",\n \"dropdownConfiguration\": {\n \"options\": [\n {\n \"label\": \"\",\n \"originalValue\": \"\",\n \"value\": \"\"\n },\n {\n \"label\": \"\",\n \"originalValue\": \"\",\n \"value\": \"\"\n }\n ]\n }\n },\n {\n \"id\": \"\",\n \"entityType\": \"View\",\n \"propertyType\": \"Number\",\n \"name\": \"\",\n \"label\": \"\",\n \"placeholder\": \"\",\n \"description\": \"\",\n \"isRequired\": \"\",\n \"isVisible\": \"\",\n \"isPartnerEditable\": \"\",\n \"isCustom\": \"\",\n \"isReadOnly\": \"\",\n \"displayOrder\": \"\",\n \"isDealAmountPart\": \"\",\n \"canEditDescription\": \"\",\n \"canEditIsRequired\": \"\",\n \"dropdownConfiguration\": {\n \"options\": [\n {\n \"label\": \"\",\n \"originalValue\": \"\",\n \"value\": \"\"\n },\n {\n \"label\": \"\",\n \"originalValue\": \"\",\n \"value\": \"\"\n }\n ]\n }\n }\n]"}],"_postman_id":"bc7b03f6-68ff-49b7-b028-bf5d20fcd2d5"}],"id":"2294478c-c552-4cc9-81ac-f4bcac7dbf35","_postman_id":"2294478c-c552-4cc9-81ac-f4bcac7dbf35","description":""},{"name":"Transactions","item":[{"name":"List transactions","id":"d083f576-b81b-4a5d-9792-6fc507a65623","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"//v3/transactions?partner_id=&partner_id=&customer_id=&customer_id=&deal_id=&deal_id=&offset=&limit=&sort_by=&order_by=","description":"

List transactions and filter them by partner, customer or any custom properties.

\n

To filter transactions on custom property, just add the property with its exact value as a query parameter:
myCustomProp=ThisIsAValue
This will return the transactions where myCustomProp exactly matches the provided value.

\n","urlObject":{"path":["v3","transactions"],"host":["/"],"query":[{"description":{"content":"

The list of partner IDs to filter the transactions on.

\n","type":"text/plain"},"key":"partner_id","value":""},{"description":{"content":"

The list of partner IDs to filter the transactions on.

\n","type":"text/plain"},"key":"partner_id","value":""},{"description":{"content":"

The list of customer IDs to filter the returned transactions on.

\n","type":"text/plain"},"key":"customer_id","value":""},{"description":{"content":"

The list of customer IDs to filter the returned transactions on.

\n","type":"text/plain"},"key":"customer_id","value":""},{"description":{"content":"

The list of deal IDs to filed the returned transactions on.

\n","type":"text/plain"},"key":"deal_id","value":""},{"description":{"content":"

The list of deal IDs to filed the returned transactions on.

\n","type":"text/plain"},"key":"deal_id","value":""},{"description":{"content":"

The cursor used in pagination. This is the index of the first transaction to be returned.

\n","type":"text/plain"},"key":"offset","value":""},{"description":{"content":"

The maximum number of transactions to be returned. The default is 20.

\n","type":"text/plain"},"key":"limit","value":""},{"description":{"content":"

The property used to sort the transactions by. The default is CreationDate.

\n","type":"text/plain"},"key":"sort_by","value":""},{"description":{"content":"

The sorting direction for the returned transactions. Accepted values: ASC, DESC. The default is DESC.

\n","type":"text/plain"},"key":"order_by","value":""}],"variable":[]}},"response":[],"_postman_id":"d083f576-b81b-4a5d-9792-6fc507a65623"},{"name":"Create transaction","id":"338000d5-f05c-4994-b1c5-ebe504c61292","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"currency\": \"\",\n \"properties\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"partner\": {\n \"key_0\": \"\"\n },\n \"customer\": {\n \"key_0\": \"\"\n },\n \"deal\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"//v3/transactions","description":"

Create a new transaction and associate it with an existing customer.

\n

Example 1:
To associate the transaction with the customer ID 42, set the customer property to be:
\"customer\": { \"id\": 42 }

\n

Example 2:
To associate the transaction with the customer email \"john@doe.com\", set the customer property to be:
\"customer\": { \"email\": \"john@doe.com\" }

\n","urlObject":{"path":["v3","transactions"],"host":["/"],"query":[],"variable":[]}},"response":[{"id":"33f8a739-b3be-4b3a-9ffb-2fe0faedc945","name":"Transaction created","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"currency\": \"\",\n \"properties\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"partner\": {\n \"key_0\": \"\"\n },\n \"customer\": {\n \"key_0\": \"\"\n },\n \"deal\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"//v3/transactions"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"\",\n \"creationDate\": \"\",\n \"properties\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"customerId\": \"\",\n \"partnerId\": \"\",\n \"dealId\": \"\",\n \"currency\": \"\",\n \"isDeleted\": \"\",\n \"deletionDate\": \"\"\n}"},{"id":"c9623cd5-49f2-4551-a30c-b2d33d6856a0","name":"Invalid request","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"currency\": \"\",\n \"properties\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"partner\": {\n \"key_0\": \"\"\n },\n \"customer\": {\n \"key_0\": \"\"\n },\n \"deal\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"//v3/transactions"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"errorCode\": \"\",\n \"errorMessage\": \"\"\n}"}],"_postman_id":"338000d5-f05c-4994-b1c5-ebe504c61292"},{"name":"Get transaction","id":"eb540a16-d560-4635-988a-3d6001aab6f6","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"//v3/transactions/:id","description":"

Retrieve an existing transaction by id.

\n","urlObject":{"path":["v3","transactions",":id"],"host":["/"],"query":[],"variable":[{"id":"547c831f-3515-4f31-912b-605a3c06fa06","description":{"content":"

(Required) The ID of the transaction to return.

\n","type":"text/plain"},"type":"any","value":"","key":"id"}]}},"response":[],"_postman_id":"eb540a16-d560-4635-988a-3d6001aab6f6"},{"name":"Update transaction","id":"7441fb77-e7a8-4c2d-99c9-a1b65e3557a9","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"currency\": \"\",\n \"id\": \"\",\n \"properties\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"customerId\": \"\",\n \"dealId\": \"\",\n \"partnerId\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"//v3/transactions/:id","description":"

You must specify all properties in the properties field as this method will update the whole transaction.

\n","urlObject":{"path":["v3","transactions",":id"],"host":["/"],"query":[],"variable":[{"id":"5761397d-7329-42a7-b1db-6e8b1e97f375","description":{"content":"

(Required) The ID of the transaction to update.

\n","type":"text/plain"},"type":"any","value":"","key":"id"}]}},"response":[{"id":"90cfaf8d-3feb-4b1f-bb28-683e91ca1a3b","name":"Transaction updated","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"currency\": \"\",\n \"id\": \"\",\n \"properties\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"customerId\": \"\",\n \"dealId\": \"\",\n \"partnerId\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"//v3/transactions/:id","host":["/"],"path":["v3","transactions",":id"],"variable":[{"key":"id","value":"","description":"(Required) The ID of the transaction to update."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"\",\n \"creationDate\": \"\",\n \"properties\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"customerId\": \"\",\n \"partnerId\": \"\",\n \"dealId\": \"\",\n \"currency\": \"\",\n \"isDeleted\": \"\",\n \"deletionDate\": \"\"\n}"},{"id":"8ec1d1fe-e430-4724-9fbc-8ac906cd0544","name":"Transaction not found","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"currency\": \"\",\n \"id\": \"\",\n \"properties\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"customerId\": \"\",\n \"dealId\": \"\",\n \"partnerId\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"//v3/transactions/:id","host":["/"],"path":["v3","transactions",":id"],"variable":[{"key":"id","value":"","description":"(Required) The ID of the transaction to update."}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"errorCode\": \"\",\n \"errorMessage\": \"\"\n}"}],"_postman_id":"7441fb77-e7a8-4c2d-99c9-a1b65e3557a9"},{"name":"Delete transaction","id":"ecca9c7c-787a-493b-b1af-0866911cdd98","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"key":"Accept","value":"application/json"}],"url":"//v3/transactions/:id","urlObject":{"path":["v3","transactions",":id"],"host":["/"],"query":[],"variable":[{"id":"efb39f8b-8ca9-4c40-baef-5d6943ba0a60","description":{"content":"

(Required) The ID of the transaction to delete.

\n","type":"text/plain"},"type":"any","value":"","key":"id"}]}},"response":[{"id":"c8dca593-4ebb-4d64-904e-dbd6451f14f8","name":"Transaction deleted","originalRequest":{"method":"DELETE","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"//v3/transactions/:id","host":["/"],"path":["v3","transactions",":id"],"variable":[{"key":"id","value":"","description":"(Required) The ID of the transaction to delete."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":""},{"id":"26afdcd9-43dc-4bc2-8689-2293ccf55569","name":"Transaction not found","originalRequest":{"method":"DELETE","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"//v3/transactions/:id","host":["/"],"path":["v3","transactions",":id"],"variable":[{"key":"id","value":"","description":"(Required) The ID of the transaction to delete."}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"errorCode\": \"\",\n \"errorMessage\": \"\"\n}"}],"_postman_id":"ecca9c7c-787a-493b-b1af-0866911cdd98"}],"id":"2e628816-5558-46be-9f6f-af00e0cc9cf3","_postman_id":"2e628816-5558-46be-9f6f-af00e0cc9cf3","description":""}],"id":"30f37fb5-2a09-4d01-ab79-48618e344a23","_postman_id":"30f37fb5-2a09-4d01-ab79-48618e344a23","description":""},{"name":"Webhooks","item":[{"name":"Manage subscriptions","item":[{"name":"List subscriptions","id":"9ae3a7be-cd5d-4811-bbec-571f6668bf58","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"//v3/subscriptions","urlObject":{"path":["v3","subscriptions"],"host":["/"],"query":[],"variable":[]}},"response":[{"id":"7ac128c1-ae4b-447b-b5fb-5c9175b298c6","name":"Subscriptions returned","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"//v3/subscriptions"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"items\": [\n {\n \"id\": \"\",\n \"eventSource\": \"DealScheduledRewardValidation\",\n \"targetUrl\": \"\",\n \"version\": \"Unknown\"\n },\n {\n \"id\": \"\",\n \"eventSource\": \"CommentNew\",\n \"targetUrl\": \"\",\n \"version\": \"v3\"\n }\n ]\n}"}],"_postman_id":"9ae3a7be-cd5d-4811-bbec-571f6668bf58"},{"name":"Subscribe","id":"226d9d4c-b7ed-4ccd-8029-1d1211cba30f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"eventSource\": \"OnboardingStageStatusChanged\",\n \"targetUrl\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"//v3/subscriptions","description":"

Create a new subscription on a webhook.

\n

The payload contains the following fields:

\n
    \n
  • eventSource: the name of the webhook to subscribe for. Refer to the Events section to find the list of all available webhooks.
    • \n
  • targetUrl: the HTTP callback that will receive the webhook payloads.
    • \n
\n

The response contains the HTTP header Kiflo-Webhook-SigningKey. This is a randomly generated signing key used to sign webhook payloads.

\n

You must store it securely on your end as it will not be returned again.

\n","urlObject":{"path":["v3","subscriptions"],"host":["/"],"query":[],"variable":[]}},"response":[{"id":"dc344e2a-608b-4711-a05b-b4ffe9f40e02","name":"Subscription created. Check the `Kiflo-Webhook-SigningKey` response header for your signing key.","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"eventSource\": \"OnboardingStageStatusChanged\",\n \"targetUrl\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"//v3/subscriptions"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"226d9d4c-b7ed-4ccd-8029-1d1211cba30f"},{"name":"Unsubscribe","id":"9437312e-57f3-496d-9213-119d6863f65e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"key":"Accept","value":"application/json"}],"url":"//v3/subscriptions/:id","description":"

Delete an existing webhook subscription.

\n","urlObject":{"path":["v3","subscriptions",":id"],"host":["/"],"query":[],"variable":[{"id":"b8f862bc-8fc7-4acf-b6dc-9401545f69aa","description":{"content":"

(Required) ID of the subscription to delete.

\n","type":"text/plain"},"type":"any","value":"","key":"id"}]}},"response":[{"id":"1bc485b8-c448-42b8-98e0-d1073e5020d2","name":"Subscription deleted.","originalRequest":{"method":"DELETE","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"//v3/subscriptions/:id","host":["/"],"path":["v3","subscriptions",":id"],"variable":[{"key":"id","value":"","description":"(Required) ID of the subscription to delete."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"9437312e-57f3-496d-9213-119d6863f65e"}],"id":"fb4e45b5-55c3-44fc-bddf-a0ff58d76918","_postman_id":"fb4e45b5-55c3-44fc-bddf-a0ff58d76918","description":""},{"name":"Webhook format","item":[],"id":"975264e9-7b90-41e3-a30d-d13a68b8f378","description":"

Webhooks sent to the callback URLs use all the same format:

\n
{\n    \"hookSubscriptionId\": <integer>,\n    \"source\": <string>,\n    \"retryCount\": <integer>,\n    \"payload\": <object>\n}\n

The webhook contains the following fields:

\n
    \n
  • hookSubscriptionId: the ID of the subscription (can be used to unsubscribe).
    • \n
  • source: the webhook name (ex: DealNew, PartnerUpdate).
    • \n
  • retryCount: the number of time the webhook has been sent to the callback.
    • \n
  • payload: the payload which depends on the source. please check the Events section below to find payload examples for all webhooks.
    • \n
\n","_postman_id":"975264e9-7b90-41e3-a30d-d13a68b8f378"},{"name":"Webhook signature","item":[],"id":"01eb57e6-0c20-4486-84cd-28480b4c1ee3","description":"

Kiflo can sign webhook payloads and include the signature in the Kiflo-Webhook-Signature HTTP header. This allows you to verify the webhook is sent by Kiflo and not by a third-party attacker.

\n

Format

\n

The Kiflo-Webhook-Signature header looks like this:

\n
t=1643112283,v1=3ab40a1fbcc8abb99b05923ef06666793390ab8cdcfb95ed2ca9bf14d0d79612d3e863af82ac38b753a158e8aab1818b6eb6ff0f5cca3d79773b9a11eefd1cc7\n

t= is the timestamp when the webhook has been sent. It is the total number of seconds since Epoch.

\n

v1= is the hash-based message authentication code (HMAC) generated using SHA-512 algorithm. This is the hexadecimal representation.

\n

Validate the signature

\n

1. Prepare the signed_payload string

\n

The signed_payload string is the concatenation of:

\n
    \n
  • The timestamp as a string (total number of seconds since Epoch)
    • \n
  • The characeter .
    • \n
  • The actual JSON payload (the request body)
    • \n
\n

2. Compute the signature

\n

Compute the HMAC using SHA-512. Use the signing key returned during the webhook's subscription, and the signed_payload string as the message to be signed.

\n

3. Compare the signatures

\n

Compare the signature you've just computed with the signature returned in the Kiflo-Webhook-Signature header.

\n

You can either compare the string versions using the hexadecimal representation or directly comprare the bytes versions.

\n

Prevent replay attacks

\n

In order to prevent replay attacks, you can also check the t= variable with the time you've receive the webhook.

\n

If the timestamp included in the header is too old based on the choosen tolerance zone, you can reject the webhook.

\n","_postman_id":"01eb57e6-0c20-4486-84cd-28480b4c1ee3"},{"name":"Events","item":[{"name":"ContactNew","item":[],"id":"f07d5b07-bdbb-48e0-85bb-3403d4665797","description":"

Triggered when a new contact is created.

\n

Example payload:

\n
{\n  \"id\": 123,\n  \"creationDate\": \"2024-01-15T10:30:00Z\",\n  \"properties\": {\n    \"myCustomProperty\": \"value\"\n  }\n}\n
\n","_postman_id":"f07d5b07-bdbb-48e0-85bb-3403d4665797"},{"name":"ContactUpdate","item":[],"id":"304e066f-cbe0-421f-b365-69b4220295bd","description":"

Triggered when a contact is updated.

\n

Example payload:

\n
{\n  \"id\": 123,\n  \"creationDate\": \"2024-01-15T10:30:00Z\",\n  \"properties\": {\n    \"myCustomProperty\": \"value\"\n  }\n}\n
\n","_postman_id":"304e066f-cbe0-421f-b365-69b4220295bd"},{"name":"PartnerNew","item":[],"id":"974abedd-daa2-4494-9a27-3f34208f51aa","description":"

Triggered when a new partner is added.

\n

Example payload:

\n
{\n  \"id\": 123,\n  \"name\": \"value\",\n  \"properties\": {\n    \"myCustomProperty\": \"value\"\n  },\n  \"status\": \"value\",\n  \"onboardingStatus\": \"value\",\n  \"onboardingStageId\": 123,\n  \"prospectionStageId\": 123,\n  \"referralCode\": \"value\",\n  \"onboardingStage\": {\n    \"id\": 123,\n    \"name\": \"value\",\n    \"pipelineId\": 123,\n    \"pipelineName\": \"value\",\n    \"startedDate\": \"2024-01-15T10:30:00Z\",\n    \"completedDate\": \"2024-01-15T10:30:00Z\",\n    \"status\": \"value\",\n    \"pipeline\": {\n      \"id\": 123,\n      \"name\": \"value\",\n      \"startedDate\": \"2024-01-15T10:30:00Z\",\n      \"completedDate\": \"2024-01-15T10:30:00Z\",\n      \"onboardingStatus\": \"value\"\n    }\n  },\n  \"onboardingStages\": [\n    {\n      \"id\": 123,\n      \"name\": \"value\",\n      \"pipelineId\": 123,\n      \"pipelineName\": \"value\",\n      \"startedDate\": \"2024-01-15T10:30:00Z\",\n      \"completedDate\": \"2024-01-15T10:30:00Z\",\n      \"status\": \"value\",\n      \"pipeline\": {\n        \"id\": 123,\n        \"name\": \"value\",\n        \"startedDate\": \"2024-01-15T10:30:00Z\",\n        \"completedDate\": \"2024-01-15T10:30:00Z\",\n        \"onboardingStatus\": \"value\"\n      }\n    }\n  ],\n  \"prospectionStage\": {\n    \"id\": 123,\n    \"name\": \"value\"\n  },\n  \"programs\": [\n    {\n      \"id\": 123,\n      \"name\": \"value\",\n      \"levelId\": 123,\n      \"levelName\": \"value\"\n    }\n  ],\n  \"mainContact\": {\n    \"id\": 123,\n    \"email\": \"value\",\n    \"firstName\": \"value\",\n    \"lastName\": \"value\",\n    \"jobTitle\": \"value\",\n    \"phoneNumber\": \"value\",\n    \"linkedInProfileUrl\": \"value\",\n    \"accountActivationUrl\": \"value\",\n    \"partnerId\": 123,\n    \"isMainContact\": true\n  },\n  \"owner\": {\n    \"id\": 123,\n    \"email\": \"value\",\n    \"firstName\": \"value\",\n    \"lastName\": \"value\",\n    \"partnerId\": 123,\n    \"partnerName\": \"value\"\n  }\n}\n
\n","_postman_id":"974abedd-daa2-4494-9a27-3f34208f51aa"},{"name":"PartnerUpdate","item":[],"id":"2bb08ca7-a5fe-45e1-b3ef-40ce122bb599","description":"

Triggered when a partner is updated.

\n

Example payload:

\n
{\n  \"id\": 123,\n  \"name\": \"value\",\n  \"properties\": {\n    \"myCustomProperty\": \"value\"\n  },\n  \"status\": \"value\",\n  \"onboardingStatus\": \"value\",\n  \"onboardingStageId\": 123,\n  \"prospectionStageId\": 123,\n  \"referralCode\": \"value\",\n  \"onboardingStage\": {\n    \"id\": 123,\n    \"name\": \"value\",\n    \"pipelineId\": 123,\n    \"pipelineName\": \"value\",\n    \"startedDate\": \"2024-01-15T10:30:00Z\",\n    \"completedDate\": \"2024-01-15T10:30:00Z\",\n    \"status\": \"value\",\n    \"pipeline\": {\n      \"id\": 123,\n      \"name\": \"value\",\n      \"startedDate\": \"2024-01-15T10:30:00Z\",\n      \"completedDate\": \"2024-01-15T10:30:00Z\",\n      \"onboardingStatus\": \"value\"\n    }\n  },\n  \"onboardingStages\": [\n    {\n      \"id\": 123,\n      \"name\": \"value\",\n      \"pipelineId\": 123,\n      \"pipelineName\": \"value\",\n      \"startedDate\": \"2024-01-15T10:30:00Z\",\n      \"completedDate\": \"2024-01-15T10:30:00Z\",\n      \"status\": \"value\",\n      \"pipeline\": {\n        \"id\": 123,\n        \"name\": \"value\",\n        \"startedDate\": \"2024-01-15T10:30:00Z\",\n        \"completedDate\": \"2024-01-15T10:30:00Z\",\n        \"onboardingStatus\": \"value\"\n      }\n    }\n  ],\n  \"prospectionStage\": {\n    \"id\": 123,\n    \"name\": \"value\"\n  },\n  \"programs\": [\n    {\n      \"id\": 123,\n      \"name\": \"value\",\n      \"levelId\": 123,\n      \"levelName\": \"value\"\n    }\n  ],\n  \"mainContact\": {\n    \"id\": 123,\n    \"email\": \"value\",\n    \"firstName\": \"value\",\n    \"lastName\": \"value\",\n    \"jobTitle\": \"value\",\n    \"phoneNumber\": \"value\",\n    \"linkedInProfileUrl\": \"value\",\n    \"accountActivationUrl\": \"value\",\n    \"partnerId\": 123,\n    \"isMainContact\": true\n  },\n  \"owner\": {\n    \"id\": 123,\n    \"email\": \"value\",\n    \"firstName\": \"value\",\n    \"lastName\": \"value\",\n    \"partnerId\": 123,\n    \"partnerName\": \"value\"\n  }\n}\n
\n","_postman_id":"2bb08ca7-a5fe-45e1-b3ef-40ce122bb599"},{"name":"PartnerNote","item":[],"id":"8016a85d-af54-4e88-b80c-075a5cf94ef3","description":"

Triggered when a note is added on a partner.

\n

Example payload:

\n
{\n  \"id\": 123,\n  \"content\": \"value\",\n  \"isSynced\": true,\n  \"isFromPartner\": true,\n  \"createdByPartnerId\": 123,\n  \"creationDate\": \"2024-01-15T10:30:00Z\",\n  \"author\": {\n    \"id\": 123,\n    \"email\": \"value\",\n    \"firstName\": \"value\",\n    \"lastName\": \"value\",\n    \"partnerId\": 123,\n    \"partnerName\": \"value\"\n  },\n  \"leadId\": 123,\n  \"dealId\": 123,\n  \"partnerId\": 123,\n  \"customerId\": 123\n}\n
\n","_postman_id":"8016a85d-af54-4e88-b80c-075a5cf94ef3"},{"name":"PartnerOnboardingStageUpdate","item":[],"id":"6339b0a9-d7aa-420f-80e7-e535472afaf8","description":"

Triggered when a partner enters a new onboarding stage.

\n

Example payload:

\n
{\n  \"id\": 123,\n  \"name\": \"value\",\n  \"properties\": {\n    \"myCustomProperty\": \"value\"\n  },\n  \"status\": \"value\",\n  \"onboardingStatus\": \"value\",\n  \"onboardingStageId\": 123,\n  \"prospectionStageId\": 123,\n  \"referralCode\": \"value\",\n  \"onboardingStage\": {\n    \"id\": 123,\n    \"name\": \"value\",\n    \"pipelineId\": 123,\n    \"pipelineName\": \"value\",\n    \"startedDate\": \"2024-01-15T10:30:00Z\",\n    \"completedDate\": \"2024-01-15T10:30:00Z\",\n    \"status\": \"value\",\n    \"pipeline\": {\n      \"id\": 123,\n      \"name\": \"value\",\n      \"startedDate\": \"2024-01-15T10:30:00Z\",\n      \"completedDate\": \"2024-01-15T10:30:00Z\",\n      \"onboardingStatus\": \"value\"\n    }\n  },\n  \"onboardingStages\": [\n    {\n      \"id\": 123,\n      \"name\": \"value\",\n      \"pipelineId\": 123,\n      \"pipelineName\": \"value\",\n      \"startedDate\": \"2024-01-15T10:30:00Z\",\n      \"completedDate\": \"2024-01-15T10:30:00Z\",\n      \"status\": \"value\",\n      \"pipeline\": {\n        \"id\": 123,\n        \"name\": \"value\",\n        \"startedDate\": \"2024-01-15T10:30:00Z\",\n        \"completedDate\": \"2024-01-15T10:30:00Z\",\n        \"onboardingStatus\": \"value\"\n      }\n    }\n  ],\n  \"prospectionStage\": {\n    \"id\": 123,\n    \"name\": \"value\"\n  },\n  \"programs\": [\n    {\n      \"id\": 123,\n      \"name\": \"value\",\n      \"levelId\": 123,\n      \"levelName\": \"value\"\n    }\n  ],\n  \"mainContact\": {\n    \"id\": 123,\n    \"email\": \"value\",\n    \"firstName\": \"value\",\n    \"lastName\": \"value\",\n    \"jobTitle\": \"value\",\n    \"phoneNumber\": \"value\",\n    \"linkedInProfileUrl\": \"value\",\n    \"accountActivationUrl\": \"value\",\n    \"partnerId\": 123,\n    \"isMainContact\": true\n  },\n  \"owner\": {\n    \"id\": 123,\n    \"email\": \"value\",\n    \"firstName\": \"value\",\n    \"lastName\": \"value\",\n    \"partnerId\": 123,\n    \"partnerName\": \"value\"\n  }\n}\n
\n","_postman_id":"6339b0a9-d7aa-420f-80e7-e535472afaf8"},{"name":"PartnerApplicationNew","item":[],"id":"6d8d7805-13c9-4a32-847b-7398dab82129","description":"

Triggered when a new partner applied for a program.

\n

Example payload:

\n
{\n  \"partner\": {\n    \"id\": 123,\n    \"name\": \"value\",\n    \"properties\": {\n      \"myCustomProperty\": \"value\"\n    },\n    \"status\": \"value\",\n    \"onboardingStatus\": \"value\",\n    \"onboardingStageId\": 123,\n    \"prospectionStageId\": 123,\n    \"referralCode\": \"value\",\n    \"onboardingStage\": {\n      \"id\": 123,\n      \"name\": \"value\",\n      \"pipelineId\": 123,\n      \"pipelineName\": \"value\",\n      \"startedDate\": \"2024-01-15T10:30:00Z\",\n      \"completedDate\": \"2024-01-15T10:30:00Z\",\n      \"status\": \"value\",\n      \"pipeline\": {\n        \"id\": 123,\n        \"name\": \"value\",\n        \"startedDate\": \"2024-01-15T10:30:00Z\",\n        \"completedDate\": \"2024-01-15T10:30:00Z\",\n        \"onboardingStatus\": \"value\"\n      }\n    },\n    \"onboardingStages\": [\n      {\n        \"id\": 123,\n        \"name\": \"value\",\n        \"pipelineId\": 123,\n        \"pipelineName\": \"value\",\n        \"startedDate\": \"2024-01-15T10:30:00Z\",\n        \"completedDate\": \"2024-01-15T10:30:00Z\",\n        \"status\": \"value\",\n        \"pipeline\": {\n          \"id\": 123,\n          \"name\": \"value\",\n          \"startedDate\": \"2024-01-15T10:30:00Z\",\n          \"completedDate\": \"2024-01-15T10:30:00Z\",\n          \"onboardingStatus\": \"value\"\n        }\n      }\n    ],\n    \"prospectionStage\": {\n      \"id\": 123,\n      \"name\": \"value\"\n    },\n    \"programs\": [\n      {\n        \"id\": 123,\n        \"name\": \"value\",\n        \"levelId\": 123,\n        \"levelName\": \"value\"\n      }\n    ],\n    \"mainContact\": {\n      \"id\": 123,\n      \"email\": \"value\",\n      \"firstName\": \"value\",\n      \"lastName\": \"value\",\n      \"jobTitle\": \"value\",\n      \"phoneNumber\": \"value\",\n      \"linkedInProfileUrl\": \"value\",\n      \"accountActivationUrl\": \"value\",\n      \"partnerId\": 123,\n      \"isMainContact\": true\n    },\n    \"owner\": {\n      \"id\": 123,\n      \"email\": \"value\",\n      \"firstName\": \"value\",\n      \"lastName\": \"value\",\n      \"partnerId\": 123,\n      \"partnerName\": \"value\"\n    }\n  },\n  \"program\": {\n    \"id\": 123,\n    \"name\": \"value\",\n    \"levelId\": 123,\n    \"levelName\": \"value\"\n  }\n}\n
\n","_postman_id":"6d8d7805-13c9-4a32-847b-7398dab82129"},{"name":"PartnerApplicationAccepted","item":[],"id":"f0e500a2-53fb-4be2-9afe-f089b7a7b9e9","description":"

Triggered when partner application is accepted.

\n

Example payload:

\n
{\n  \"partner\": {\n    \"id\": 123,\n    \"name\": \"value\",\n    \"properties\": {\n      \"myCustomProperty\": \"value\"\n    },\n    \"status\": \"value\",\n    \"onboardingStatus\": \"value\",\n    \"onboardingStageId\": 123,\n    \"prospectionStageId\": 123,\n    \"referralCode\": \"value\",\n    \"onboardingStage\": {\n      \"id\": 123,\n      \"name\": \"value\",\n      \"pipelineId\": 123,\n      \"pipelineName\": \"value\",\n      \"startedDate\": \"2024-01-15T10:30:00Z\",\n      \"completedDate\": \"2024-01-15T10:30:00Z\",\n      \"status\": \"value\",\n      \"pipeline\": {\n        \"id\": 123,\n        \"name\": \"value\",\n        \"startedDate\": \"2024-01-15T10:30:00Z\",\n        \"completedDate\": \"2024-01-15T10:30:00Z\",\n        \"onboardingStatus\": \"value\"\n      }\n    },\n    \"onboardingStages\": [\n      {\n        \"id\": 123,\n        \"name\": \"value\",\n        \"pipelineId\": 123,\n        \"pipelineName\": \"value\",\n        \"startedDate\": \"2024-01-15T10:30:00Z\",\n        \"completedDate\": \"2024-01-15T10:30:00Z\",\n        \"status\": \"value\",\n        \"pipeline\": {\n          \"id\": 123,\n          \"name\": \"value\",\n          \"startedDate\": \"2024-01-15T10:30:00Z\",\n          \"completedDate\": \"2024-01-15T10:30:00Z\",\n          \"onboardingStatus\": \"value\"\n        }\n      }\n    ],\n    \"prospectionStage\": {\n      \"id\": 123,\n      \"name\": \"value\"\n    },\n    \"programs\": [\n      {\n        \"id\": 123,\n        \"name\": \"value\",\n        \"levelId\": 123,\n        \"levelName\": \"value\"\n      }\n    ],\n    \"mainContact\": {\n      \"id\": 123,\n      \"email\": \"value\",\n      \"firstName\": \"value\",\n      \"lastName\": \"value\",\n      \"jobTitle\": \"value\",\n      \"phoneNumber\": \"value\",\n      \"linkedInProfileUrl\": \"value\",\n      \"accountActivationUrl\": \"value\",\n      \"partnerId\": 123,\n      \"isMainContact\": true\n    },\n    \"owner\": {\n      \"id\": 123,\n      \"email\": \"value\",\n      \"firstName\": \"value\",\n      \"lastName\": \"value\",\n      \"partnerId\": 123,\n      \"partnerName\": \"value\"\n    }\n  },\n  \"program\": {\n    \"id\": 123,\n    \"name\": \"value\",\n    \"levelId\": 123,\n    \"levelName\": \"value\"\n  }\n}\n
\n","_postman_id":"f0e500a2-53fb-4be2-9afe-f089b7a7b9e9"},{"name":"PartnerApplicationRejected","item":[],"id":"f605471c-c6a9-4a42-8e14-6607c42a3853","description":"

Triggered when partner application is rejected.

\n

Example payload:

\n
{\n  \"partner\": {\n    \"id\": 123,\n    \"name\": \"value\",\n    \"properties\": {\n      \"myCustomProperty\": \"value\"\n    },\n    \"status\": \"value\",\n    \"onboardingStatus\": \"value\",\n    \"onboardingStageId\": 123,\n    \"prospectionStageId\": 123,\n    \"referralCode\": \"value\",\n    \"onboardingStage\": {\n      \"id\": 123,\n      \"name\": \"value\",\n      \"pipelineId\": 123,\n      \"pipelineName\": \"value\",\n      \"startedDate\": \"2024-01-15T10:30:00Z\",\n      \"completedDate\": \"2024-01-15T10:30:00Z\",\n      \"status\": \"value\",\n      \"pipeline\": {\n        \"id\": 123,\n        \"name\": \"value\",\n        \"startedDate\": \"2024-01-15T10:30:00Z\",\n        \"completedDate\": \"2024-01-15T10:30:00Z\",\n        \"onboardingStatus\": \"value\"\n      }\n    },\n    \"onboardingStages\": [\n      {\n        \"id\": 123,\n        \"name\": \"value\",\n        \"pipelineId\": 123,\n        \"pipelineName\": \"value\",\n        \"startedDate\": \"2024-01-15T10:30:00Z\",\n        \"completedDate\": \"2024-01-15T10:30:00Z\",\n        \"status\": \"value\",\n        \"pipeline\": {\n          \"id\": 123,\n          \"name\": \"value\",\n          \"startedDate\": \"2024-01-15T10:30:00Z\",\n          \"completedDate\": \"2024-01-15T10:30:00Z\",\n          \"onboardingStatus\": \"value\"\n        }\n      }\n    ],\n    \"prospectionStage\": {\n      \"id\": 123,\n      \"name\": \"value\"\n    },\n    \"programs\": [\n      {\n        \"id\": 123,\n        \"name\": \"value\",\n        \"levelId\": 123,\n        \"levelName\": \"value\"\n      }\n    ],\n    \"mainContact\": {\n      \"id\": 123,\n      \"email\": \"value\",\n      \"firstName\": \"value\",\n      \"lastName\": \"value\",\n      \"jobTitle\": \"value\",\n      \"phoneNumber\": \"value\",\n      \"linkedInProfileUrl\": \"value\",\n      \"accountActivationUrl\": \"value\",\n      \"partnerId\": 123,\n      \"isMainContact\": true\n    },\n    \"owner\": {\n      \"id\": 123,\n      \"email\": \"value\",\n      \"firstName\": \"value\",\n      \"lastName\": \"value\",\n      \"partnerId\": 123,\n      \"partnerName\": \"value\"\n    }\n  },\n  \"program\": {\n    \"id\": 123,\n    \"name\": \"value\",\n    \"levelId\": 123,\n    \"levelName\": \"value\"\n  }\n}\n
\n","_postman_id":"f605471c-c6a9-4a42-8e14-6607c42a3853"},{"name":"TeamMemberAdded","item":[],"id":"214b8ecc-351a-4310-9a83-1b2a19dab256","description":"

Triggered when a team member is added to a partner.

\n

Example payload:

\n
{\n  \"id\": 123,\n  \"email\": \"value\",\n  \"firstName\": \"value\",\n  \"lastName\": \"value\",\n  \"jobTitle\": \"value\",\n  \"phoneNumber\": \"value\",\n  \"linkedInProfileUrl\": \"value\",\n  \"accountActivationUrl\": \"value\",\n  \"partnerId\": 123,\n  \"isMainContact\": true\n}\n
\n","_postman_id":"214b8ecc-351a-4310-9a83-1b2a19dab256"},{"name":"TeamMemberDeleted","item":[],"id":"96c789de-88f6-4400-99ca-dc4b7be171d9","description":"

Triggered when a team member is removed from a partner.

\n

Example payload:

\n
{\n  \"id\": 123,\n  \"email\": \"value\",\n  \"firstName\": \"value\",\n  \"lastName\": \"value\",\n  \"jobTitle\": \"value\",\n  \"phoneNumber\": \"value\",\n  \"linkedInProfileUrl\": \"value\",\n  \"accountActivationUrl\": \"value\",\n  \"partnerId\": 123,\n  \"isMainContact\": true\n}\n
\n","_postman_id":"96c789de-88f6-4400-99ca-dc4b7be171d9"},{"name":"DealNew","item":[],"id":"dcace108-7a34-435b-a16b-7c4b89d96bd0","description":"

Triggered when a new deal is created.

\n

Example payload:

\n
{\n  \"id\": 123,\n  \"contactId\": 123,\n  \"sourcePartnerId\": 123,\n  \"stage\": \"value\",\n  \"currency\": \"value\",\n  \"creationDate\": \"2024-01-15T10:30:00Z\",\n  \"totalAmount\": 123.45,\n  \"properties\": {\n    \"myCustomProperty\": \"value\"\n  },\n  \"sourceLeadId\": 123,\n  \"status\": \"value\",\n  \"partners\": [\n    {\n      \"id\": 123,\n      \"dealId\": 123,\n      \"userPartnerOwnerId\": 123,\n      \"userPartnerOwnerName\": \"value\",\n      \"userPartnerFirstName\": \"value\",\n      \"userPartnerLastName\": \"value\",\n      \"userPartnerEmail\": \"value\",\n      \"userPartnerJobTitle\": \"value\",\n      \"userPartnerPhoneNumber\": \"value\",\n      \"userPartnerLinkedInProfileUrl\": \"value\",\n      \"partnerId\": 123,\n      \"partnerTypeId\": 123,\n      \"creationDate\": \"2024-01-15T10:30:00Z\",\n      \"partnerName\": \"value\",\n      \"partnerType\": \"value\"\n    }\n  ],\n  \"contractStartDate\": \"2024-01-15T10:30:00Z\",\n  \"contractEndDate\": \"2024-01-15T10:30:00Z\",\n  \"ownerUserId\": 123,\n  \"owner\": {\n    \"id\": 123,\n    \"email\": \"value\",\n    \"firstName\": \"value\",\n    \"lastName\": \"value\",\n    \"partnerId\": 123,\n    \"partnerName\": \"value\"\n  },\n  \"closeDate\": \"2024-01-15T10:30:00Z\",\n  \"acceptedDate\": \"2024-01-15T10:30:00Z\",\n  \"refusedDate\": \"2024-01-15T10:30:00Z\",\n  \"customerId\": 123,\n  \"contact\": {\n    \"id\": 123,\n    \"creationDate\": \"2024-01-15T10:30:00Z\",\n    \"properties\": {\n      \"myCustomProperty\": \"value\"\n    }\n  },\n  \"sourceName\": \"value\",\n  \"sourcePartner\": {\n    \"id\": 123,\n    \"name\": \"value\",\n    \"properties\": {\n      \"myCustomProperty\": \"value\"\n    },\n    \"status\": \"value\",\n    \"onboardingStatus\": \"value\",\n    \"onboardingStageId\": 123,\n    \"prospectionStageId\": 123,\n    \"referralCode\": \"value\",\n    \"onboardingStage\": {\n      \"id\": 123,\n      \"name\": \"value\",\n      \"pipelineId\": 123,\n      \"pipelineName\": \"value\",\n      \"startedDate\": \"2024-01-15T10:30:00Z\",\n      \"completedDate\": \"2024-01-15T10:30:00Z\",\n      \"status\": \"value\",\n      \"pipeline\": {\n        \"id\": 123,\n        \"name\": \"value\",\n        \"startedDate\": \"2024-01-15T10:30:00Z\",\n        \"completedDate\": \"2024-01-15T10:30:00Z\",\n        \"onboardingStatus\": \"value\"\n      }\n    },\n    \"onboardingStages\": [\n      {\n        \"id\": 123,\n        \"name\": \"value\",\n        \"pipelineId\": 123,\n        \"pipelineName\": \"value\",\n        \"startedDate\": \"2024-01-15T10:30:00Z\",\n        \"completedDate\": \"2024-01-15T10:30:00Z\",\n        \"status\": \"value\",\n        \"pipeline\": {\n          \"id\": 123,\n          \"name\": \"value\",\n          \"startedDate\": \"2024-01-15T10:30:00Z\",\n          \"completedDate\": \"2024-01-15T10:30:00Z\",\n          \"onboardingStatus\": \"value\"\n        }\n      }\n    ],\n    \"prospectionStage\": {\n      \"id\": 123,\n      \"name\": \"value\"\n    },\n    \"programs\": [\n      {\n        \"id\": 123,\n        \"name\": \"value\",\n        \"levelId\": 123,\n        \"levelName\": \"value\"\n      }\n    ],\n    \"mainContact\": {\n      \"id\": 123,\n      \"email\": \"value\",\n      \"firstName\": \"value\",\n      \"lastName\": \"value\",\n      \"jobTitle\": \"value\",\n      \"phoneNumber\": \"value\",\n      \"linkedInProfileUrl\": \"value\",\n      \"accountActivationUrl\": \"value\",\n      \"partnerId\": 123,\n      \"isMainContact\": true\n    },\n    \"owner\": {\n      \"id\": 123,\n      \"email\": \"value\",\n      \"firstName\": \"value\",\n      \"lastName\": \"value\",\n      \"partnerId\": 123,\n      \"partnerName\": \"value\"\n    }\n  }\n}\n
\n","_postman_id":"dcace108-7a34-435b-a16b-7c4b89d96bd0"},{"name":"DealUpdate","item":[],"id":"1963663f-4b7c-4149-a455-cc3052fa1825","description":"

Triggered when a deal is updated.

\n

Example payload:

\n
{\n  \"id\": 123,\n  \"contactId\": 123,\n  \"sourcePartnerId\": 123,\n  \"stage\": \"value\",\n  \"currency\": \"value\",\n  \"creationDate\": \"2024-01-15T10:30:00Z\",\n  \"totalAmount\": 123.45,\n  \"properties\": {\n    \"myCustomProperty\": \"value\"\n  },\n  \"sourceLeadId\": 123,\n  \"status\": \"value\",\n  \"partners\": [\n    {\n      \"id\": 123,\n      \"dealId\": 123,\n      \"userPartnerOwnerId\": 123,\n      \"userPartnerOwnerName\": \"value\",\n      \"userPartnerFirstName\": \"value\",\n      \"userPartnerLastName\": \"value\",\n      \"userPartnerEmail\": \"value\",\n      \"userPartnerJobTitle\": \"value\",\n      \"userPartnerPhoneNumber\": \"value\",\n      \"userPartnerLinkedInProfileUrl\": \"value\",\n      \"partnerId\": 123,\n      \"partnerTypeId\": 123,\n      \"creationDate\": \"2024-01-15T10:30:00Z\",\n      \"partnerName\": \"value\",\n      \"partnerType\": \"value\"\n    }\n  ],\n  \"contractStartDate\": \"2024-01-15T10:30:00Z\",\n  \"contractEndDate\": \"2024-01-15T10:30:00Z\",\n  \"ownerUserId\": 123,\n  \"owner\": {\n    \"id\": 123,\n    \"email\": \"value\",\n    \"firstName\": \"value\",\n    \"lastName\": \"value\",\n    \"partnerId\": 123,\n    \"partnerName\": \"value\"\n  },\n  \"closeDate\": \"2024-01-15T10:30:00Z\",\n  \"acceptedDate\": \"2024-01-15T10:30:00Z\",\n  \"refusedDate\": \"2024-01-15T10:30:00Z\",\n  \"customerId\": 123,\n  \"contact\": {\n    \"id\": 123,\n    \"creationDate\": \"2024-01-15T10:30:00Z\",\n    \"properties\": {\n      \"myCustomProperty\": \"value\"\n    }\n  },\n  \"sourceName\": \"value\",\n  \"sourcePartner\": {\n    \"id\": 123,\n    \"name\": \"value\",\n    \"properties\": {\n      \"myCustomProperty\": \"value\"\n    },\n    \"status\": \"value\",\n    \"onboardingStatus\": \"value\",\n    \"onboardingStageId\": 123,\n    \"prospectionStageId\": 123,\n    \"referralCode\": \"value\",\n    \"onboardingStage\": {\n      \"id\": 123,\n      \"name\": \"value\",\n      \"pipelineId\": 123,\n      \"pipelineName\": \"value\",\n      \"startedDate\": \"2024-01-15T10:30:00Z\",\n      \"completedDate\": \"2024-01-15T10:30:00Z\",\n      \"status\": \"value\",\n      \"pipeline\": {\n        \"id\": 123,\n        \"name\": \"value\",\n        \"startedDate\": \"2024-01-15T10:30:00Z\",\n        \"completedDate\": \"2024-01-15T10:30:00Z\",\n        \"onboardingStatus\": \"value\"\n      }\n    },\n    \"onboardingStages\": [\n      {\n        \"id\": 123,\n        \"name\": \"value\",\n        \"pipelineId\": 123,\n        \"pipelineName\": \"value\",\n        \"startedDate\": \"2024-01-15T10:30:00Z\",\n        \"completedDate\": \"2024-01-15T10:30:00Z\",\n        \"status\": \"value\",\n        \"pipeline\": {\n          \"id\": 123,\n          \"name\": \"value\",\n          \"startedDate\": \"2024-01-15T10:30:00Z\",\n          \"completedDate\": \"2024-01-15T10:30:00Z\",\n          \"onboardingStatus\": \"value\"\n        }\n      }\n    ],\n    \"prospectionStage\": {\n      \"id\": 123,\n      \"name\": \"value\"\n    },\n    \"programs\": [\n      {\n        \"id\": 123,\n        \"name\": \"value\",\n        \"levelId\": 123,\n        \"levelName\": \"value\"\n      }\n    ],\n    \"mainContact\": {\n      \"id\": 123,\n      \"email\": \"value\",\n      \"firstName\": \"value\",\n      \"lastName\": \"value\",\n      \"jobTitle\": \"value\",\n      \"phoneNumber\": \"value\",\n      \"linkedInProfileUrl\": \"value\",\n      \"accountActivationUrl\": \"value\",\n      \"partnerId\": 123,\n      \"isMainContact\": true\n    },\n    \"owner\": {\n      \"id\": 123,\n      \"email\": \"value\",\n      \"firstName\": \"value\",\n      \"lastName\": \"value\",\n      \"partnerId\": 123,\n      \"partnerName\": \"value\"\n    }\n  }\n}\n
\n","_postman_id":"1963663f-4b7c-4149-a455-cc3052fa1825"},{"name":"DealAccept","item":[],"id":"41cbcca4-a5ff-4374-b184-6dc2497d453e","description":"

Triggered when a deal is accepted.

\n

Example payload:

\n
{\n  \"id\": 123,\n  \"contactId\": 123,\n  \"sourcePartnerId\": 123,\n  \"stage\": \"value\",\n  \"currency\": \"value\",\n  \"creationDate\": \"2024-01-15T10:30:00Z\",\n  \"totalAmount\": 123.45,\n  \"properties\": {\n    \"myCustomProperty\": \"value\"\n  },\n  \"sourceLeadId\": 123,\n  \"status\": \"value\",\n  \"partners\": [\n    {\n      \"id\": 123,\n      \"dealId\": 123,\n      \"userPartnerOwnerId\": 123,\n      \"userPartnerOwnerName\": \"value\",\n      \"userPartnerFirstName\": \"value\",\n      \"userPartnerLastName\": \"value\",\n      \"userPartnerEmail\": \"value\",\n      \"userPartnerJobTitle\": \"value\",\n      \"userPartnerPhoneNumber\": \"value\",\n      \"userPartnerLinkedInProfileUrl\": \"value\",\n      \"partnerId\": 123,\n      \"partnerTypeId\": 123,\n      \"creationDate\": \"2024-01-15T10:30:00Z\",\n      \"partnerName\": \"value\",\n      \"partnerType\": \"value\"\n    }\n  ],\n  \"contractStartDate\": \"2024-01-15T10:30:00Z\",\n  \"contractEndDate\": \"2024-01-15T10:30:00Z\",\n  \"ownerUserId\": 123,\n  \"owner\": {\n    \"id\": 123,\n    \"email\": \"value\",\n    \"firstName\": \"value\",\n    \"lastName\": \"value\",\n    \"partnerId\": 123,\n    \"partnerName\": \"value\"\n  },\n  \"closeDate\": \"2024-01-15T10:30:00Z\",\n  \"acceptedDate\": \"2024-01-15T10:30:00Z\",\n  \"refusedDate\": \"2024-01-15T10:30:00Z\",\n  \"customerId\": 123,\n  \"contact\": {\n    \"id\": 123,\n    \"creationDate\": \"2024-01-15T10:30:00Z\",\n    \"properties\": {\n      \"myCustomProperty\": \"value\"\n    }\n  },\n  \"sourceName\": \"value\",\n  \"sourcePartner\": {\n    \"id\": 123,\n    \"name\": \"value\",\n    \"properties\": {\n      \"myCustomProperty\": \"value\"\n    },\n    \"status\": \"value\",\n    \"onboardingStatus\": \"value\",\n    \"onboardingStageId\": 123,\n    \"prospectionStageId\": 123,\n    \"referralCode\": \"value\",\n    \"onboardingStage\": {\n      \"id\": 123,\n      \"name\": \"value\",\n      \"pipelineId\": 123,\n      \"pipelineName\": \"value\",\n      \"startedDate\": \"2024-01-15T10:30:00Z\",\n      \"completedDate\": \"2024-01-15T10:30:00Z\",\n      \"status\": \"value\",\n      \"pipeline\": {\n        \"id\": 123,\n        \"name\": \"value\",\n        \"startedDate\": \"2024-01-15T10:30:00Z\",\n        \"completedDate\": \"2024-01-15T10:30:00Z\",\n        \"onboardingStatus\": \"value\"\n      }\n    },\n    \"onboardingStages\": [\n      {\n        \"id\": 123,\n        \"name\": \"value\",\n        \"pipelineId\": 123,\n        \"pipelineName\": \"value\",\n        \"startedDate\": \"2024-01-15T10:30:00Z\",\n        \"completedDate\": \"2024-01-15T10:30:00Z\",\n        \"status\": \"value\",\n        \"pipeline\": {\n          \"id\": 123,\n          \"name\": \"value\",\n          \"startedDate\": \"2024-01-15T10:30:00Z\",\n          \"completedDate\": \"2024-01-15T10:30:00Z\",\n          \"onboardingStatus\": \"value\"\n        }\n      }\n    ],\n    \"prospectionStage\": {\n      \"id\": 123,\n      \"name\": \"value\"\n    },\n    \"programs\": [\n      {\n        \"id\": 123,\n        \"name\": \"value\",\n        \"levelId\": 123,\n        \"levelName\": \"value\"\n      }\n    ],\n    \"mainContact\": {\n      \"id\": 123,\n      \"email\": \"value\",\n      \"firstName\": \"value\",\n      \"lastName\": \"value\",\n      \"jobTitle\": \"value\",\n      \"phoneNumber\": \"value\",\n      \"linkedInProfileUrl\": \"value\",\n      \"accountActivationUrl\": \"value\",\n      \"partnerId\": 123,\n      \"isMainContact\": true\n    },\n    \"owner\": {\n      \"id\": 123,\n      \"email\": \"value\",\n      \"firstName\": \"value\",\n      \"lastName\": \"value\",\n      \"partnerId\": 123,\n      \"partnerName\": \"value\"\n    }\n  }\n}\n
\n","_postman_id":"41cbcca4-a5ff-4374-b184-6dc2497d453e"},{"name":"DealRefuse","item":[],"id":"020eaa38-f4ac-4661-8e47-ac24e6fdc6fd","description":"

Triggered when a deal is refused.

\n

Example payload:

\n
{\n  \"id\": 123,\n  \"contactId\": 123,\n  \"sourcePartnerId\": 123,\n  \"stage\": \"value\",\n  \"currency\": \"value\",\n  \"creationDate\": \"2024-01-15T10:30:00Z\",\n  \"totalAmount\": 123.45,\n  \"properties\": {\n    \"myCustomProperty\": \"value\"\n  },\n  \"sourceLeadId\": 123,\n  \"status\": \"value\",\n  \"partners\": [\n    {\n      \"id\": 123,\n      \"dealId\": 123,\n      \"userPartnerOwnerId\": 123,\n      \"userPartnerOwnerName\": \"value\",\n      \"userPartnerFirstName\": \"value\",\n      \"userPartnerLastName\": \"value\",\n      \"userPartnerEmail\": \"value\",\n      \"userPartnerJobTitle\": \"value\",\n      \"userPartnerPhoneNumber\": \"value\",\n      \"userPartnerLinkedInProfileUrl\": \"value\",\n      \"partnerId\": 123,\n      \"partnerTypeId\": 123,\n      \"creationDate\": \"2024-01-15T10:30:00Z\",\n      \"partnerName\": \"value\",\n      \"partnerType\": \"value\"\n    }\n  ],\n  \"contractStartDate\": \"2024-01-15T10:30:00Z\",\n  \"contractEndDate\": \"2024-01-15T10:30:00Z\",\n  \"ownerUserId\": 123,\n  \"owner\": {\n    \"id\": 123,\n    \"email\": \"value\",\n    \"firstName\": \"value\",\n    \"lastName\": \"value\",\n    \"partnerId\": 123,\n    \"partnerName\": \"value\"\n  },\n  \"closeDate\": \"2024-01-15T10:30:00Z\",\n  \"acceptedDate\": \"2024-01-15T10:30:00Z\",\n  \"refusedDate\": \"2024-01-15T10:30:00Z\",\n  \"customerId\": 123,\n  \"contact\": {\n    \"id\": 123,\n    \"creationDate\": \"2024-01-15T10:30:00Z\",\n    \"properties\": {\n      \"myCustomProperty\": \"value\"\n    }\n  },\n  \"sourceName\": \"value\",\n  \"sourcePartner\": {\n    \"id\": 123,\n    \"name\": \"value\",\n    \"properties\": {\n      \"myCustomProperty\": \"value\"\n    },\n    \"status\": \"value\",\n    \"onboardingStatus\": \"value\",\n    \"onboardingStageId\": 123,\n    \"prospectionStageId\": 123,\n    \"referralCode\": \"value\",\n    \"onboardingStage\": {\n      \"id\": 123,\n      \"name\": \"value\",\n      \"pipelineId\": 123,\n      \"pipelineName\": \"value\",\n      \"startedDate\": \"2024-01-15T10:30:00Z\",\n      \"completedDate\": \"2024-01-15T10:30:00Z\",\n      \"status\": \"value\",\n      \"pipeline\": {\n        \"id\": 123,\n        \"name\": \"value\",\n        \"startedDate\": \"2024-01-15T10:30:00Z\",\n        \"completedDate\": \"2024-01-15T10:30:00Z\",\n        \"onboardingStatus\": \"value\"\n      }\n    },\n    \"onboardingStages\": [\n      {\n        \"id\": 123,\n        \"name\": \"value\",\n        \"pipelineId\": 123,\n        \"pipelineName\": \"value\",\n        \"startedDate\": \"2024-01-15T10:30:00Z\",\n        \"completedDate\": \"2024-01-15T10:30:00Z\",\n        \"status\": \"value\",\n        \"pipeline\": {\n          \"id\": 123,\n          \"name\": \"value\",\n          \"startedDate\": \"2024-01-15T10:30:00Z\",\n          \"completedDate\": \"2024-01-15T10:30:00Z\",\n          \"onboardingStatus\": \"value\"\n        }\n      }\n    ],\n    \"prospectionStage\": {\n      \"id\": 123,\n      \"name\": \"value\"\n    },\n    \"programs\": [\n      {\n        \"id\": 123,\n        \"name\": \"value\",\n        \"levelId\": 123,\n        \"levelName\": \"value\"\n      }\n    ],\n    \"mainContact\": {\n      \"id\": 123,\n      \"email\": \"value\",\n      \"firstName\": \"value\",\n      \"lastName\": \"value\",\n      \"jobTitle\": \"value\",\n      \"phoneNumber\": \"value\",\n      \"linkedInProfileUrl\": \"value\",\n      \"accountActivationUrl\": \"value\",\n      \"partnerId\": 123,\n      \"isMainContact\": true\n    },\n    \"owner\": {\n      \"id\": 123,\n      \"email\": \"value\",\n      \"firstName\": \"value\",\n      \"lastName\": \"value\",\n      \"partnerId\": 123,\n      \"partnerName\": \"value\"\n    }\n  }\n}\n
\n","_postman_id":"020eaa38-f4ac-4661-8e47-ac24e6fdc6fd"},{"name":"DealNote","item":[],"id":"7d2a1c64-a213-483f-b67c-fbe20d3fbf2c","description":"

Triggered when a note is added on a deal.

\n

Example payload:

\n
{\n  \"id\": 123,\n  \"content\": \"value\",\n  \"isSynced\": true,\n  \"isFromPartner\": true,\n  \"createdByPartnerId\": 123,\n  \"creationDate\": \"2024-01-15T10:30:00Z\",\n  \"author\": {\n    \"id\": 123,\n    \"email\": \"value\",\n    \"firstName\": \"value\",\n    \"lastName\": \"value\",\n    \"partnerId\": 123,\n    \"partnerName\": \"value\"\n  },\n  \"leadId\": 123,\n  \"dealId\": 123,\n  \"partnerId\": 123,\n  \"customerId\": 123\n}\n
\n","_postman_id":"7d2a1c64-a213-483f-b67c-fbe20d3fbf2c"},{"name":"DealStageChange","item":[],"id":"7ed97c44-f356-4fa2-a2dd-0f4e71041eae","description":"

Triggered when a deal enters a new stage.

\n

Example payload:

\n
{\n  \"id\": 123,\n  \"contactId\": 123,\n  \"sourcePartnerId\": 123,\n  \"stage\": \"value\",\n  \"currency\": \"value\",\n  \"creationDate\": \"2024-01-15T10:30:00Z\",\n  \"totalAmount\": 123.45,\n  \"properties\": {\n    \"myCustomProperty\": \"value\"\n  },\n  \"sourceLeadId\": 123,\n  \"status\": \"value\",\n  \"partners\": [\n    {\n      \"id\": 123,\n      \"dealId\": 123,\n      \"userPartnerOwnerId\": 123,\n      \"userPartnerOwnerName\": \"value\",\n      \"userPartnerFirstName\": \"value\",\n      \"userPartnerLastName\": \"value\",\n      \"userPartnerEmail\": \"value\",\n      \"userPartnerJobTitle\": \"value\",\n      \"userPartnerPhoneNumber\": \"value\",\n      \"userPartnerLinkedInProfileUrl\": \"value\",\n      \"partnerId\": 123,\n      \"partnerTypeId\": 123,\n      \"creationDate\": \"2024-01-15T10:30:00Z\",\n      \"partnerName\": \"value\",\n      \"partnerType\": \"value\"\n    }\n  ],\n  \"contractStartDate\": \"2024-01-15T10:30:00Z\",\n  \"contractEndDate\": \"2024-01-15T10:30:00Z\",\n  \"ownerUserId\": 123,\n  \"owner\": {\n    \"id\": 123,\n    \"email\": \"value\",\n    \"firstName\": \"value\",\n    \"lastName\": \"value\",\n    \"partnerId\": 123,\n    \"partnerName\": \"value\"\n  },\n  \"closeDate\": \"2024-01-15T10:30:00Z\",\n  \"acceptedDate\": \"2024-01-15T10:30:00Z\",\n  \"refusedDate\": \"2024-01-15T10:30:00Z\",\n  \"customerId\": 123,\n  \"contact\": {\n    \"id\": 123,\n    \"creationDate\": \"2024-01-15T10:30:00Z\",\n    \"properties\": {\n      \"myCustomProperty\": \"value\"\n    }\n  },\n  \"sourceName\": \"value\",\n  \"sourcePartner\": {\n    \"id\": 123,\n    \"name\": \"value\",\n    \"properties\": {\n      \"myCustomProperty\": \"value\"\n    },\n    \"status\": \"value\",\n    \"onboardingStatus\": \"value\",\n    \"onboardingStageId\": 123,\n    \"prospectionStageId\": 123,\n    \"referralCode\": \"value\",\n    \"onboardingStage\": {\n      \"id\": 123,\n      \"name\": \"value\",\n      \"pipelineId\": 123,\n      \"pipelineName\": \"value\",\n      \"startedDate\": \"2024-01-15T10:30:00Z\",\n      \"completedDate\": \"2024-01-15T10:30:00Z\",\n      \"status\": \"value\",\n      \"pipeline\": {\n        \"id\": 123,\n        \"name\": \"value\",\n        \"startedDate\": \"2024-01-15T10:30:00Z\",\n        \"completedDate\": \"2024-01-15T10:30:00Z\",\n        \"onboardingStatus\": \"value\"\n      }\n    },\n    \"onboardingStages\": [\n      {\n        \"id\": 123,\n        \"name\": \"value\",\n        \"pipelineId\": 123,\n        \"pipelineName\": \"value\",\n        \"startedDate\": \"2024-01-15T10:30:00Z\",\n        \"completedDate\": \"2024-01-15T10:30:00Z\",\n        \"status\": \"value\",\n        \"pipeline\": {\n          \"id\": 123,\n          \"name\": \"value\",\n          \"startedDate\": \"2024-01-15T10:30:00Z\",\n          \"completedDate\": \"2024-01-15T10:30:00Z\",\n          \"onboardingStatus\": \"value\"\n        }\n      }\n    ],\n    \"prospectionStage\": {\n      \"id\": 123,\n      \"name\": \"value\"\n    },\n    \"programs\": [\n      {\n        \"id\": 123,\n        \"name\": \"value\",\n        \"levelId\": 123,\n        \"levelName\": \"value\"\n      }\n    ],\n    \"mainContact\": {\n      \"id\": 123,\n      \"email\": \"value\",\n      \"firstName\": \"value\",\n      \"lastName\": \"value\",\n      \"jobTitle\": \"value\",\n      \"phoneNumber\": \"value\",\n      \"linkedInProfileUrl\": \"value\",\n      \"accountActivationUrl\": \"value\",\n      \"partnerId\": 123,\n      \"isMainContact\": true\n    },\n    \"owner\": {\n      \"id\": 123,\n      \"email\": \"value\",\n      \"firstName\": \"value\",\n      \"lastName\": \"value\",\n      \"partnerId\": 123,\n      \"partnerName\": \"value\"\n    }\n  }\n}\n
\n","_postman_id":"7ed97c44-f356-4fa2-a2dd-0f4e71041eae"},{"name":"LeadNew","item":[],"id":"d72b8729-acc2-49f6-b536-45d2445279d6","description":"

Triggered when a new lead is created.

\n

Example payload:

\n
{\n  \"id\": 123,\n  \"creationDate\": \"2024-01-15T10:30:00Z\",\n  \"properties\": {\n    \"myCustomProperty\": \"value\"\n  },\n  \"status\": \"value\",\n  \"source\": \"value\",\n  \"partnerId\": 123,\n  \"assignedDate\": \"2024-01-15T10:30:00Z\",\n  \"deadLine\": null,\n  \"acceptedDate\": \"2024-01-15T10:30:00Z\",\n  \"refusedDate\": \"2024-01-15T10:30:00Z\",\n  \"convertedDate\": \"2024-01-15T10:30:00Z\",\n  \"dealId\": 123,\n  \"sourcePartnerId\": 123,\n  \"owner\": {\n    \"id\": 123,\n    \"email\": \"value\",\n    \"firstName\": \"value\",\n    \"lastName\": \"value\"\n  },\n  \"sourceName\": \"value\",\n  \"sourcePartner\": {\n    \"id\": 123,\n    \"name\": \"value\",\n    \"properties\": {\n      \"myCustomProperty\": \"value\"\n    },\n    \"status\": \"value\",\n    \"onboardingStatus\": \"value\",\n    \"onboardingStageId\": 123,\n    \"prospectionStageId\": 123,\n    \"referralCode\": \"value\",\n    \"onboardingStage\": {\n      \"id\": 123,\n      \"name\": \"value\",\n      \"pipelineId\": 123,\n      \"pipelineName\": \"value\",\n      \"startedDate\": \"2024-01-15T10:30:00Z\",\n      \"completedDate\": \"2024-01-15T10:30:00Z\",\n      \"status\": \"value\",\n      \"pipeline\": {\n        \"id\": 123,\n        \"name\": \"value\",\n        \"startedDate\": \"2024-01-15T10:30:00Z\",\n        \"completedDate\": \"2024-01-15T10:30:00Z\",\n        \"onboardingStatus\": \"value\"\n      }\n    },\n    \"onboardingStages\": [\n      {\n        \"id\": 123,\n        \"name\": \"value\",\n        \"pipelineId\": 123,\n        \"pipelineName\": \"value\",\n        \"startedDate\": \"2024-01-15T10:30:00Z\",\n        \"completedDate\": \"2024-01-15T10:30:00Z\",\n        \"status\": \"value\",\n        \"pipeline\": {\n          \"id\": 123,\n          \"name\": \"value\",\n          \"startedDate\": \"2024-01-15T10:30:00Z\",\n          \"completedDate\": \"2024-01-15T10:30:00Z\",\n          \"onboardingStatus\": \"value\"\n        }\n      }\n    ],\n    \"prospectionStage\": {\n      \"id\": 123,\n      \"name\": \"value\"\n    },\n    \"programs\": [\n      {\n        \"id\": 123,\n        \"name\": \"value\",\n        \"levelId\": 123,\n        \"levelName\": \"value\"\n      }\n    ],\n    \"mainContact\": {\n      \"id\": 123,\n      \"email\": \"value\",\n      \"firstName\": \"value\",\n      \"lastName\": \"value\",\n      \"jobTitle\": \"value\",\n      \"phoneNumber\": \"value\",\n      \"linkedInProfileUrl\": \"value\",\n      \"accountActivationUrl\": \"value\",\n      \"partnerId\": 123,\n      \"isMainContact\": true\n    },\n    \"owner\": {\n      \"id\": 123,\n      \"email\": \"value\",\n      \"firstName\": \"value\",\n      \"lastName\": \"value\",\n      \"partnerId\": 123,\n      \"partnerName\": \"value\"\n    }\n  },\n  \"assignedContact\": {\n    \"id\": 123,\n    \"email\": \"value\",\n    \"firstName\": \"value\",\n    \"lastName\": \"value\",\n    \"jobTitle\": \"value\",\n    \"phoneNumber\": \"value\",\n    \"linkedInProfileUrl\": \"value\",\n    \"accountActivationUrl\": \"value\",\n    \"partnerId\": 123,\n    \"isMainContact\": true\n  }\n}\n
\n","_postman_id":"d72b8729-acc2-49f6-b536-45d2445279d6"},{"name":"LeadAccept","item":[],"id":"41f766e6-f1dc-406a-9cb6-d1eb14db93e4","description":"

Triggered when a lead is accepted.

\n

Example payload:

\n
{\n  \"id\": 123,\n  \"creationDate\": \"2024-01-15T10:30:00Z\",\n  \"properties\": {\n    \"myCustomProperty\": \"value\"\n  },\n  \"status\": \"value\",\n  \"source\": \"value\",\n  \"partnerId\": 123,\n  \"assignedDate\": \"2024-01-15T10:30:00Z\",\n  \"deadLine\": null,\n  \"acceptedDate\": \"2024-01-15T10:30:00Z\",\n  \"refusedDate\": \"2024-01-15T10:30:00Z\",\n  \"convertedDate\": \"2024-01-15T10:30:00Z\",\n  \"dealId\": 123,\n  \"sourcePartnerId\": 123,\n  \"owner\": {\n    \"id\": 123,\n    \"email\": \"value\",\n    \"firstName\": \"value\",\n    \"lastName\": \"value\"\n  },\n  \"sourceName\": \"value\",\n  \"sourcePartner\": {\n    \"id\": 123,\n    \"name\": \"value\",\n    \"properties\": {\n      \"myCustomProperty\": \"value\"\n    },\n    \"status\": \"value\",\n    \"onboardingStatus\": \"value\",\n    \"onboardingStageId\": 123,\n    \"prospectionStageId\": 123,\n    \"referralCode\": \"value\",\n    \"onboardingStage\": {\n      \"id\": 123,\n      \"name\": \"value\",\n      \"pipelineId\": 123,\n      \"pipelineName\": \"value\",\n      \"startedDate\": \"2024-01-15T10:30:00Z\",\n      \"completedDate\": \"2024-01-15T10:30:00Z\",\n      \"status\": \"value\",\n      \"pipeline\": {\n        \"id\": 123,\n        \"name\": \"value\",\n        \"startedDate\": \"2024-01-15T10:30:00Z\",\n        \"completedDate\": \"2024-01-15T10:30:00Z\",\n        \"onboardingStatus\": \"value\"\n      }\n    },\n    \"onboardingStages\": [\n      {\n        \"id\": 123,\n        \"name\": \"value\",\n        \"pipelineId\": 123,\n        \"pipelineName\": \"value\",\n        \"startedDate\": \"2024-01-15T10:30:00Z\",\n        \"completedDate\": \"2024-01-15T10:30:00Z\",\n        \"status\": \"value\",\n        \"pipeline\": {\n          \"id\": 123,\n          \"name\": \"value\",\n          \"startedDate\": \"2024-01-15T10:30:00Z\",\n          \"completedDate\": \"2024-01-15T10:30:00Z\",\n          \"onboardingStatus\": \"value\"\n        }\n      }\n    ],\n    \"prospectionStage\": {\n      \"id\": 123,\n      \"name\": \"value\"\n    },\n    \"programs\": [\n      {\n        \"id\": 123,\n        \"name\": \"value\",\n        \"levelId\": 123,\n        \"levelName\": \"value\"\n      }\n    ],\n    \"mainContact\": {\n      \"id\": 123,\n      \"email\": \"value\",\n      \"firstName\": \"value\",\n      \"lastName\": \"value\",\n      \"jobTitle\": \"value\",\n      \"phoneNumber\": \"value\",\n      \"linkedInProfileUrl\": \"value\",\n      \"accountActivationUrl\": \"value\",\n      \"partnerId\": 123,\n      \"isMainContact\": true\n    },\n    \"owner\": {\n      \"id\": 123,\n      \"email\": \"value\",\n      \"firstName\": \"value\",\n      \"lastName\": \"value\",\n      \"partnerId\": 123,\n      \"partnerName\": \"value\"\n    }\n  },\n  \"assignedContact\": {\n    \"id\": 123,\n    \"email\": \"value\",\n    \"firstName\": \"value\",\n    \"lastName\": \"value\",\n    \"jobTitle\": \"value\",\n    \"phoneNumber\": \"value\",\n    \"linkedInProfileUrl\": \"value\",\n    \"accountActivationUrl\": \"value\",\n    \"partnerId\": 123,\n    \"isMainContact\": true\n  }\n}\n
\n","_postman_id":"41f766e6-f1dc-406a-9cb6-d1eb14db93e4"},{"name":"LeadRefuse","item":[],"id":"44454f3b-ecee-4cce-a491-79479ce58ee2","description":"

Triggered when a lead is refused.

\n

Example payload:

\n
{\n  \"id\": 123,\n  \"creationDate\": \"2024-01-15T10:30:00Z\",\n  \"properties\": {\n    \"myCustomProperty\": \"value\"\n  },\n  \"status\": \"value\",\n  \"source\": \"value\",\n  \"partnerId\": 123,\n  \"assignedDate\": \"2024-01-15T10:30:00Z\",\n  \"deadLine\": null,\n  \"acceptedDate\": \"2024-01-15T10:30:00Z\",\n  \"refusedDate\": \"2024-01-15T10:30:00Z\",\n  \"convertedDate\": \"2024-01-15T10:30:00Z\",\n  \"dealId\": 123,\n  \"sourcePartnerId\": 123,\n  \"owner\": {\n    \"id\": 123,\n    \"email\": \"value\",\n    \"firstName\": \"value\",\n    \"lastName\": \"value\"\n  },\n  \"sourceName\": \"value\",\n  \"sourcePartner\": {\n    \"id\": 123,\n    \"name\": \"value\",\n    \"properties\": {\n      \"myCustomProperty\": \"value\"\n    },\n    \"status\": \"value\",\n    \"onboardingStatus\": \"value\",\n    \"onboardingStageId\": 123,\n    \"prospectionStageId\": 123,\n    \"referralCode\": \"value\",\n    \"onboardingStage\": {\n      \"id\": 123,\n      \"name\": \"value\",\n      \"pipelineId\": 123,\n      \"pipelineName\": \"value\",\n      \"startedDate\": \"2024-01-15T10:30:00Z\",\n      \"completedDate\": \"2024-01-15T10:30:00Z\",\n      \"status\": \"value\",\n      \"pipeline\": {\n        \"id\": 123,\n        \"name\": \"value\",\n        \"startedDate\": \"2024-01-15T10:30:00Z\",\n        \"completedDate\": \"2024-01-15T10:30:00Z\",\n        \"onboardingStatus\": \"value\"\n      }\n    },\n    \"onboardingStages\": [\n      {\n        \"id\": 123,\n        \"name\": \"value\",\n        \"pipelineId\": 123,\n        \"pipelineName\": \"value\",\n        \"startedDate\": \"2024-01-15T10:30:00Z\",\n        \"completedDate\": \"2024-01-15T10:30:00Z\",\n        \"status\": \"value\",\n        \"pipeline\": {\n          \"id\": 123,\n          \"name\": \"value\",\n          \"startedDate\": \"2024-01-15T10:30:00Z\",\n          \"completedDate\": \"2024-01-15T10:30:00Z\",\n          \"onboardingStatus\": \"value\"\n        }\n      }\n    ],\n    \"prospectionStage\": {\n      \"id\": 123,\n      \"name\": \"value\"\n    },\n    \"programs\": [\n      {\n        \"id\": 123,\n        \"name\": \"value\",\n        \"levelId\": 123,\n        \"levelName\": \"value\"\n      }\n    ],\n    \"mainContact\": {\n      \"id\": 123,\n      \"email\": \"value\",\n      \"firstName\": \"value\",\n      \"lastName\": \"value\",\n      \"jobTitle\": \"value\",\n      \"phoneNumber\": \"value\",\n      \"linkedInProfileUrl\": \"value\",\n      \"accountActivationUrl\": \"value\",\n      \"partnerId\": 123,\n      \"isMainContact\": true\n    },\n    \"owner\": {\n      \"id\": 123,\n      \"email\": \"value\",\n      \"firstName\": \"value\",\n      \"lastName\": \"value\",\n      \"partnerId\": 123,\n      \"partnerName\": \"value\"\n    }\n  },\n  \"assignedContact\": {\n    \"id\": 123,\n    \"email\": \"value\",\n    \"firstName\": \"value\",\n    \"lastName\": \"value\",\n    \"jobTitle\": \"value\",\n    \"phoneNumber\": \"value\",\n    \"linkedInProfileUrl\": \"value\",\n    \"accountActivationUrl\": \"value\",\n    \"partnerId\": 123,\n    \"isMainContact\": true\n  }\n}\n
\n","_postman_id":"44454f3b-ecee-4cce-a491-79479ce58ee2"},{"name":"LeadUpdate","item":[],"id":"b310c318-79b4-4cd2-9d6e-b432ad18b4b5","description":"

Triggered when a lead is updated.

\n

Example payload:

\n
{\n  \"id\": 123,\n  \"creationDate\": \"2024-01-15T10:30:00Z\",\n  \"properties\": {\n    \"myCustomProperty\": \"value\"\n  },\n  \"status\": \"value\",\n  \"source\": \"value\",\n  \"partnerId\": 123,\n  \"assignedDate\": \"2024-01-15T10:30:00Z\",\n  \"deadLine\": null,\n  \"acceptedDate\": \"2024-01-15T10:30:00Z\",\n  \"refusedDate\": \"2024-01-15T10:30:00Z\",\n  \"convertedDate\": \"2024-01-15T10:30:00Z\",\n  \"dealId\": 123,\n  \"sourcePartnerId\": 123,\n  \"owner\": {\n    \"id\": 123,\n    \"email\": \"value\",\n    \"firstName\": \"value\",\n    \"lastName\": \"value\"\n  },\n  \"sourceName\": \"value\",\n  \"sourcePartner\": {\n    \"id\": 123,\n    \"name\": \"value\",\n    \"properties\": {\n      \"myCustomProperty\": \"value\"\n    },\n    \"status\": \"value\",\n    \"onboardingStatus\": \"value\",\n    \"onboardingStageId\": 123,\n    \"prospectionStageId\": 123,\n    \"referralCode\": \"value\",\n    \"onboardingStage\": {\n      \"id\": 123,\n      \"name\": \"value\",\n      \"pipelineId\": 123,\n      \"pipelineName\": \"value\",\n      \"startedDate\": \"2024-01-15T10:30:00Z\",\n      \"completedDate\": \"2024-01-15T10:30:00Z\",\n      \"status\": \"value\",\n      \"pipeline\": {\n        \"id\": 123,\n        \"name\": \"value\",\n        \"startedDate\": \"2024-01-15T10:30:00Z\",\n        \"completedDate\": \"2024-01-15T10:30:00Z\",\n        \"onboardingStatus\": \"value\"\n      }\n    },\n    \"onboardingStages\": [\n      {\n        \"id\": 123,\n        \"name\": \"value\",\n        \"pipelineId\": 123,\n        \"pipelineName\": \"value\",\n        \"startedDate\": \"2024-01-15T10:30:00Z\",\n        \"completedDate\": \"2024-01-15T10:30:00Z\",\n        \"status\": \"value\",\n        \"pipeline\": {\n          \"id\": 123,\n          \"name\": \"value\",\n          \"startedDate\": \"2024-01-15T10:30:00Z\",\n          \"completedDate\": \"2024-01-15T10:30:00Z\",\n          \"onboardingStatus\": \"value\"\n        }\n      }\n    ],\n    \"prospectionStage\": {\n      \"id\": 123,\n      \"name\": \"value\"\n    },\n    \"programs\": [\n      {\n        \"id\": 123,\n        \"name\": \"value\",\n        \"levelId\": 123,\n        \"levelName\": \"value\"\n      }\n    ],\n    \"mainContact\": {\n      \"id\": 123,\n      \"email\": \"value\",\n      \"firstName\": \"value\",\n      \"lastName\": \"value\",\n      \"jobTitle\": \"value\",\n      \"phoneNumber\": \"value\",\n      \"linkedInProfileUrl\": \"value\",\n      \"accountActivationUrl\": \"value\",\n      \"partnerId\": 123,\n      \"isMainContact\": true\n    },\n    \"owner\": {\n      \"id\": 123,\n      \"email\": \"value\",\n      \"firstName\": \"value\",\n      \"lastName\": \"value\",\n      \"partnerId\": 123,\n      \"partnerName\": \"value\"\n    }\n  },\n  \"assignedContact\": {\n    \"id\": 123,\n    \"email\": \"value\",\n    \"firstName\": \"value\",\n    \"lastName\": \"value\",\n    \"jobTitle\": \"value\",\n    \"phoneNumber\": \"value\",\n    \"linkedInProfileUrl\": \"value\",\n    \"accountActivationUrl\": \"value\",\n    \"partnerId\": 123,\n    \"isMainContact\": true\n  }\n}\n
\n","_postman_id":"b310c318-79b4-4cd2-9d6e-b432ad18b4b5"},{"name":"LeadNote","item":[],"id":"b7c727f4-a224-4af6-985f-5c742f447b43","description":"

Triggered when a note is added on a lead.

\n

Example payload:

\n
{\n  \"id\": 123,\n  \"content\": \"value\",\n  \"isSynced\": true,\n  \"isFromPartner\": true,\n  \"createdByPartnerId\": 123,\n  \"creationDate\": \"2024-01-15T10:30:00Z\",\n  \"author\": {\n    \"id\": 123,\n    \"email\": \"value\",\n    \"firstName\": \"value\",\n    \"lastName\": \"value\",\n    \"partnerId\": 123,\n    \"partnerName\": \"value\"\n  },\n  \"leadId\": 123,\n  \"dealId\": 123,\n  \"partnerId\": 123,\n  \"customerId\": 123\n}\n
\n","_postman_id":"b7c727f4-a224-4af6-985f-5c742f447b43"},{"name":"LeadAbandon","item":[],"id":"0ecffe68-b3b8-4aff-86ff-7836f1720ee5","description":"

Triggered when a lead is abandoned.

\n

Example payload:

\n
{\n  \"id\": 123,\n  \"creationDate\": \"2024-01-15T10:30:00Z\",\n  \"properties\": {\n    \"myCustomProperty\": \"value\"\n  },\n  \"status\": \"value\",\n  \"source\": \"value\",\n  \"partnerId\": 123,\n  \"assignedDate\": \"2024-01-15T10:30:00Z\",\n  \"deadLine\": null,\n  \"acceptedDate\": \"2024-01-15T10:30:00Z\",\n  \"refusedDate\": \"2024-01-15T10:30:00Z\",\n  \"convertedDate\": \"2024-01-15T10:30:00Z\",\n  \"dealId\": 123,\n  \"sourcePartnerId\": 123,\n  \"owner\": {\n    \"id\": 123,\n    \"email\": \"value\",\n    \"firstName\": \"value\",\n    \"lastName\": \"value\"\n  },\n  \"sourceName\": \"value\",\n  \"sourcePartner\": {\n    \"id\": 123,\n    \"name\": \"value\",\n    \"properties\": {\n      \"myCustomProperty\": \"value\"\n    },\n    \"status\": \"value\",\n    \"onboardingStatus\": \"value\",\n    \"onboardingStageId\": 123,\n    \"prospectionStageId\": 123,\n    \"referralCode\": \"value\",\n    \"onboardingStage\": {\n      \"id\": 123,\n      \"name\": \"value\",\n      \"pipelineId\": 123,\n      \"pipelineName\": \"value\",\n      \"startedDate\": \"2024-01-15T10:30:00Z\",\n      \"completedDate\": \"2024-01-15T10:30:00Z\",\n      \"status\": \"value\",\n      \"pipeline\": {\n        \"id\": 123,\n        \"name\": \"value\",\n        \"startedDate\": \"2024-01-15T10:30:00Z\",\n        \"completedDate\": \"2024-01-15T10:30:00Z\",\n        \"onboardingStatus\": \"value\"\n      }\n    },\n    \"onboardingStages\": [\n      {\n        \"id\": 123,\n        \"name\": \"value\",\n        \"pipelineId\": 123,\n        \"pipelineName\": \"value\",\n        \"startedDate\": \"2024-01-15T10:30:00Z\",\n        \"completedDate\": \"2024-01-15T10:30:00Z\",\n        \"status\": \"value\",\n        \"pipeline\": {\n          \"id\": 123,\n          \"name\": \"value\",\n          \"startedDate\": \"2024-01-15T10:30:00Z\",\n          \"completedDate\": \"2024-01-15T10:30:00Z\",\n          \"onboardingStatus\": \"value\"\n        }\n      }\n    ],\n    \"prospectionStage\": {\n      \"id\": 123,\n      \"name\": \"value\"\n    },\n    \"programs\": [\n      {\n        \"id\": 123,\n        \"name\": \"value\",\n        \"levelId\": 123,\n        \"levelName\": \"value\"\n      }\n    ],\n    \"mainContact\": {\n      \"id\": 123,\n      \"email\": \"value\",\n      \"firstName\": \"value\",\n      \"lastName\": \"value\",\n      \"jobTitle\": \"value\",\n      \"phoneNumber\": \"value\",\n      \"linkedInProfileUrl\": \"value\",\n      \"accountActivationUrl\": \"value\",\n      \"partnerId\": 123,\n      \"isMainContact\": true\n    },\n    \"owner\": {\n      \"id\": 123,\n      \"email\": \"value\",\n      \"firstName\": \"value\",\n      \"lastName\": \"value\",\n      \"partnerId\": 123,\n      \"partnerName\": \"value\"\n    }\n  },\n  \"assignedContact\": {\n    \"id\": 123,\n    \"email\": \"value\",\n    \"firstName\": \"value\",\n    \"lastName\": \"value\",\n    \"jobTitle\": \"value\",\n    \"phoneNumber\": \"value\",\n    \"linkedInProfileUrl\": \"value\",\n    \"accountActivationUrl\": \"value\",\n    \"partnerId\": 123,\n    \"isMainContact\": true\n  }\n}\n
\n","_postman_id":"0ecffe68-b3b8-4aff-86ff-7836f1720ee5"},{"name":"RewardNew","item":[],"id":"eca90647-9b68-4a91-aad7-f782b21d17af","description":"

Triggered when a new reward is generated.

\n

Example payload:

\n
{\n  \"id\": 123,\n  \"name\": \"value\",\n  \"uniqueId\": \"value\",\n  \"partnerId\": 123,\n  \"dealId\": 123,\n  \"status\": \"value\",\n  \"creationDate\": \"2024-01-15T10:30:00Z\",\n  \"rewardType\": \"value\",\n  \"triggerType\": \"value\",\n  \"properties\": {\n    \"myCustomProperty\": \"value\"\n  },\n  \"amount\": {\n    \"value\": 123.45,\n    \"currency\": \"value\"\n  },\n  \"transactionId\": 123\n}\n
\n","_postman_id":"eca90647-9b68-4a91-aad7-f782b21d17af"},{"name":"CustomerNew","item":[],"id":"760fa721-e47b-40bf-8734-9c8e8caecf1f","description":"

Triggered when a new customer is created.

\n

Example payload:

\n
{\n  \"id\": 123,\n  \"sourceLeadId\": 123,\n  \"sourcePartnerId\": 123,\n  \"creationDate\": \"2024-01-15T10:30:00Z\",\n  \"source\": \"value\",\n  \"properties\": {\n    \"myCustomProperty\": \"value\"\n  },\n  \"status\": \"value\",\n  \"sourcePartner\": {\n    \"id\": 123,\n    \"name\": \"value\",\n    \"mainContact\": {\n      \"firstName\": \"value\",\n      \"lastName\": \"value\",\n      \"email\": \"value\"\n    }\n  }\n}\n
\n","_postman_id":"760fa721-e47b-40bf-8734-9c8e8caecf1f"},{"name":"CustomerUpdate","item":[],"id":"fd67ec4d-2d73-448e-866c-343ffc023218","description":"

Triggered when a customer is updated.

\n

Example payload:

\n
{\n  \"id\": 123,\n  \"sourceLeadId\": 123,\n  \"sourcePartnerId\": 123,\n  \"creationDate\": \"2024-01-15T10:30:00Z\",\n  \"source\": \"value\",\n  \"properties\": {\n    \"myCustomProperty\": \"value\"\n  },\n  \"status\": \"value\",\n  \"sourcePartner\": {\n    \"id\": 123,\n    \"name\": \"value\",\n    \"mainContact\": {\n      \"firstName\": \"value\",\n      \"lastName\": \"value\",\n      \"email\": \"value\"\n    }\n  }\n}\n
\n","_postman_id":"fd67ec4d-2d73-448e-866c-343ffc023218"},{"name":"TransactionNew","item":[],"id":"76771020-fae8-4e60-8b93-b43430b04d5d","description":"

Triggered when a new transaction is created.

\n

Example payload:

\n
{\n  \"id\": 123,\n  \"properties\": {\n    \"myCustomProperty\": \"value\"\n  },\n  \"creationDate\": \"2024-01-15T10:30:00Z\",\n  \"partnerId\": 123,\n  \"customerId\": 123,\n  \"currency\": \"value\",\n  \"dealId\": 123,\n  \"customer\": {\n    \"id\": 123,\n    \"properties\": {\n      \"myCustomProperty\": \"value\"\n    },\n    \"sourcePartnerId\": 123\n  },\n  \"deal\": {\n    \"id\": 123,\n    \"properties\": {\n      \"myCustomProperty\": \"value\"\n    },\n    \"sourcePartnerId\": 123\n  },\n  \"partner\": {\n    \"id\": 123,\n    \"name\": \"value\",\n    \"mainContact\": {\n      \"firstName\": \"value\",\n      \"lastName\": \"value\",\n      \"email\": \"value\"\n    }\n  }\n}\n
\n","_postman_id":"76771020-fae8-4e60-8b93-b43430b04d5d"},{"name":"TransactionUpdate","item":[],"id":"c488a7e2-903d-4345-be34-305610f6e204","description":"

Triggered when a transaction is updated.

\n

Example payload:

\n
{\n  \"id\": 123,\n  \"properties\": {\n    \"myCustomProperty\": \"value\"\n  },\n  \"creationDate\": \"2024-01-15T10:30:00Z\",\n  \"partnerId\": 123,\n  \"customerId\": 123,\n  \"currency\": \"value\",\n  \"dealId\": 123,\n  \"customer\": {\n    \"id\": 123,\n    \"properties\": {\n      \"myCustomProperty\": \"value\"\n    },\n    \"sourcePartnerId\": 123\n  },\n  \"deal\": {\n    \"id\": 123,\n    \"properties\": {\n      \"myCustomProperty\": \"value\"\n    },\n    \"sourcePartnerId\": 123\n  },\n  \"partner\": {\n    \"id\": 123,\n    \"name\": \"value\",\n    \"mainContact\": {\n      \"firstName\": \"value\",\n      \"lastName\": \"value\",\n      \"email\": \"value\"\n    }\n  }\n}\n
\n","_postman_id":"c488a7e2-903d-4345-be34-305610f6e204"},{"name":"ProgramNewPartnerInLevel","item":[],"id":"46f196d6-3a7e-4887-9050-5d3a416478e2","description":"

Triggered when a partner enters new level in a program.

\n

Example payload:

\n
{\n  \"partner\": {\n    \"id\": 123,\n    \"name\": \"value\",\n    \"properties\": {\n      \"myCustomProperty\": \"value\"\n    },\n    \"status\": \"value\",\n    \"mainContact\": {\n      \"firstName\": \"value\",\n      \"lastName\": \"value\",\n      \"email\": \"value\"\n    }\n  },\n  \"program\": {\n    \"id\": 123,\n    \"name\": \"value\",\n    \"levelId\": 123,\n    \"levelName\": \"value\"\n  }\n}\n
\n","_postman_id":"46f196d6-3a7e-4887-9050-5d3a416478e2"},{"name":"PayoutNew","item":[],"id":"9270d621-9e41-4448-a9c9-c044aec2e6f3","description":"

Triggered when a new payout is created.

\n

Example payload:

\n
{\n  \"id\": 123,\n  \"partnerId\": 123,\n  \"partner\": {\n    \"id\": 123,\n    \"name\": \"value\",\n    \"properties\": {\n      \"myCustomProperty\": \"value\"\n    },\n    \"status\": \"value\",\n    \"onboardingStatus\": \"value\",\n    \"onboardingStageId\": 123,\n    \"prospectionStageId\": 123,\n    \"referralCode\": \"value\",\n    \"onboardingStage\": {\n      \"id\": 123,\n      \"name\": \"value\",\n      \"pipelineId\": 123,\n      \"pipelineName\": \"value\",\n      \"startedDate\": \"2024-01-15T10:30:00Z\",\n      \"completedDate\": \"2024-01-15T10:30:00Z\",\n      \"status\": \"value\",\n      \"pipeline\": {\n        \"id\": 123,\n        \"name\": \"value\",\n        \"startedDate\": \"2024-01-15T10:30:00Z\",\n        \"completedDate\": \"2024-01-15T10:30:00Z\",\n        \"onboardingStatus\": \"value\"\n      }\n    },\n    \"onboardingStages\": [\n      {\n        \"id\": 123,\n        \"name\": \"value\",\n        \"pipelineId\": 123,\n        \"pipelineName\": \"value\",\n        \"startedDate\": \"2024-01-15T10:30:00Z\",\n        \"completedDate\": \"2024-01-15T10:30:00Z\",\n        \"status\": \"value\",\n        \"pipeline\": {\n          \"id\": 123,\n          \"name\": \"value\",\n          \"startedDate\": \"2024-01-15T10:30:00Z\",\n          \"completedDate\": \"2024-01-15T10:30:00Z\",\n          \"onboardingStatus\": \"value\"\n        }\n      }\n    ],\n    \"prospectionStage\": {\n      \"id\": 123,\n      \"name\": \"value\"\n    },\n    \"programs\": [\n      {\n        \"id\": 123,\n        \"name\": \"value\",\n        \"levelId\": 123,\n        \"levelName\": \"value\"\n      }\n    ],\n    \"mainContact\": {\n      \"id\": 123,\n      \"email\": \"value\",\n      \"firstName\": \"value\",\n      \"lastName\": \"value\",\n      \"jobTitle\": \"value\",\n      \"phoneNumber\": \"value\",\n      \"linkedInProfileUrl\": \"value\",\n      \"accountActivationUrl\": \"value\",\n      \"partnerId\": 123,\n      \"isMainContact\": true\n    },\n    \"owner\": {\n      \"id\": 123,\n      \"email\": \"value\",\n      \"firstName\": \"value\",\n      \"lastName\": \"value\",\n      \"partnerId\": 123,\n      \"partnerName\": \"value\"\n    }\n  },\n  \"name\": \"value\",\n  \"uniqueId\": \"value\",\n  \"currency\": \"value\",\n  \"rewardType\": \"value\",\n  \"fromDate\": \"2024-01-15T10:30:00Z\",\n  \"toDate\": \"2024-01-15T10:30:00Z\",\n  \"creationDate\": \"2024-01-15T10:30:00Z\",\n  \"paidDate\": \"2024-01-15T10:30:00Z\",\n  \"acceptedDate\": \"2024-01-15T10:30:00Z\",\n  \"validatedDate\": \"2024-01-15T10:30:00Z\",\n  \"paidByUserId\": 123,\n  \"paidByUser\": {\n    \"id\": 123,\n    \"email\": \"value\",\n    \"firstName\": \"value\",\n    \"lastName\": \"value\",\n    \"partnerId\": 123,\n    \"partnerName\": \"value\"\n  },\n  \"validatedByUserId\": 123,\n  \"validatedByUser\": {\n    \"id\": 123,\n    \"email\": \"value\",\n    \"firstName\": \"value\",\n    \"lastName\": \"value\",\n    \"partnerId\": 123,\n    \"partnerName\": \"value\"\n  },\n  \"acceptedByUserId\": 123,\n  \"acceptedByUser\": {\n    \"id\": 123,\n    \"email\": \"value\",\n    \"firstName\": \"value\",\n    \"lastName\": \"value\",\n    \"partnerId\": 123,\n    \"partnerName\": \"value\"\n  },\n  \"shouldValidateRewards\": true,\n  \"shouldAttachInvoice\": true,\n  \"isSelfInvoice\": true,\n  \"rewardCount\": 123,\n  \"comment\": \"value\",\n  \"status\": \"value\",\n  \"source\": \"value\",\n  \"amount\": {\n    \"value\": 123.45,\n    \"currency\": \"value\"\n  },\n  \"properties\": {\n    \"myCustomProperty\": \"value\"\n  },\n  \"rewards\": [\n    {\n      \"id\": 123,\n      \"name\": \"value\",\n      \"uniqueId\": \"value\",\n      \"partnerId\": 123,\n      \"dealId\": 123,\n      \"status\": \"value\",\n      \"creationDate\": \"2024-01-15T10:30:00Z\",\n      \"rewardType\": \"value\",\n      \"triggerType\": \"value\",\n      \"properties\": {\n        \"myCustomProperty\": \"value\"\n      },\n      \"amount\": {\n        \"value\": 123.45,\n        \"currency\": \"value\"\n      },\n      \"transactionId\": 123\n    }\n  ]\n}\n
\n","_postman_id":"9270d621-9e41-4448-a9c9-c044aec2e6f3"},{"name":"PayoutStatusChange","item":[],"id":"5e4be58e-b02a-46a7-ba5c-4bd62497966c","description":"

Triggered when the status of a payout changed.

\n

Example payload:

\n
{\n  \"id\": 123,\n  \"partnerId\": 123,\n  \"partner\": {\n    \"id\": 123,\n    \"name\": \"value\",\n    \"properties\": {\n      \"myCustomProperty\": \"value\"\n    },\n    \"status\": \"value\",\n    \"onboardingStatus\": \"value\",\n    \"onboardingStageId\": 123,\n    \"prospectionStageId\": 123,\n    \"referralCode\": \"value\",\n    \"onboardingStage\": {\n      \"id\": 123,\n      \"name\": \"value\",\n      \"pipelineId\": 123,\n      \"pipelineName\": \"value\",\n      \"startedDate\": \"2024-01-15T10:30:00Z\",\n      \"completedDate\": \"2024-01-15T10:30:00Z\",\n      \"status\": \"value\",\n      \"pipeline\": {\n        \"id\": 123,\n        \"name\": \"value\",\n        \"startedDate\": \"2024-01-15T10:30:00Z\",\n        \"completedDate\": \"2024-01-15T10:30:00Z\",\n        \"onboardingStatus\": \"value\"\n      }\n    },\n    \"onboardingStages\": [\n      {\n        \"id\": 123,\n        \"name\": \"value\",\n        \"pipelineId\": 123,\n        \"pipelineName\": \"value\",\n        \"startedDate\": \"2024-01-15T10:30:00Z\",\n        \"completedDate\": \"2024-01-15T10:30:00Z\",\n        \"status\": \"value\",\n        \"pipeline\": {\n          \"id\": 123,\n          \"name\": \"value\",\n          \"startedDate\": \"2024-01-15T10:30:00Z\",\n          \"completedDate\": \"2024-01-15T10:30:00Z\",\n          \"onboardingStatus\": \"value\"\n        }\n      }\n    ],\n    \"prospectionStage\": {\n      \"id\": 123,\n      \"name\": \"value\"\n    },\n    \"programs\": [\n      {\n        \"id\": 123,\n        \"name\": \"value\",\n        \"levelId\": 123,\n        \"levelName\": \"value\"\n      }\n    ],\n    \"mainContact\": {\n      \"id\": 123,\n      \"email\": \"value\",\n      \"firstName\": \"value\",\n      \"lastName\": \"value\",\n      \"jobTitle\": \"value\",\n      \"phoneNumber\": \"value\",\n      \"linkedInProfileUrl\": \"value\",\n      \"accountActivationUrl\": \"value\",\n      \"partnerId\": 123,\n      \"isMainContact\": true\n    },\n    \"owner\": {\n      \"id\": 123,\n      \"email\": \"value\",\n      \"firstName\": \"value\",\n      \"lastName\": \"value\",\n      \"partnerId\": 123,\n      \"partnerName\": \"value\"\n    }\n  },\n  \"name\": \"value\",\n  \"uniqueId\": \"value\",\n  \"currency\": \"value\",\n  \"rewardType\": \"value\",\n  \"fromDate\": \"2024-01-15T10:30:00Z\",\n  \"toDate\": \"2024-01-15T10:30:00Z\",\n  \"creationDate\": \"2024-01-15T10:30:00Z\",\n  \"paidDate\": \"2024-01-15T10:30:00Z\",\n  \"acceptedDate\": \"2024-01-15T10:30:00Z\",\n  \"validatedDate\": \"2024-01-15T10:30:00Z\",\n  \"paidByUserId\": 123,\n  \"paidByUser\": {\n    \"id\": 123,\n    \"email\": \"value\",\n    \"firstName\": \"value\",\n    \"lastName\": \"value\",\n    \"partnerId\": 123,\n    \"partnerName\": \"value\"\n  },\n  \"validatedByUserId\": 123,\n  \"validatedByUser\": {\n    \"id\": 123,\n    \"email\": \"value\",\n    \"firstName\": \"value\",\n    \"lastName\": \"value\",\n    \"partnerId\": 123,\n    \"partnerName\": \"value\"\n  },\n  \"acceptedByUserId\": 123,\n  \"acceptedByUser\": {\n    \"id\": 123,\n    \"email\": \"value\",\n    \"firstName\": \"value\",\n    \"lastName\": \"value\",\n    \"partnerId\": 123,\n    \"partnerName\": \"value\"\n  },\n  \"shouldValidateRewards\": true,\n  \"shouldAttachInvoice\": true,\n  \"isSelfInvoice\": true,\n  \"rewardCount\": 123,\n  \"comment\": \"value\",\n  \"status\": \"value\",\n  \"source\": \"value\",\n  \"amount\": {\n    \"value\": 123.45,\n    \"currency\": \"value\"\n  },\n  \"properties\": {\n    \"myCustomProperty\": \"value\"\n  },\n  \"rewards\": [\n    {\n      \"id\": 123,\n      \"name\": \"value\",\n      \"uniqueId\": \"value\",\n      \"partnerId\": 123,\n      \"dealId\": 123,\n      \"status\": \"value\",\n      \"creationDate\": \"2024-01-15T10:30:00Z\",\n      \"rewardType\": \"value\",\n      \"triggerType\": \"value\",\n      \"properties\": {\n        \"myCustomProperty\": \"value\"\n      },\n      \"amount\": {\n        \"value\": 123.45,\n        \"currency\": \"value\"\n      },\n      \"transactionId\": 123\n    }\n  ]\n}\n
\n","_postman_id":"5e4be58e-b02a-46a7-ba5c-4bd62497966c"},{"name":"DealQuoteRequested","item":[],"id":"2fe919cb-ea7e-4a04-bcb3-71fb355a0ae9","description":"

Triggered when a new quote is requested on a deal.

\n

Example payload:

\n
{\n  \"deal\": {\n    \"id\": 123,\n    \"contactId\": 123,\n    \"sourcePartnerId\": 123,\n    \"stage\": \"value\",\n    \"currency\": \"value\",\n    \"creationDate\": \"2024-01-15T10:30:00Z\",\n    \"totalAmount\": 123.45,\n    \"properties\": {\n      \"myCustomProperty\": \"value\"\n    },\n    \"sourceLeadId\": 123,\n    \"status\": \"value\",\n    \"partners\": [\n      {\n        \"id\": 123,\n        \"dealId\": 123,\n        \"userPartnerOwnerId\": 123,\n        \"userPartnerOwnerName\": \"value\",\n        \"userPartnerFirstName\": \"value\",\n        \"userPartnerLastName\": \"value\",\n        \"userPartnerEmail\": \"value\",\n        \"userPartnerJobTitle\": \"value\",\n        \"userPartnerPhoneNumber\": \"value\",\n        \"userPartnerLinkedInProfileUrl\": \"value\",\n        \"partnerId\": 123,\n        \"partnerTypeId\": 123,\n        \"creationDate\": \"2024-01-15T10:30:00Z\",\n        \"partnerName\": \"value\",\n        \"partnerType\": \"value\"\n      }\n    ],\n    \"contractStartDate\": \"2024-01-15T10:30:00Z\",\n    \"contractEndDate\": \"2024-01-15T10:30:00Z\",\n    \"ownerUserId\": 123,\n    \"owner\": {\n      \"id\": 123,\n      \"email\": \"value\",\n      \"firstName\": \"value\",\n      \"lastName\": \"value\",\n      \"partnerId\": 123,\n      \"partnerName\": \"value\"\n    },\n    \"closeDate\": \"2024-01-15T10:30:00Z\",\n    \"acceptedDate\": \"2024-01-15T10:30:00Z\",\n    \"refusedDate\": \"2024-01-15T10:30:00Z\",\n    \"customerId\": 123,\n    \"contact\": {\n      \"id\": 123,\n      \"creationDate\": \"2024-01-15T10:30:00Z\",\n      \"properties\": {\n        \"myCustomProperty\": \"value\"\n      }\n    },\n    \"sourceName\": \"value\",\n    \"sourcePartner\": {\n      \"id\": 123,\n      \"name\": \"value\",\n      \"properties\": {\n        \"myCustomProperty\": \"value\"\n      },\n      \"status\": \"value\",\n      \"onboardingStatus\": \"value\",\n      \"onboardingStageId\": 123,\n      \"prospectionStageId\": 123,\n      \"referralCode\": \"value\",\n      \"onboardingStage\": {\n        \"id\": 123,\n        \"name\": \"value\",\n        \"pipelineId\": 123,\n        \"pipelineName\": \"value\",\n        \"startedDate\": \"2024-01-15T10:30:00Z\",\n        \"completedDate\": \"2024-01-15T10:30:00Z\",\n        \"status\": \"value\",\n        \"pipeline\": {\n          \"id\": 123,\n          \"name\": \"value\",\n          \"startedDate\": \"2024-01-15T10:30:00Z\",\n          \"completedDate\": \"2024-01-15T10:30:00Z\",\n          \"onboardingStatus\": \"value\"\n        }\n      },\n      \"onboardingStages\": [\n        {\n          \"id\": 123,\n          \"name\": \"value\",\n          \"pipelineId\": 123,\n          \"pipelineName\": \"value\",\n          \"startedDate\": \"2024-01-15T10:30:00Z\",\n          \"completedDate\": \"2024-01-15T10:30:00Z\",\n          \"status\": \"value\",\n          \"pipeline\": {\n            \"id\": 123,\n            \"name\": \"value\",\n            \"startedDate\": \"2024-01-15T10:30:00Z\",\n            \"completedDate\": \"2024-01-15T10:30:00Z\",\n            \"onboardingStatus\": \"value\"\n          }\n        }\n      ],\n      \"prospectionStage\": {\n        \"id\": 123,\n        \"name\": \"value\"\n      },\n      \"programs\": [\n        {\n          \"id\": 123,\n          \"name\": \"value\",\n          \"levelId\": 123,\n          \"levelName\": \"value\"\n        }\n      ],\n      \"mainContact\": {\n        \"id\": 123,\n        \"email\": \"value\",\n        \"firstName\": \"value\",\n        \"lastName\": \"value\",\n        \"jobTitle\": \"value\",\n        \"phoneNumber\": \"value\",\n        \"linkedInProfileUrl\": \"value\",\n        \"accountActivationUrl\": \"value\",\n        \"partnerId\": 123,\n        \"isMainContact\": true\n      },\n      \"owner\": {\n        \"id\": 123,\n        \"email\": \"value\",\n        \"firstName\": \"value\",\n        \"lastName\": \"value\",\n        \"partnerId\": 123,\n        \"partnerName\": \"value\"\n      }\n    }\n  },\n  \"note\": {\n    \"id\": 123,\n    \"content\": \"value\",\n    \"isSynced\": true,\n    \"isFromPartner\": true,\n    \"createdByPartnerId\": 123,\n    \"creationDate\": \"2024-01-15T10:30:00Z\",\n    \"author\": {\n      \"id\": 123,\n      \"email\": \"value\",\n      \"firstName\": \"value\",\n      \"lastName\": \"value\",\n      \"partnerId\": 123,\n      \"partnerName\": \"value\"\n    },\n    \"leadId\": 123,\n    \"dealId\": 123,\n    \"partnerId\": 123,\n    \"customerId\": 123\n  },\n  \"requestedBy\": {\n    \"id\": 123,\n    \"email\": \"value\",\n    \"firstName\": \"value\",\n    \"lastName\": \"value\",\n    \"partnerId\": 123,\n    \"partnerName\": \"value\"\n  }\n}\n
\n","_postman_id":"2fe919cb-ea7e-4a04-bcb3-71fb355a0ae9"},{"name":"PartnerStatusUpdated","item":[],"id":"455c46d6-bda3-4b89-9c43-439942215735","description":"

Triggered when the status changed on a specific partner.

\n

Example payload:

\n
{\n  \"id\": 123,\n  \"name\": \"value\",\n  \"properties\": {\n    \"myCustomProperty\": \"value\"\n  },\n  \"status\": \"value\",\n  \"onboardingStatus\": \"value\",\n  \"onboardingStageId\": 123,\n  \"prospectionStageId\": 123,\n  \"referralCode\": \"value\",\n  \"onboardingStage\": {\n    \"id\": 123,\n    \"name\": \"value\",\n    \"pipelineId\": 123,\n    \"pipelineName\": \"value\",\n    \"startedDate\": \"2024-01-15T10:30:00Z\",\n    \"completedDate\": \"2024-01-15T10:30:00Z\",\n    \"status\": \"value\",\n    \"pipeline\": {\n      \"id\": 123,\n      \"name\": \"value\",\n      \"startedDate\": \"2024-01-15T10:30:00Z\",\n      \"completedDate\": \"2024-01-15T10:30:00Z\",\n      \"onboardingStatus\": \"value\"\n    }\n  },\n  \"onboardingStages\": [\n    {\n      \"id\": 123,\n      \"name\": \"value\",\n      \"pipelineId\": 123,\n      \"pipelineName\": \"value\",\n      \"startedDate\": \"2024-01-15T10:30:00Z\",\n      \"completedDate\": \"2024-01-15T10:30:00Z\",\n      \"status\": \"value\",\n      \"pipeline\": {\n        \"id\": 123,\n        \"name\": \"value\",\n        \"startedDate\": \"2024-01-15T10:30:00Z\",\n        \"completedDate\": \"2024-01-15T10:30:00Z\",\n        \"onboardingStatus\": \"value\"\n      }\n    }\n  ],\n  \"prospectionStage\": {\n    \"id\": 123,\n    \"name\": \"value\"\n  },\n  \"programs\": [\n    {\n      \"id\": 123,\n      \"name\": \"value\",\n      \"levelId\": 123,\n      \"levelName\": \"value\"\n    }\n  ],\n  \"mainContact\": {\n    \"id\": 123,\n    \"email\": \"value\",\n    \"firstName\": \"value\",\n    \"lastName\": \"value\",\n    \"jobTitle\": \"value\",\n    \"phoneNumber\": \"value\",\n    \"linkedInProfileUrl\": \"value\",\n    \"accountActivationUrl\": \"value\",\n    \"partnerId\": 123,\n    \"isMainContact\": true\n  },\n  \"owner\": {\n    \"id\": 123,\n    \"email\": \"value\",\n    \"firstName\": \"value\",\n    \"lastName\": \"value\",\n    \"partnerId\": 123,\n    \"partnerName\": \"value\"\n  }\n}\n
\n","_postman_id":"455c46d6-bda3-4b89-9c43-439942215735"},{"name":"PartnerProspectionStageUpdated","item":[],"id":"ac81e5f9-8a44-4cc3-a305-c6ad6d37deef","description":"

Triggered when a partner enters a new prospection stage.

\n

Example payload:

\n
{\n  \"id\": 123,\n  \"name\": \"value\",\n  \"properties\": {\n    \"myCustomProperty\": \"value\"\n  },\n  \"status\": \"value\",\n  \"onboardingStatus\": \"value\",\n  \"onboardingStageId\": 123,\n  \"prospectionStageId\": 123,\n  \"referralCode\": \"value\",\n  \"onboardingStage\": {\n    \"id\": 123,\n    \"name\": \"value\",\n    \"pipelineId\": 123,\n    \"pipelineName\": \"value\",\n    \"startedDate\": \"2024-01-15T10:30:00Z\",\n    \"completedDate\": \"2024-01-15T10:30:00Z\",\n    \"status\": \"value\",\n    \"pipeline\": {\n      \"id\": 123,\n      \"name\": \"value\",\n      \"startedDate\": \"2024-01-15T10:30:00Z\",\n      \"completedDate\": \"2024-01-15T10:30:00Z\",\n      \"onboardingStatus\": \"value\"\n    }\n  },\n  \"onboardingStages\": [\n    {\n      \"id\": 123,\n      \"name\": \"value\",\n      \"pipelineId\": 123,\n      \"pipelineName\": \"value\",\n      \"startedDate\": \"2024-01-15T10:30:00Z\",\n      \"completedDate\": \"2024-01-15T10:30:00Z\",\n      \"status\": \"value\",\n      \"pipeline\": {\n        \"id\": 123,\n        \"name\": \"value\",\n        \"startedDate\": \"2024-01-15T10:30:00Z\",\n        \"completedDate\": \"2024-01-15T10:30:00Z\",\n        \"onboardingStatus\": \"value\"\n      }\n    }\n  ],\n  \"prospectionStage\": {\n    \"id\": 123,\n    \"name\": \"value\"\n  },\n  \"programs\": [\n    {\n      \"id\": 123,\n      \"name\": \"value\",\n      \"levelId\": 123,\n      \"levelName\": \"value\"\n    }\n  ],\n  \"mainContact\": {\n    \"id\": 123,\n    \"email\": \"value\",\n    \"firstName\": \"value\",\n    \"lastName\": \"value\",\n    \"jobTitle\": \"value\",\n    \"phoneNumber\": \"value\",\n    \"linkedInProfileUrl\": \"value\",\n    \"accountActivationUrl\": \"value\",\n    \"partnerId\": 123,\n    \"isMainContact\": true\n  },\n  \"owner\": {\n    \"id\": 123,\n    \"email\": \"value\",\n    \"firstName\": \"value\",\n    \"lastName\": \"value\",\n    \"partnerId\": 123,\n    \"partnerName\": \"value\"\n  }\n}\n
\n","_postman_id":"ac81e5f9-8a44-4cc3-a305-c6ad6d37deef"},{"name":"OnboardingStatusChanged","item":[],"id":"4f3f6fca-e41c-42ad-b829-eb5c19ff6145","description":"

Triggered when the OnboardingStatus changed on a specific partner.

\n

Example payload:

\n
{\n  \"id\": 123,\n  \"name\": \"value\",\n  \"properties\": {\n    \"myCustomProperty\": \"value\"\n  },\n  \"status\": \"value\",\n  \"onboardingStatus\": \"value\",\n  \"onboardingStageId\": 123,\n  \"prospectionStageId\": 123,\n  \"referralCode\": \"value\",\n  \"onboardingStage\": {\n    \"id\": 123,\n    \"name\": \"value\",\n    \"pipelineId\": 123,\n    \"pipelineName\": \"value\",\n    \"startedDate\": \"2024-01-15T10:30:00Z\",\n    \"completedDate\": \"2024-01-15T10:30:00Z\",\n    \"status\": \"value\",\n    \"pipeline\": {\n      \"id\": 123,\n      \"name\": \"value\",\n      \"startedDate\": \"2024-01-15T10:30:00Z\",\n      \"completedDate\": \"2024-01-15T10:30:00Z\",\n      \"onboardingStatus\": \"value\"\n    }\n  },\n  \"onboardingStages\": [\n    {\n      \"id\": 123,\n      \"name\": \"value\",\n      \"pipelineId\": 123,\n      \"pipelineName\": \"value\",\n      \"startedDate\": \"2024-01-15T10:30:00Z\",\n      \"completedDate\": \"2024-01-15T10:30:00Z\",\n      \"status\": \"value\",\n      \"pipeline\": {\n        \"id\": 123,\n        \"name\": \"value\",\n        \"startedDate\": \"2024-01-15T10:30:00Z\",\n        \"completedDate\": \"2024-01-15T10:30:00Z\",\n        \"onboardingStatus\": \"value\"\n      }\n    }\n  ],\n  \"prospectionStage\": {\n    \"id\": 123,\n    \"name\": \"value\"\n  },\n  \"programs\": [\n    {\n      \"id\": 123,\n      \"name\": \"value\",\n      \"levelId\": 123,\n      \"levelName\": \"value\"\n    }\n  ],\n  \"mainContact\": {\n    \"id\": 123,\n    \"email\": \"value\",\n    \"firstName\": \"value\",\n    \"lastName\": \"value\",\n    \"jobTitle\": \"value\",\n    \"phoneNumber\": \"value\",\n    \"linkedInProfileUrl\": \"value\",\n    \"accountActivationUrl\": \"value\",\n    \"partnerId\": 123,\n    \"isMainContact\": true\n  },\n  \"owner\": {\n    \"id\": 123,\n    \"email\": \"value\",\n    \"firstName\": \"value\",\n    \"lastName\": \"value\",\n    \"partnerId\": 123,\n    \"partnerName\": \"value\"\n  }\n}\n
\n","_postman_id":"4f3f6fca-e41c-42ad-b829-eb5c19ff6145"},{"name":"OnboardingStageStatusChanged","item":[],"id":"c1617330-6bbe-406f-a1d9-172dd727d2a2","description":"

Triggered when the status of an onboarding stage changed for a specific partner.

\n

Example payload:

\n
{\n  \"id\": 123,\n  \"name\": \"value\",\n  \"properties\": {\n    \"myCustomProperty\": \"value\"\n  },\n  \"status\": \"value\",\n  \"onboardingStatus\": \"value\",\n  \"onboardingStageId\": 123,\n  \"prospectionStageId\": 123,\n  \"referralCode\": \"value\",\n  \"onboardingStage\": {\n    \"id\": 123,\n    \"name\": \"value\",\n    \"pipelineId\": 123,\n    \"pipelineName\": \"value\",\n    \"startedDate\": \"2024-01-15T10:30:00Z\",\n    \"completedDate\": \"2024-01-15T10:30:00Z\",\n    \"status\": \"value\",\n    \"pipeline\": {\n      \"id\": 123,\n      \"name\": \"value\",\n      \"startedDate\": \"2024-01-15T10:30:00Z\",\n      \"completedDate\": \"2024-01-15T10:30:00Z\",\n      \"onboardingStatus\": \"value\"\n    }\n  },\n  \"onboardingStages\": [\n    {\n      \"id\": 123,\n      \"name\": \"value\",\n      \"pipelineId\": 123,\n      \"pipelineName\": \"value\",\n      \"startedDate\": \"2024-01-15T10:30:00Z\",\n      \"completedDate\": \"2024-01-15T10:30:00Z\",\n      \"status\": \"value\",\n      \"pipeline\": {\n        \"id\": 123,\n        \"name\": \"value\",\n        \"startedDate\": \"2024-01-15T10:30:00Z\",\n        \"completedDate\": \"2024-01-15T10:30:00Z\",\n        \"onboardingStatus\": \"value\"\n      }\n    }\n  ],\n  \"prospectionStage\": {\n    \"id\": 123,\n    \"name\": \"value\"\n  },\n  \"programs\": [\n    {\n      \"id\": 123,\n      \"name\": \"value\",\n      \"levelId\": 123,\n      \"levelName\": \"value\"\n    }\n  ],\n  \"mainContact\": {\n    \"id\": 123,\n    \"email\": \"value\",\n    \"firstName\": \"value\",\n    \"lastName\": \"value\",\n    \"jobTitle\": \"value\",\n    \"phoneNumber\": \"value\",\n    \"linkedInProfileUrl\": \"value\",\n    \"accountActivationUrl\": \"value\",\n    \"partnerId\": 123,\n    \"isMainContact\": true\n  },\n  \"owner\": {\n    \"id\": 123,\n    \"email\": \"value\",\n    \"firstName\": \"value\",\n    \"lastName\": \"value\",\n    \"partnerId\": 123,\n    \"partnerName\": \"value\"\n  }\n}\n
\n","_postman_id":"c1617330-6bbe-406f-a1d9-172dd727d2a2"},{"name":"BusinessPlanObjectiveUpdated","item":[],"id":"fe2e442d-3884-4921-a0a9-89f9a0926196","description":"

Triggered when a business plan objective is updated.

\n

Example payload:

\n
{\n  \"id\": 123,\n  \"name\": \"value\",\n  \"category\": \"value\",\n  \"currentValue\": 123.45,\n  \"targetValue\": 123.45,\n  \"currency\": \"value\",\n  \"businessPlanId\": 123,\n  \"businessPlan\": {\n    \"id\": 123,\n    \"name\": \"value\",\n    \"startDate\": \"2024-01-15T10:30:00Z\",\n    \"endDate\": \"2024-01-15T10:30:00Z\",\n    \"status\": \"value\",\n    \"partnerId\": 123,\n    \"partner\": {\n      \"id\": 123,\n      \"name\": \"value\",\n      \"properties\": {\n        \"myCustomProperty\": \"value\"\n      },\n      \"status\": \"value\",\n      \"onboardingStatus\": \"value\",\n      \"onboardingStageId\": 123,\n      \"prospectionStageId\": 123,\n      \"referralCode\": \"value\",\n      \"onboardingStage\": {\n        \"id\": 123,\n        \"name\": \"value\",\n        \"pipelineId\": 123,\n        \"pipelineName\": \"value\",\n        \"startedDate\": \"2024-01-15T10:30:00Z\",\n        \"completedDate\": \"2024-01-15T10:30:00Z\",\n        \"status\": \"value\",\n        \"pipeline\": {\n          \"id\": 123,\n          \"name\": \"value\",\n          \"startedDate\": \"2024-01-15T10:30:00Z\",\n          \"completedDate\": \"2024-01-15T10:30:00Z\",\n          \"onboardingStatus\": \"value\"\n        }\n      },\n      \"onboardingStages\": [\n        {\n          \"id\": 123,\n          \"name\": \"value\",\n          \"pipelineId\": 123,\n          \"pipelineName\": \"value\",\n          \"startedDate\": \"2024-01-15T10:30:00Z\",\n          \"completedDate\": \"2024-01-15T10:30:00Z\",\n          \"status\": \"value\",\n          \"pipeline\": {\n            \"id\": 123,\n            \"name\": \"value\",\n            \"startedDate\": \"2024-01-15T10:30:00Z\",\n            \"completedDate\": \"2024-01-15T10:30:00Z\",\n            \"onboardingStatus\": \"value\"\n          }\n        }\n      ],\n      \"prospectionStage\": {\n        \"id\": 123,\n        \"name\": \"value\"\n      },\n      \"programs\": [\n        {\n          \"id\": 123,\n          \"name\": \"value\",\n          \"levelId\": 123,\n          \"levelName\": \"value\"\n        }\n      ],\n      \"mainContact\": {\n        \"id\": 123,\n        \"email\": \"value\",\n        \"firstName\": \"value\",\n        \"lastName\": \"value\",\n        \"jobTitle\": \"value\",\n        \"phoneNumber\": \"value\",\n        \"linkedInProfileUrl\": \"value\",\n        \"accountActivationUrl\": \"value\",\n        \"partnerId\": 123,\n        \"isMainContact\": true\n      },\n      \"owner\": {\n        \"id\": 123,\n        \"email\": \"value\",\n        \"firstName\": \"value\",\n        \"lastName\": \"value\",\n        \"partnerId\": 123,\n        \"partnerName\": \"value\"\n      }\n    }\n  }\n}\n
\n","_postman_id":"fe2e442d-3884-4921-a0a9-89f9a0926196"}],"id":"72e371fa-363f-4342-ae1f-477e3d1d1573","description":"

Find below the list of all supported webhooks.

\n","_postman_id":"72e371fa-363f-4342-ae1f-477e3d1d1573"}],"id":"38f4ad64-c1ff-4d9d-9137-582f9a9bdbfd","description":"

Webhooks allow your application to receive information about events happening in your Kiflo account. Webhooks are more scalable than periodically polling API for changes.

\n","_postman_id":"38f4ad64-c1ff-4d9d-9137-582f9a9bdbfd"}],"id":"e3cffd38-e3ac-40e4-b320-327024597c1b","_postman_id":"e3cffd38-e3ac-40e4-b320-327024597c1b","description":""},{"name":"Partner API","item":[{"name":"Endpoints","item":[{"name":"Customers","item":[{"name":"List customers","id":"976b34b6-4531-4973-a769-9ab0cc05c9fd","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"//v3/customers?partner_id=&partner_id=&offset=&limit=&sort_by=&order_by=","description":"

List customers and filter them by partner or any custom properties.

\n

To filter customers on custom property, just add the property with its exact value as a query parameter:
myCustomProp=ThisIsAValue
This will return the customers where myCustomProp exactly matches the provided value.

\n","urlObject":{"path":["v3","customers"],"host":["/"],"query":[{"key":"partner_id","value":""},{"key":"partner_id","value":""},{"key":"offset","value":""},{"key":"limit","value":""},{"key":"sort_by","value":""},{"key":"order_by","value":""}],"variable":[]}},"response":[{"id":"5a702d6a-c84a-4ace-a901-f8a1500e0aa1","name":"Customers returned","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"//v3/customers?partner_id=&offset=&limit=&sort_by=&order_by=","host":["/"],"path":["v3","customers"],"query":[{"key":"partner_id","value":""},{"key":"offset","value":""},{"key":"limit","value":""},{"key":"sort_by","value":""},{"key":"order_by","value":""}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"items\": [\n {\n \"id\": \"\",\n \"creationDate\": \"\",\n \"properties\": {\n \"key_0\": \"\",\n \"key_1\": \"\",\n \"key_2\": \"\"\n },\n \"sourcePartnerId\": \"\",\n \"sourceLeadId\": \"\",\n \"status\": \"Canceled\",\n \"source\": \"OnlineReferral\",\n \"isDeleted\": \"\",\n \"deletionDate\": \"\"\n },\n {\n \"id\": \"\",\n \"creationDate\": \"\",\n \"properties\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"sourcePartnerId\": \"\",\n \"sourceLeadId\": \"\",\n \"status\": \"Paying\",\n \"source\": \"Deal\",\n \"isDeleted\": \"\",\n \"deletionDate\": \"\"\n }\n ],\n \"paginationSkipCount\": \"\",\n \"totalCount\": \"\"\n}"},{"id":"4a07e582-6914-424f-9b21-f92d3156eb70","name":"Partner program settings do not grant access to customers","originalRequest":{"method":"GET","header":[],"url":{"raw":"//v3/customers?partner_id=&offset=&limit=&sort_by=&order_by=","host":["/"],"path":["v3","customers"],"query":[{"key":"partner_id","value":""},{"key":"offset","value":""},{"key":"limit","value":""},{"key":"sort_by","value":""},{"key":"order_by","value":""}]}},"status":"Forbidden","code":403,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":null}],"_postman_id":"976b34b6-4531-4973-a769-9ab0cc05c9fd"},{"name":"Get customer","id":"83bb5f9a-b900-4eec-b6ce-ee281a878b01","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"//v3/customers/:id","description":"

Retrieve an existing customer by id.

\n","urlObject":{"path":["v3","customers",":id"],"host":["/"],"query":[],"variable":[{"id":"76859131-f9ec-4f28-abe6-086ed40e843e","description":{"content":"

(Required) The ID of the customer to return.

\n","type":"text/plain"},"type":"any","value":"","key":"id"}]}},"response":[{"id":"e62a6aef-f999-4fb8-9165-1be74f5b9187","name":"Customer found","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"//v3/customers/:id","host":["/"],"path":["v3","customers",":id"],"variable":[{"key":"id","value":"","description":"(Required) The ID of the customer to return."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"\",\n \"creationDate\": \"\",\n \"properties\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"sourcePartnerId\": \"\",\n \"sourceLeadId\": \"\",\n \"status\": \"Canceled\",\n \"source\": \"Deal\",\n \"isDeleted\": \"\",\n \"deletionDate\": \"\"\n}"},{"id":"95d65088-3f17-4fe6-aeb8-5948e510e262","name":"Partner program settings do not grant access to customers","originalRequest":{"method":"GET","header":[],"url":{"raw":"//v3/customers/:id","host":["/"],"path":["v3","customers",":id"],"variable":[{"key":"id","value":"","description":"(Required) The ID of the customer to return."}]}},"status":"Forbidden","code":403,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":null},{"id":"7b9df03c-980b-4fab-b7f1-0c559362067b","name":"Customer not found","originalRequest":{"method":"GET","header":[],"url":{"raw":"//v3/customers/:id","host":["/"],"path":["v3","customers",":id"],"variable":[{"key":"id","value":"","description":"(Required) The ID of the customer to return."}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":null}],"_postman_id":"83bb5f9a-b900-4eec-b6ce-ee281a878b01"}],"id":"10c95b78-0d31-4e41-b584-b0f12cc738e8","_postman_id":"10c95b78-0d31-4e41-b584-b0f12cc738e8","description":""},{"name":"Deals","item":[{"name":"Create deal","id":"613008d2-124f-4435-a712-658a91f1322c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"contactId\": \"\",\n \"stage\": \"\",\n \"closeDate\": \"\",\n \"properties\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"partners\": [\n {\n \"partnerId\": \"\",\n \"partnerType\": \"\",\n \"userPartnerOwnerId\": \"\"\n },\n {\n \"partnerId\": \"\",\n \"partnerType\": \"\",\n \"userPartnerOwnerId\": \"\"\n }\n ],\n \"contact\": {\n \"properties\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"source\": \"HubSpot\"\n },\n \"source\": \"PartnerDirectory\",\n \"contractStartDate\": \"\",\n \"contractEndDate\": \"\",\n \"currency\": \"\",\n \"sourcePartnerId\": \"\",\n \"status\": \"Pending\",\n \"ownerUserId\": \"\",\n \"assignToPartnerOwner\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"//v3/deals","description":"

Create a new deal and associate roles on it for existing partners.

\n

Body parameters

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterTypeDescription
contactIdintegerID of an existing contact to link to this deal. Mutually exclusive with contact.
stagestringThe deal pipeline stage name. Must match an existing stage configured in your Kiflo account (e.g. New, Qualified, Closed Won).
closeDatestringExpected close date of the deal. ISO 8601 UTC format (e.g. 2025-12-31T00:00:00Z).
propertiesobjectDictionary of custom deal properties defined in your Kiflo account. Keys are the property API names.
partnersarrayList of partner roles on the deal. Each entry links a partner with a specific role type. See partners[] below.
contactobjectInline contact to create and associate with the deal. Mutually exclusive with contactId. See contact below.
sourcestringOrigin of the deal data. Accepted values: Unknown, Website, Partner, Api, Zapier, Tenant, System, HubSpot, Stripe, PartnerDirectory.
contractStartDatestringContract start date. ISO 8601 UTC format.
contractEndDatestringContract end date. ISO 8601 UTC format.
currencystringISO 4217 currency code (e.g. USD, EUR).
sourcePartnerIdintegerID of the partner that sourced this deal. Required when source is set to Partner.
statusstringInitial deal status. Accepted values: Pending, Accepted, Refused, Expired. Defaults to Pending.
ownerUserIdintegerID of the internal user to set as deal owner. Leave null to rely on the assignToPartnerOwner logic instead.
assignToPartnerOwnerbooleanWhen true, automatically assigns the deal owner from the source partner's owner. Only applied when ownerUserId is not set. Defaults to true.
\n

partners[]

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterTypeDescription
partnerIdintegerRequired. ID of the partner to associate with the deal.
partnerTypestringThe partner role name (e.g. Reseller, Business Introducer). Must match an existing partner type in your account.
userPartnerOwnerIdintegerID of the partner's user to set as deal contact on the partner side. Leave null to use the partner's default owner.
\n

contact

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterTypeDescription
propertiesobjectContact properties. Must include at minimum firstName, lastName, and email.
sourcestringOrigin of the contact data. Accepted values: Unknown, Website, Partner, Api, Zapier, Tenant, System, HubSpot, Stripe, PartnerDirectory.
\n
","urlObject":{"path":["v3","deals"],"host":["/"],"query":[],"variable":[]}},"response":[{"id":"5f628bb4-ee67-4e37-808d-dc89b5a8d0a7","name":"Deal created","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"contactId\": \"\",\n \"stage\": \"\",\n \"closeDate\": \"\",\n \"properties\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"partners\": [\n {\n \"partnerId\": \"\",\n \"partnerType\": \"\",\n \"userPartnerOwnerId\": \"\"\n },\n {\n \"partnerId\": \"\",\n \"partnerType\": \"\",\n \"userPartnerOwnerId\": \"\"\n }\n ],\n \"contact\": {\n \"properties\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"source\": \"HubSpot\"\n },\n \"source\": \"PartnerDirectory\",\n \"contractStartDate\": \"\",\n \"contractEndDate\": \"\",\n \"currency\": \"\",\n \"sourcePartnerId\": \"\",\n \"status\": \"Pending\",\n \"ownerUserId\": \"\",\n \"assignToPartnerOwner\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"//v3/deals"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"\",\n \"contactId\": \"\",\n \"sourcePartnerId\": \"\",\n \"stage\": \"\",\n \"creationDate\": \"\",\n \"totalAmount\": \"\",\n \"properties\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"sourceLeadId\": \"\",\n \"status\": \"Pending\",\n \"partners\": [\n {\n \"id\": \"\",\n \"dealId\": \"\",\n \"userPartnerOwnerId\": \"\",\n \"userPartnerOwnerName\": \"\",\n \"userPartnerFirstName\": \"\",\n \"userPartnerLastName\": \"\",\n \"userPartnerEmail\": \"\",\n \"userPartnerJobTitle\": \"\",\n \"userPartnerPhoneNumber\": \"\",\n \"userPartnerLinkedInProfileUrl\": \"\",\n \"partnerId\": \"\",\n \"partnerTypeId\": \"\",\n \"creationDate\": \"\",\n \"partnerName\": \"\",\n \"partnerTypeName\": \"\"\n },\n {\n \"id\": \"\",\n \"dealId\": \"\",\n \"userPartnerOwnerId\": \"\",\n \"userPartnerOwnerName\": \"\",\n \"userPartnerFirstName\": \"\",\n \"userPartnerLastName\": \"\",\n \"userPartnerEmail\": \"\",\n \"userPartnerJobTitle\": \"\",\n \"userPartnerPhoneNumber\": \"\",\n \"userPartnerLinkedInProfileUrl\": \"\",\n \"partnerId\": \"\",\n \"partnerTypeId\": \"\",\n \"creationDate\": \"\",\n \"partnerName\": \"\",\n \"partnerTypeName\": \"\"\n }\n ],\n \"contractStartDate\": \"\",\n \"contractEndDate\": \"\",\n \"ownerUserId\": \"\",\n \"owner\": {\n \"id\": \"\",\n \"email\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\"\n },\n \"closeDate\": \"\",\n \"customerId\": \"\",\n \"currency\": \"\"\n}"},{"id":"afb1b9da-5f1b-464b-8844-842b6dfca0ce","name":"Invalid request","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"contactId\": \"\",\n \"stage\": \"\",\n \"closeDate\": \"\",\n \"properties\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"partners\": [\n {\n \"partnerId\": \"\",\n \"partnerType\": \"\",\n \"userPartnerOwnerId\": \"\"\n },\n {\n \"partnerId\": \"\",\n \"partnerType\": \"\",\n \"userPartnerOwnerId\": \"\"\n }\n ],\n \"contact\": {\n \"properties\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"source\": \"HubSpot\"\n },\n \"source\": \"PartnerDirectory\",\n \"contractStartDate\": \"\",\n \"contractEndDate\": \"\",\n \"currency\": \"\",\n \"sourcePartnerId\": \"\",\n \"status\": \"Pending\",\n \"ownerUserId\": \"\",\n \"assignToPartnerOwner\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"//v3/deals"},"status":"Bad Request","code":400,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":null},{"id":"f1f9938d-a7d2-4e1b-9d44-b9d150c9fdca","name":"Partner program settings do not grant access to deals","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"contactId\": \"\",\n \"stage\": \"\",\n \"closeDate\": \"\",\n \"properties\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"partners\": [\n {\n \"partnerId\": \"\",\n \"partnerType\": \"\",\n \"userPartnerOwnerId\": \"\"\n },\n {\n \"partnerId\": \"\",\n \"partnerType\": \"\",\n \"userPartnerOwnerId\": \"\"\n }\n ],\n \"contact\": {\n \"properties\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"source\": \"HubSpot\"\n },\n \"source\": \"PartnerDirectory\",\n \"contractStartDate\": \"\",\n \"contractEndDate\": \"\",\n \"currency\": \"\",\n \"sourcePartnerId\": \"\",\n \"status\": \"Pending\",\n \"ownerUserId\": \"\",\n \"assignToPartnerOwner\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"//v3/deals"},"status":"Forbidden","code":403,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":null}],"_postman_id":"613008d2-124f-4435-a712-658a91f1322c"},{"name":"List deals","id":"02fb593e-dd9e-4d71-883f-7fa19cef54df","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"//v3/deals?offset=0&limit=20&sort_by=&order_by=","description":"

List deals and filter them by custom properties.

\n

To filter deals on custom property, just add the property with its exact value as a query parameter:
myCustomProp=ThisIsAValue
This will return the deals where myCustomProp exactly matches the provided value.

\n","urlObject":{"path":["v3","deals"],"host":["/"],"query":[{"description":{"content":"

The cursor used in pagination. This is the index of the first deal to be returned.

\n","type":"text/plain"},"key":"offset","value":"0"},{"description":{"content":"

The maximum number of deals to be returned. The default is 20.

\n","type":"text/plain"},"key":"limit","value":"20"},{"description":{"content":"

The property used to sort the deals by. The default is CreationDate.

\n","type":"text/plain"},"key":"sort_by","value":""},{"description":{"content":"

The sorting direction for the returned deals. Accepted values: ASC, DESC. The default is DESC.

\n","type":"text/plain"},"key":"order_by","value":""}],"variable":[]}},"response":[{"id":"295fcc53-e2cf-453e-a076-f035b94c1c10","name":"Deals returned","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"//v3/deals?offset=0&limit=20&sort_by=&order_by=","host":["/"],"path":["v3","deals"],"query":[{"description":"The cursor used in pagination. This is the index of the first deal to be returned.","key":"offset","value":"0"},{"description":"The maximum number of deals to be returned. The default is 20.","key":"limit","value":"20"},{"description":"The property used to sort the deals by. The default is CreationDate.","key":"sort_by","value":""},{"description":"The sorting direction for the returned deals. Accepted values: ASC, DESC. The default is DESC.","key":"order_by","value":""}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"items\": [\n {\n \"id\": \"\",\n \"contactId\": \"\",\n \"sourcePartnerId\": \"\",\n \"stage\": \"\",\n \"creationDate\": \"\",\n \"totalAmount\": \"\",\n \"properties\": {\n \"key_0\": \"\"\n },\n \"sourceLeadId\": \"\",\n \"status\": \"Unknown\",\n \"partners\": [\n {\n \"id\": \"\",\n \"dealId\": \"\",\n \"userPartnerOwnerId\": \"\",\n \"userPartnerOwnerName\": \"\",\n \"userPartnerFirstName\": \"\",\n \"userPartnerLastName\": \"\",\n \"userPartnerEmail\": \"\",\n \"userPartnerJobTitle\": \"\",\n \"userPartnerPhoneNumber\": \"\",\n \"userPartnerLinkedInProfileUrl\": \"\",\n \"partnerId\": \"\",\n \"partnerTypeId\": \"\",\n \"creationDate\": \"\",\n \"partnerName\": \"\",\n \"partnerTypeName\": \"\"\n },\n {\n \"id\": \"\",\n \"dealId\": \"\",\n \"userPartnerOwnerId\": \"\",\n \"userPartnerOwnerName\": \"\",\n \"userPartnerFirstName\": \"\",\n \"userPartnerLastName\": \"\",\n \"userPartnerEmail\": \"\",\n \"userPartnerJobTitle\": \"\",\n \"userPartnerPhoneNumber\": \"\",\n \"userPartnerLinkedInProfileUrl\": \"\",\n \"partnerId\": \"\",\n \"partnerTypeId\": \"\",\n \"creationDate\": \"\",\n \"partnerName\": \"\",\n \"partnerTypeName\": \"\"\n }\n ],\n \"contractStartDate\": \"\",\n \"contractEndDate\": \"\",\n \"ownerUserId\": \"\",\n \"owner\": {\n \"id\": \"\",\n \"email\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\"\n },\n \"closeDate\": \"\",\n \"customerId\": \"\",\n \"currency\": \"\"\n },\n {\n \"id\": \"\",\n \"contactId\": \"\",\n \"sourcePartnerId\": \"\",\n \"stage\": \"\",\n \"creationDate\": \"\",\n \"totalAmount\": \"\",\n \"properties\": {\n \"key_0\": \"\",\n \"key_1\": \"\",\n \"key_2\": \"\",\n \"key_3\": \"\"\n },\n \"sourceLeadId\": \"\",\n \"status\": \"Accepted\",\n \"partners\": [\n {\n \"id\": \"\",\n \"dealId\": \"\",\n \"userPartnerOwnerId\": \"\",\n \"userPartnerOwnerName\": \"\",\n \"userPartnerFirstName\": \"\",\n \"userPartnerLastName\": \"\",\n \"userPartnerEmail\": \"\",\n \"userPartnerJobTitle\": \"\",\n \"userPartnerPhoneNumber\": \"\",\n \"userPartnerLinkedInProfileUrl\": \"\",\n \"partnerId\": \"\",\n \"partnerTypeId\": \"\",\n \"creationDate\": \"\",\n \"partnerName\": \"\",\n \"partnerTypeName\": \"\"\n },\n {\n \"id\": \"\",\n \"dealId\": \"\",\n \"userPartnerOwnerId\": \"\",\n \"userPartnerOwnerName\": \"\",\n \"userPartnerFirstName\": \"\",\n \"userPartnerLastName\": \"\",\n \"userPartnerEmail\": \"\",\n \"userPartnerJobTitle\": \"\",\n \"userPartnerPhoneNumber\": \"\",\n \"userPartnerLinkedInProfileUrl\": \"\",\n \"partnerId\": \"\",\n \"partnerTypeId\": \"\",\n \"creationDate\": \"\",\n \"partnerName\": \"\",\n \"partnerTypeName\": \"\"\n }\n ],\n \"contractStartDate\": \"\",\n \"contractEndDate\": \"\",\n \"ownerUserId\": \"\",\n \"owner\": {\n \"id\": \"\",\n \"email\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\"\n },\n \"closeDate\": \"\",\n \"customerId\": \"\",\n \"currency\": \"\"\n }\n ],\n \"paginationSkipCount\": \"\",\n \"totalCount\": \"\"\n}"},{"id":"3aa44ec2-a909-4d14-8877-4962005fa11c","name":"Partner program settings do not grant access to deals","originalRequest":{"method":"GET","header":[],"url":{"raw":"//v3/deals?offset=0&limit=20&sort_by=&order_by=","host":["/"],"path":["v3","deals"],"query":[{"description":"The cursor used in pagination. This is the index of the first deal to be returned.","key":"offset","value":"0"},{"description":"The maximum number of deals to be returned. The default is 20.","key":"limit","value":"20"},{"description":"The property used to sort the deals by. The default is CreationDate.","key":"sort_by","value":""},{"description":"The sorting direction for the returned deals. Accepted values: ASC, DESC. The default is DESC.","key":"order_by","value":""}]}},"status":"Forbidden","code":403,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":null}],"_postman_id":"02fb593e-dd9e-4d71-883f-7fa19cef54df"},{"name":"Get deal","id":"f8a0cab8-e80d-4432-9d04-c619c47092d4","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"//v3/deals/:id","description":"

Retrieve an existing deal by id.

\n","urlObject":{"path":["v3","deals",":id"],"host":["/"],"query":[],"variable":[{"id":"1a959db0-8da0-4adf-adc1-dfb909fe1a1d","description":{"content":"

(Required) The ID of the deal to return.

\n","type":"text/plain"},"type":"any","value":"","key":"id"}]}},"response":[{"id":"acfb8c18-f7bd-472b-9030-3e6c467fd9a5","name":"Deal found","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"//v3/deals/:id","host":["/"],"path":["v3","deals",":id"],"variable":[{"key":"id","value":"","description":"(Required) The ID of the deal to return."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"\",\n \"contactId\": \"\",\n \"sourcePartnerId\": \"\",\n \"stage\": \"\",\n \"creationDate\": \"\",\n \"totalAmount\": \"\",\n \"properties\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"sourceLeadId\": \"\",\n \"status\": \"Pending\",\n \"partners\": [\n {\n \"id\": \"\",\n \"dealId\": \"\",\n \"userPartnerOwnerId\": \"\",\n \"userPartnerOwnerName\": \"\",\n \"userPartnerFirstName\": \"\",\n \"userPartnerLastName\": \"\",\n \"userPartnerEmail\": \"\",\n \"userPartnerJobTitle\": \"\",\n \"userPartnerPhoneNumber\": \"\",\n \"userPartnerLinkedInProfileUrl\": \"\",\n \"partnerId\": \"\",\n \"partnerTypeId\": \"\",\n \"creationDate\": \"\",\n \"partnerName\": \"\",\n \"partnerTypeName\": \"\"\n },\n {\n \"id\": \"\",\n \"dealId\": \"\",\n \"userPartnerOwnerId\": \"\",\n \"userPartnerOwnerName\": \"\",\n \"userPartnerFirstName\": \"\",\n \"userPartnerLastName\": \"\",\n \"userPartnerEmail\": \"\",\n \"userPartnerJobTitle\": \"\",\n \"userPartnerPhoneNumber\": \"\",\n \"userPartnerLinkedInProfileUrl\": \"\",\n \"partnerId\": \"\",\n \"partnerTypeId\": \"\",\n \"creationDate\": \"\",\n \"partnerName\": \"\",\n \"partnerTypeName\": \"\"\n }\n ],\n \"contractStartDate\": \"\",\n \"contractEndDate\": \"\",\n \"ownerUserId\": \"\",\n \"owner\": {\n \"id\": \"\",\n \"email\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\"\n },\n \"closeDate\": \"\",\n \"customerId\": \"\",\n \"currency\": \"\"\n}"},{"id":"23d766b5-fae0-4563-ba6e-2e8ae4cc3bbc","name":"Partner program settings do not grant access to deals","originalRequest":{"method":"GET","header":[],"url":{"raw":"//v3/deals/:id","host":["/"],"path":["v3","deals",":id"],"variable":[{"key":"id","value":"","description":"(Required) The ID of the deal to return."}]}},"status":"Forbidden","code":403,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":null},{"id":"5507ef6b-c147-4ee8-b4ea-362e4d5f3ed3","name":"Deal not found","originalRequest":{"method":"GET","header":[],"url":{"raw":"//v3/deals/:id","host":["/"],"path":["v3","deals",":id"],"variable":[{"key":"id","value":"","description":"(Required) The ID of the deal to return."}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":null}],"_postman_id":"f8a0cab8-e80d-4432-9d04-c619c47092d4"},{"name":"Update deal","id":"da76ae2b-12f7-4ec2-afc6-cd2b1cd40cdf","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PATCH","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"id\": \"\",\n \"stage\": \"\",\n \"closeDate\": \"\",\n \"contractStartDate\": \"\",\n \"contractEndDate\": \"\",\n \"properties\": {\n \"key_0\": \"\",\n \"key_1\": \"\",\n \"key_2\": \"\"\n },\n \"partners\": [\n {\n \"partnerId\": \"\",\n \"partnerType\": \"\",\n \"userPartnerOwnerId\": \"\"\n },\n {\n \"partnerId\": \"\",\n \"partnerType\": \"\",\n \"userPartnerOwnerId\": \"\"\n }\n ],\n \"ownerUserId\": \"\",\n \"currency\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"//v3/deals/:id","description":"

You can only specify properties to update in the properties field as this method will PATCH the existing deal.\nProperties not found in the properties field will not be modified.

\n","urlObject":{"path":["v3","deals",":id"],"host":["/"],"query":[],"variable":[{"id":"dfa18e80-e519-420f-a758-ab4d1bad17e5","description":{"content":"

(Required) The ID of the deal to update.

\n","type":"text/plain"},"type":"any","value":"","key":"id"}]}},"response":[{"id":"3cc8f4de-e59e-4810-9d96-552fe575c035","name":"Deal updated","originalRequest":{"method":"PATCH","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"id\": \"\",\n \"stage\": \"\",\n \"closeDate\": \"\",\n \"contractStartDate\": \"\",\n \"contractEndDate\": \"\",\n \"properties\": {\n \"key_0\": \"\",\n \"key_1\": \"\",\n \"key_2\": \"\"\n },\n \"partners\": [\n {\n \"partnerId\": \"\",\n \"partnerType\": \"\",\n \"userPartnerOwnerId\": \"\"\n },\n {\n \"partnerId\": \"\",\n \"partnerType\": \"\",\n \"userPartnerOwnerId\": \"\"\n }\n ],\n \"ownerUserId\": \"\",\n \"currency\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"//v3/deals/:id","host":["/"],"path":["v3","deals",":id"],"variable":[{"key":"id","value":"","description":"(Required) The ID of the deal to update."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"\",\n \"contactId\": \"\",\n \"sourcePartnerId\": \"\",\n \"stage\": \"\",\n \"creationDate\": \"\",\n \"totalAmount\": \"\",\n \"properties\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"sourceLeadId\": \"\",\n \"status\": \"Pending\",\n \"partners\": [\n {\n \"id\": \"\",\n \"dealId\": \"\",\n \"userPartnerOwnerId\": \"\",\n \"userPartnerOwnerName\": \"\",\n \"userPartnerFirstName\": \"\",\n \"userPartnerLastName\": \"\",\n \"userPartnerEmail\": \"\",\n \"userPartnerJobTitle\": \"\",\n \"userPartnerPhoneNumber\": \"\",\n \"userPartnerLinkedInProfileUrl\": \"\",\n \"partnerId\": \"\",\n \"partnerTypeId\": \"\",\n \"creationDate\": \"\",\n \"partnerName\": \"\",\n \"partnerTypeName\": \"\"\n },\n {\n \"id\": \"\",\n \"dealId\": \"\",\n \"userPartnerOwnerId\": \"\",\n \"userPartnerOwnerName\": \"\",\n \"userPartnerFirstName\": \"\",\n \"userPartnerLastName\": \"\",\n \"userPartnerEmail\": \"\",\n \"userPartnerJobTitle\": \"\",\n \"userPartnerPhoneNumber\": \"\",\n \"userPartnerLinkedInProfileUrl\": \"\",\n \"partnerId\": \"\",\n \"partnerTypeId\": \"\",\n \"creationDate\": \"\",\n \"partnerName\": \"\",\n \"partnerTypeName\": \"\"\n }\n ],\n \"contractStartDate\": \"\",\n \"contractEndDate\": \"\",\n \"ownerUserId\": \"\",\n \"owner\": {\n \"id\": \"\",\n \"email\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\"\n },\n \"closeDate\": \"\",\n \"customerId\": \"\",\n \"currency\": \"\"\n}"},{"id":"79db23c3-5daa-4b49-b524-87112495c594","name":"Deal not found","originalRequest":{"method":"PATCH","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"id\": \"\",\n \"stage\": \"\",\n \"closeDate\": \"\",\n \"contractStartDate\": \"\",\n \"contractEndDate\": \"\",\n \"properties\": {\n \"key_0\": \"\",\n \"key_1\": \"\",\n \"key_2\": \"\"\n },\n \"partners\": [\n {\n \"partnerId\": \"\",\n \"partnerType\": \"\",\n \"userPartnerOwnerId\": \"\"\n },\n {\n \"partnerId\": \"\",\n \"partnerType\": \"\",\n \"userPartnerOwnerId\": \"\"\n }\n ],\n \"ownerUserId\": \"\",\n \"currency\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"//v3/deals/:id","host":["/"],"path":["v3","deals",":id"],"variable":[{"key":"id","value":"","description":"(Required) The ID of the deal to update."}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":null}],"_postman_id":"da76ae2b-12f7-4ec2-afc6-cd2b1cd40cdf"}],"id":"c713033f-de05-4108-90f1-0793aa7f1c60","_postman_id":"c713033f-de05-4108-90f1-0793aa7f1c60","description":""},{"name":"Leads","item":[{"name":"List leads","id":"75266e56-7bb8-44ac-91fa-d0cbb2e83df4","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"//v3/leads?partnerId=&offset=&limit=&sort_by=&order_by=&status=Reassigned&status=Accepted","description":"

List leads and filter them by partner, status or any custom properties.

\n

To filter leads on custom property, just add the property with its exact value as a query parameter:
myCustomProp=ThisIsAValue
This will return the leads where myCustomProp exactly matches the provided value.

\n","urlObject":{"path":["v3","leads"],"host":["/"],"query":[{"description":{"content":"

The list of partner IDs to filter the leads on.

\n","type":"text/plain"},"key":"partnerId","value":""},{"description":{"content":"

The cursor used in pagination. This is the index of the first lead to be returned.

\n","type":"text/plain"},"key":"offset","value":""},{"description":{"content":"

The maximum number of leads to be returned. The default is 20.

\n","type":"text/plain"},"key":"limit","value":""},{"description":{"content":"

The property used to sort the leads by. The default is CreationDate.

\n","type":"text/plain"},"key":"sort_by","value":""},{"description":{"content":"

The sorting direction for the returned leads. Accepted values: ASC, DESC. The default is DESC.

\n","type":"text/plain"},"key":"order_by","value":""},{"key":"status","value":"Reassigned"},{"key":"status","value":"Accepted"}],"variable":[]}},"response":[{"id":"05853a50-f29d-4e72-b2ce-aca736970130","name":"Leads returned","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"//v3/leads?partnerId=&offset=&limit=&sort_by=&order_by=&status=Accepted","host":["/"],"path":["v3","leads"],"query":[{"description":"The list of partner IDs to filter the leads on.","key":"partnerId","value":""},{"description":"The cursor used in pagination. This is the index of the first lead to be returned.","key":"offset","value":""},{"description":"The maximum number of leads to be returned. The default is 20.","key":"limit","value":""},{"description":"The property used to sort the leads by. The default is CreationDate.","key":"sort_by","value":""},{"description":"The sorting direction for the returned leads. Accepted values: ASC, DESC. The default is DESC.","key":"order_by","value":""},{"key":"status","value":"Accepted"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"items\": [\n {\n \"id\": \"\",\n \"creationDate\": \"\",\n \"properties\": {\n \"key_0\": \"\",\n \"key_1\": \"\",\n \"key_2\": \"\"\n },\n \"partnerId\": \"\",\n \"sourcePartnerId\": \"\",\n \"userPartnerOwnerId\": \"\",\n \"dealId\": \"\",\n \"customerId\": \"\",\n \"deadLine\": \"\",\n \"assignedDate\": \"\",\n \"acceptedDate\": \"\",\n \"refusedDate\": \"\",\n \"convertedDate\": \"\",\n \"abandonedDate\": \"\",\n \"status\": \"Unassigned\",\n \"partnerName\": \"\",\n \"dealName\": \"\",\n \"customerName\": \"\",\n \"source\": \"PartnerDirectory\",\n \"transferredLeadId\": \"\",\n \"currency\": \"\",\n \"ownerUserId\": \"\",\n \"owner\": {\n \"id\": \"\",\n \"email\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\"\n }\n },\n {\n \"id\": \"\",\n \"creationDate\": \"\",\n \"properties\": {\n \"key_0\": \"\",\n \"key_1\": \"\",\n \"key_2\": \"\"\n },\n \"partnerId\": \"\",\n \"sourcePartnerId\": \"\",\n \"userPartnerOwnerId\": \"\",\n \"dealId\": \"\",\n \"customerId\": \"\",\n \"deadLine\": \"\",\n \"assignedDate\": \"\",\n \"acceptedDate\": \"\",\n \"refusedDate\": \"\",\n \"convertedDate\": \"\",\n \"abandonedDate\": \"\",\n \"status\": \"Pending\",\n \"partnerName\": \"\",\n \"dealName\": \"\",\n \"customerName\": \"\",\n \"source\": \"Partner\",\n \"transferredLeadId\": \"\",\n \"currency\": \"\",\n \"ownerUserId\": \"\",\n \"owner\": {\n \"id\": \"\",\n \"email\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\"\n }\n }\n ],\n \"paginationSkipCount\": \"\",\n \"totalCount\": \"\"\n}"},{"id":"55ae3963-a921-4d3b-bb2b-8f0f00fea375","name":"Partner program settings do not grant access to leads","originalRequest":{"method":"GET","header":[],"url":{"raw":"//v3/leads?partnerId=&offset=&limit=&sort_by=&order_by=&status=Accepted","host":["/"],"path":["v3","leads"],"query":[{"description":"The list of partner IDs to filter the leads on.","key":"partnerId","value":""},{"description":"The cursor used in pagination. This is the index of the first lead to be returned.","key":"offset","value":""},{"description":"The maximum number of leads to be returned. The default is 20.","key":"limit","value":""},{"description":"The property used to sort the leads by. The default is CreationDate.","key":"sort_by","value":""},{"description":"The sorting direction for the returned leads. Accepted values: ASC, DESC. The default is DESC.","key":"order_by","value":""},{"key":"status","value":"Accepted"}]}},"status":"Forbidden","code":403,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":null}],"_postman_id":"75266e56-7bb8-44ac-91fa-d0cbb2e83df4"},{"name":"Create lead","id":"ba41b90f-b6ec-46cf-91de-423ff250fe2a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"properties\": {\n \"key_0\": \"\"\n },\n \"currency\": \"\",\n \"ownerUserId\": \"\",\n \"partnerId\": \"\",\n \"sourcePartnerId\": \"\",\n \"userPartnerOwnerId\": \"\",\n \"assignedContactEmail\": \"\",\n \"deadLine\": \"\",\n \"note\": \"\",\n \"status\": \"Reassigned\",\n \"assignToPartnerOwner\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"//v3/leads","description":"

Create a new lead.

\n

You can assigned the lead with an existing partner using the partnerId property. You will be the source of the lead and the partner will have to\naccept or refuse the lead.

\n

You can set the source of the lead using the sourcePartnerId property. By doing that, you create the lead on behalf of the partner.\nHe won't have to accept or refuse the lead, the lead will be automatically accepted.

\n

Use the note property to add a new note on create lead.

\n

If the lead comes from your website via a referral link shared by a partner and you want to associate it with the correct partner, use the HTTP header:
Kiflo-Tracking-Code: AABBCCDDEEFF+=

\n

The** tracking code** can be retrieved in javascript from your website using the JS SDK.Please referer to theJS SDK documentation.

\n

The status property is optional and can be used only in conjunction with the header parameter Kiflo-Tracking-Code.\nIt can be one of the following value:

\n
    \n
  • Pending: the lead is assigned to the source partner and must be validated by you
    • \n
  • Accepted: the lead is assigned to the source partner and is automatically accepted
    • \n
  • Unassigned: the lead is not assigned to any partner, but the source partner is set correctly. it can be shared to another partner manually
    • \n
\n","urlObject":{"path":["v3","leads"],"host":["/"],"query":[],"variable":[]}},"response":[{"id":"6f853d57-82cb-461b-9348-c06038de50ce","name":"Lead created","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"properties\": {\n \"key_0\": \"\"\n },\n \"currency\": \"\",\n \"ownerUserId\": \"\",\n \"partnerId\": \"\",\n \"sourcePartnerId\": \"\",\n \"userPartnerOwnerId\": \"\",\n \"assignedContactEmail\": \"\",\n \"deadLine\": \"\",\n \"note\": \"\",\n \"status\": \"Reassigned\",\n \"assignToPartnerOwner\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"//v3/leads"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"\",\n \"creationDate\": \"\",\n \"properties\": {\n \"key_0\": \"\",\n \"key_1\": \"\",\n \"key_2\": \"\"\n },\n \"partnerId\": \"\",\n \"sourcePartnerId\": \"\",\n \"userPartnerOwnerId\": \"\",\n \"dealId\": \"\",\n \"customerId\": \"\",\n \"deadLine\": \"\",\n \"assignedDate\": \"\",\n \"acceptedDate\": \"\",\n \"refusedDate\": \"\",\n \"convertedDate\": \"\",\n \"abandonedDate\": \"\",\n \"status\": \"Unassigned\",\n \"partnerName\": \"\",\n \"dealName\": \"\",\n \"customerName\": \"\",\n \"source\": \"Zapier\",\n \"transferredLeadId\": \"\",\n \"currency\": \"\",\n \"ownerUserId\": \"\",\n \"owner\": {\n \"id\": \"\",\n \"email\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\"\n }\n}"},{"id":"57059a23-1e7f-405d-81ac-90cdae43b1c9","name":"Invalid request","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"properties\": {\n \"key_0\": \"\"\n },\n \"currency\": \"\",\n \"ownerUserId\": \"\",\n \"partnerId\": \"\",\n \"sourcePartnerId\": \"\",\n \"userPartnerOwnerId\": \"\",\n \"assignedContactEmail\": \"\",\n \"deadLine\": \"\",\n \"note\": \"\",\n \"status\": \"Reassigned\",\n \"assignToPartnerOwner\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"//v3/leads"},"status":"Bad Request","code":400,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":null},{"id":"b1f2c05c-3810-4a9a-8c7a-8131dc3707ce","name":"Partner program settings do not grant access to leads","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"properties\": {\n \"key_0\": \"\"\n },\n \"currency\": \"\",\n \"ownerUserId\": \"\",\n \"partnerId\": \"\",\n \"sourcePartnerId\": \"\",\n \"userPartnerOwnerId\": \"\",\n \"assignedContactEmail\": \"\",\n \"deadLine\": \"\",\n \"note\": \"\",\n \"status\": \"Reassigned\",\n \"assignToPartnerOwner\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"//v3/leads"},"status":"Forbidden","code":403,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":null}],"_postman_id":"ba41b90f-b6ec-46cf-91de-423ff250fe2a"},{"name":"Get lead","id":"116d8bba-8bf8-43a3-aeaf-015aef76358a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"//v3/leads/:id","description":"

Retrieve an existing lead by id.

\n","urlObject":{"path":["v3","leads",":id"],"host":["/"],"query":[],"variable":[{"id":"c8fa0a2c-7172-403f-8b9b-c6f4b52ac9c7","description":{"content":"

(Required) The ID of the lead to return.

\n","type":"text/plain"},"type":"any","value":"","key":"id"}]}},"response":[{"id":"55a8bc53-b7a5-4872-86c5-3c01642aca2d","name":"Lead found","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"//v3/leads/:id","host":["/"],"path":["v3","leads",":id"],"variable":[{"key":"id","value":"","description":"(Required) The ID of the lead to return."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"\",\n \"creationDate\": \"\",\n \"properties\": {\n \"key_0\": \"\",\n \"key_1\": \"\",\n \"key_2\": \"\"\n },\n \"partnerId\": \"\",\n \"sourcePartnerId\": \"\",\n \"userPartnerOwnerId\": \"\",\n \"dealId\": \"\",\n \"customerId\": \"\",\n \"deadLine\": \"\",\n \"assignedDate\": \"\",\n \"acceptedDate\": \"\",\n \"refusedDate\": \"\",\n \"convertedDate\": \"\",\n \"abandonedDate\": \"\",\n \"status\": \"Unassigned\",\n \"partnerName\": \"\",\n \"dealName\": \"\",\n \"customerName\": \"\",\n \"source\": \"Zapier\",\n \"transferredLeadId\": \"\",\n \"currency\": \"\",\n \"ownerUserId\": \"\",\n \"owner\": {\n \"id\": \"\",\n \"email\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\"\n }\n}"},{"id":"f10b0d86-97cf-4613-bd89-79f93d1d7d05","name":"Partner program settings do not grant access to leads","originalRequest":{"method":"GET","header":[],"url":{"raw":"//v3/leads/:id","host":["/"],"path":["v3","leads",":id"],"variable":[{"key":"id","value":"","description":"(Required) The ID of the lead to return."}]}},"status":"Forbidden","code":403,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":null},{"id":"c2808a5f-135e-4920-a101-5040592f3a4c","name":"Lead not found","originalRequest":{"method":"GET","header":[],"url":{"raw":"//v3/leads/:id","host":["/"],"path":["v3","leads",":id"],"variable":[{"key":"id","value":"","description":"(Required) The ID of the lead to return."}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":null}],"_postman_id":"116d8bba-8bf8-43a3-aeaf-015aef76358a"},{"name":"Update lead","id":"13603075-a973-4f19-9282-ec92bb35b297","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PATCH","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"deadLine\": \"\",\n \"properties\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"currency\": \"\",\n \"assignedContactEmail\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"//v3/leads/:id","description":"

Update an existing lead.

\n

You can changed the partner team member assigned on the lead using the assignedContactEmail prop.This has to be the email address of an existing team member in the partner's team.

\n","urlObject":{"path":["v3","leads",":id"],"host":["/"],"query":[],"variable":[{"id":"91e4e613-b856-4c2e-b515-60dc752bb23f","description":{"content":"

(Required) The ID of the lead to update.

\n","type":"text/plain"},"type":"any","value":"","key":"id"}]}},"response":[{"id":"a5183c63-cc81-467f-94f2-84d140786828","name":"Lead updated","originalRequest":{"method":"PATCH","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"deadLine\": \"\",\n \"properties\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"currency\": \"\",\n \"assignedContactEmail\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"//v3/leads/:id","host":["/"],"path":["v3","leads",":id"],"variable":[{"key":"id","value":"","description":"(Required) The ID of the lead to update."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"\",\n \"creationDate\": \"\",\n \"properties\": {\n \"key_0\": \"\",\n \"key_1\": \"\",\n \"key_2\": \"\"\n },\n \"partnerId\": \"\",\n \"sourcePartnerId\": \"\",\n \"userPartnerOwnerId\": \"\",\n \"dealId\": \"\",\n \"customerId\": \"\",\n \"deadLine\": \"\",\n \"assignedDate\": \"\",\n \"acceptedDate\": \"\",\n \"refusedDate\": \"\",\n \"convertedDate\": \"\",\n \"abandonedDate\": \"\",\n \"status\": \"Unassigned\",\n \"partnerName\": \"\",\n \"dealName\": \"\",\n \"customerName\": \"\",\n \"source\": \"Zapier\",\n \"transferredLeadId\": \"\",\n \"currency\": \"\",\n \"ownerUserId\": \"\",\n \"owner\": {\n \"id\": \"\",\n \"email\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\"\n }\n}"},{"id":"5d01510f-eb1c-4437-99e5-cd24486c3e02","name":"Lead not found","originalRequest":{"method":"PATCH","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"deadLine\": \"\",\n \"properties\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"currency\": \"\",\n \"assignedContactEmail\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"//v3/leads/:id","host":["/"],"path":["v3","leads",":id"],"variable":[{"key":"id","value":"","description":"(Required) The ID of the lead to update."}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":null}],"_postman_id":"13603075-a973-4f19-9282-ec92bb35b297"}],"id":"cce3bfcd-1e5d-4a01-ac71-1d9655de764e","_postman_id":"cce3bfcd-1e5d-4a01-ac71-1d9655de764e","description":""},{"name":"Payouts","item":[{"name":"List payouts","id":"cb9907d0-2ec4-4fcd-9d11-929f0ad818e0","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"//v3/payouts?partner_id=&partner_id=&from=&to=&offset=&limit=&sort_by=&order_by=","description":"

List payouts and filter them by partner or any custom properties.

\n

To filter payouts on custom property, just add the property with its exact value as a query parameter:\nmyCustomProp=ThisIsAValue\nThis will return the payout where myCustomProp exactly matches the provided value.

\n","urlObject":{"path":["v3","payouts"],"host":["/"],"query":[{"description":{"content":"

The list of partner IDs to filter the payouts on.

\n","type":"text/plain"},"key":"partner_id","value":""},{"description":{"content":"

The list of partner IDs to filter the payouts on.

\n","type":"text/plain"},"key":"partner_id","value":""},{"description":{"content":"

Filter payouts created after this date (Inclusive)

\n","type":"text/plain"},"key":"from","value":""},{"description":{"content":"

Filter payouts created before this date (Exclusive)

\n","type":"text/plain"},"key":"to","value":""},{"description":{"content":"

The cursor used in pagination. This is the index of the first payout to be returned.

\n","type":"text/plain"},"key":"offset","value":""},{"description":{"content":"

The maximum number of payouts to be returned. The default is 20.

\n","type":"text/plain"},"key":"limit","value":""},{"description":{"content":"

The property used to sort the payouts by. The default is CreationDate.

\n","type":"text/plain"},"key":"sort_by","value":""},{"description":{"content":"

The sorting direction for the returned payouts. Accepted values: ASC, DESC. The default is DESC.

\n","type":"text/plain"},"key":"order_by","value":""}],"variable":[]}},"response":[{"id":"e54abc1e-0ed6-44dd-9a77-3f256640ae68","name":"Payouts returned","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"//v3/payouts?partner_id=&from=&to=&offset=&limit=&sort_by=&order_by=","host":["/"],"path":["v3","payouts"],"query":[{"description":"The list of partner IDs to filter the payouts on.","key":"partner_id","value":""},{"description":"Filter payouts created after this date (Inclusive)","key":"from","value":""},{"description":"Filter payouts created before this date (Exclusive)","key":"to","value":""},{"description":"The cursor used in pagination. This is the index of the first payout to be returned.","key":"offset","value":""},{"description":"The maximum number of payouts to be returned. The default is 20.","key":"limit","value":""},{"description":"The property used to sort the payouts by. The default is CreationDate.","key":"sort_by","value":""},{"description":"The sorting direction for the returned payouts. Accepted values: ASC, DESC. The default is DESC.","key":"order_by","value":""}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"items\": [\n {\n \"id\": \"\",\n \"partnerId\": \"\",\n \"partnerName\": \"\",\n \"name\": \"\",\n \"uniqueId\": \"\",\n \"currency\": \"\",\n \"rewardType\": \"Cash\",\n \"fromDate\": \"\",\n \"toDate\": \"\",\n \"amount\": {\n \"value\": \"\",\n \"currency\": \"\"\n },\n \"taxAmount\": {\n \"value\": \"\",\n \"currency\": \"\"\n },\n \"grossAmount\": {\n \"value\": \"\",\n \"currency\": \"\"\n },\n \"rewardCount\": \"\",\n \"creationDate\": \"\",\n \"paidDate\": \"\",\n \"acceptedDate\": \"\",\n \"validatedDate\": \"\",\n \"paidByUserId\": \"\",\n \"acceptedByUserId\": \"\",\n \"validatedByUserId\": \"\",\n \"invalidatedDate\": \"\",\n \"invalidatedByUserId\": \"\",\n \"status\": \"Ready\",\n \"source\": \"Unknown\",\n \"shouldValidateRewards\": \"\",\n \"shouldAttachInvoice\": \"\",\n \"isSelfInvoice\": \"\",\n \"properties\": {\n \"key_0\": \"\"\n },\n \"rewards\": [\n {\n \"id\": \"\",\n \"uniqueId\": \"\",\n \"partnerId\": \"\",\n \"dealId\": \"\",\n \"status\": \"Pending\",\n \"creationDate\": \"\",\n \"amount\": {\n \"value\": \"\",\n \"currency\": \"\"\n },\n \"payoutId\": \"\",\n \"comment\": \"\",\n \"rewardType\": \"Credit\",\n \"properties\": {\n \"key_0\": \"\"\n }\n },\n {\n \"id\": \"\",\n \"uniqueId\": \"\",\n \"partnerId\": \"\",\n \"dealId\": \"\",\n \"status\": \"Paid\",\n \"creationDate\": \"\",\n \"amount\": {\n \"value\": \"\",\n \"currency\": \"\"\n },\n \"payoutId\": \"\",\n \"comment\": \"\",\n \"rewardType\": \"Unknown\",\n \"properties\": {\n \"key_0\": \"\",\n \"key_1\": \"\",\n \"key_2\": \"\"\n }\n }\n ]\n },\n {\n \"id\": \"\",\n \"partnerId\": \"\",\n \"partnerName\": \"\",\n \"name\": \"\",\n \"uniqueId\": \"\",\n \"currency\": \"\",\n \"rewardType\": \"Credit\",\n \"fromDate\": \"\",\n \"toDate\": \"\",\n \"amount\": {\n \"value\": \"\",\n \"currency\": \"\"\n },\n \"taxAmount\": {\n \"value\": \"\",\n \"currency\": \"\"\n },\n \"grossAmount\": {\n \"value\": \"\",\n \"currency\": \"\"\n },\n \"rewardCount\": \"\",\n \"creationDate\": \"\",\n \"paidDate\": \"\",\n \"acceptedDate\": \"\",\n \"validatedDate\": \"\",\n \"paidByUserId\": \"\",\n \"acceptedByUserId\": \"\",\n \"validatedByUserId\": \"\",\n \"invalidatedDate\": \"\",\n \"invalidatedByUserId\": \"\",\n \"status\": \"Ready\",\n \"source\": \"Automatic\",\n \"shouldValidateRewards\": \"\",\n \"shouldAttachInvoice\": \"\",\n \"isSelfInvoice\": \"\",\n \"properties\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"rewards\": [\n {\n \"id\": \"\",\n \"uniqueId\": \"\",\n \"partnerId\": \"\",\n \"dealId\": \"\",\n \"status\": \"Unknown\",\n \"creationDate\": \"\",\n \"amount\": {\n \"value\": \"\",\n \"currency\": \"\"\n },\n \"payoutId\": \"\",\n \"comment\": \"\",\n \"rewardType\": \"GiftCard\",\n \"properties\": {\n \"key_0\": \"\"\n }\n },\n {\n \"id\": \"\",\n \"uniqueId\": \"\",\n \"partnerId\": \"\",\n \"dealId\": \"\",\n \"status\": \"Unknown\",\n \"creationDate\": \"\",\n \"amount\": {\n \"value\": \"\",\n \"currency\": \"\"\n },\n \"payoutId\": \"\",\n \"comment\": \"\",\n \"rewardType\": \"GiftCard\",\n \"properties\": {\n \"key_0\": \"\"\n }\n }\n ]\n }\n ],\n \"paginationSkipCount\": \"\",\n \"totalCount\": \"\"\n}"},{"id":"e36fb336-7bc6-4e2c-99e4-0009a6b74018","name":"Partner program settings do not grant access to payouts","originalRequest":{"method":"GET","header":[],"url":{"raw":"//v3/payouts?partner_id=&from=&to=&offset=&limit=&sort_by=&order_by=","host":["/"],"path":["v3","payouts"],"query":[{"description":"The list of partner IDs to filter the payouts on.","key":"partner_id","value":""},{"description":"Filter payouts created after this date (Inclusive)","key":"from","value":""},{"description":"Filter payouts created before this date (Exclusive)","key":"to","value":""},{"description":"The cursor used in pagination. This is the index of the first payout to be returned.","key":"offset","value":""},{"description":"The maximum number of payouts to be returned. The default is 20.","key":"limit","value":""},{"description":"The property used to sort the payouts by. The default is CreationDate.","key":"sort_by","value":""},{"description":"The sorting direction for the returned payouts. Accepted values: ASC, DESC. The default is DESC.","key":"order_by","value":""}]}},"status":"Forbidden","code":403,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":null}],"_postman_id":"cb9907d0-2ec4-4fcd-9d11-929f0ad818e0"},{"name":"Get payout","id":"88caf05a-fc52-4241-b2ac-bf4a49d8347b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"//v3/payouts/:id","description":"

Retrieve an existing payout by id.

\n","urlObject":{"path":["v3","payouts",":id"],"host":["/"],"query":[],"variable":[{"id":"c2d9ef2c-c3ab-4c22-8eb2-a50eb202d424","description":{"content":"

(Required) The ID of the payout to return.

\n","type":"text/plain"},"type":"any","value":"","key":"id"}]}},"response":[{"id":"dfefc8ff-f5ad-4869-a017-1cfa51677baf","name":"Payout found","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"//v3/payouts/:id","host":["/"],"path":["v3","payouts",":id"],"variable":[{"key":"id","value":"","description":"(Required) The ID of the payout to return."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"\",\n \"partnerId\": \"\",\n \"partnerName\": \"\",\n \"name\": \"\",\n \"uniqueId\": \"\",\n \"currency\": \"\",\n \"rewardType\": \"Cash\",\n \"fromDate\": \"\",\n \"toDate\": \"\",\n \"amount\": {\n \"value\": \"\",\n \"currency\": \"\"\n },\n \"taxAmount\": {\n \"value\": \"\",\n \"currency\": \"\"\n },\n \"grossAmount\": {\n \"value\": \"\",\n \"currency\": \"\"\n },\n \"rewardCount\": \"\",\n \"creationDate\": \"\",\n \"paidDate\": \"\",\n \"acceptedDate\": \"\",\n \"validatedDate\": \"\",\n \"paidByUserId\": \"\",\n \"acceptedByUserId\": \"\",\n \"validatedByUserId\": \"\",\n \"invalidatedDate\": \"\",\n \"invalidatedByUserId\": \"\",\n \"status\": \"Paid\",\n \"source\": \"Manual\",\n \"shouldValidateRewards\": \"\",\n \"shouldAttachInvoice\": \"\",\n \"isSelfInvoice\": \"\",\n \"properties\": {\n \"key_0\": \"\",\n \"key_1\": \"\",\n \"key_2\": \"\"\n },\n \"rewards\": [\n {\n \"id\": \"\",\n \"uniqueId\": \"\",\n \"partnerId\": \"\",\n \"dealId\": \"\",\n \"status\": \"Paid\",\n \"creationDate\": \"\",\n \"amount\": {\n \"value\": \"\",\n \"currency\": \"\"\n },\n \"payoutId\": \"\",\n \"comment\": \"\",\n \"rewardType\": \"Coupon\",\n \"properties\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n },\n {\n \"id\": \"\",\n \"uniqueId\": \"\",\n \"partnerId\": \"\",\n \"dealId\": \"\",\n \"status\": \"Pending\",\n \"creationDate\": \"\",\n \"amount\": {\n \"value\": \"\",\n \"currency\": \"\"\n },\n \"payoutId\": \"\",\n \"comment\": \"\",\n \"rewardType\": \"Credit\",\n \"properties\": {\n \"key_0\": \"\"\n }\n }\n ]\n}"},{"id":"89079181-d2e9-4f6a-acb4-19e4a731abe9","name":"Partner program settings do not grant access to payouts","originalRequest":{"method":"GET","header":[],"url":{"raw":"//v3/payouts/:id","host":["/"],"path":["v3","payouts",":id"],"variable":[{"key":"id","value":"","description":"(Required) The ID of the payout to return."}]}},"status":"Forbidden","code":403,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":null},{"id":"22ec81bd-5535-42d7-b4e7-bb4b09442f88","name":"Payout not found","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"//v3/payouts/:id","host":["/"],"path":["v3","payouts",":id"],"variable":[{"key":"id","value":"","description":"(Required) The ID of the payout to return."}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"errorCode\": \"\",\n \"errorMessage\": \"\"\n}"}],"_postman_id":"88caf05a-fc52-4241-b2ac-bf4a49d8347b"}],"id":"11f67880-479d-4887-ae5f-1f247a5739a3","_postman_id":"11f67880-479d-4887-ae5f-1f247a5739a3","description":""},{"name":"Rewards","item":[{"name":"List rewards","id":"e0d03843-64a5-4b58-ba6b-418fafc244ab","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"//v3/rewards?offset=&limit=&sort_by=&order_by=&from=&to=&partner_id=","description":"

List rewards and filter them by partner and/or date range.

\n","urlObject":{"path":["v3","rewards"],"host":["/"],"query":[{"description":{"content":"

The cursor used in pagination. This is the index of the first transaction to be returned.

\n","type":"text/plain"},"key":"offset","value":""},{"description":{"content":"

The maximum number of transactions to be returned. The default is 20.

\n","type":"text/plain"},"key":"limit","value":""},{"description":{"content":"

The property used to sort the transactions by. The default is CreationDate.

\n","type":"text/plain"},"key":"sort_by","value":""},{"description":{"content":"

The sorting direction for the returned transactions. Accepted values: ASC, DESC. The default is DESC.

\n","type":"text/plain"},"key":"order_by","value":""},{"description":{"content":"

From date inclusive

\n","type":"text/plain"},"key":"from","value":""},{"description":{"content":"

To date exclusive

\n","type":"text/plain"},"key":"to","value":""},{"description":{"content":"

The partner ID

\n","type":"text/plain"},"key":"partner_id","value":""}],"variable":[]}},"response":[{"id":"e323b7cc-de8a-4b76-9b30-4e8028c6b06d","name":"Rewards returned","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"//v3/rewards?offset=&limit=&sort_by=&order_by=&from=&to=&partner_id=","host":["/"],"path":["v3","rewards"],"query":[{"description":"The cursor used in pagination. This is the index of the first transaction to be returned.","key":"offset","value":""},{"description":"The maximum number of transactions to be returned. The default is 20.","key":"limit","value":""},{"description":"The property used to sort the transactions by. The default is CreationDate.","key":"sort_by","value":""},{"description":"The sorting direction for the returned transactions. Accepted values: ASC, DESC. The default is DESC.","key":"order_by","value":""},{"description":"From date inclusive","key":"from","value":""},{"description":"To date exclusive","key":"to","value":""},{"description":"The partner ID","key":"partner_id","value":""}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"items\": [\n {\n \"id\": \"\",\n \"uniqueId\": \"\",\n \"partnerId\": \"\",\n \"dealId\": \"\",\n \"status\": \"Paid\",\n \"creationDate\": \"\",\n \"amount\": {\n \"value\": \"\",\n \"currency\": \"\"\n },\n \"payoutId\": \"\",\n \"comment\": \"\",\n \"rewardType\": \"Credit\",\n \"properties\": {\n \"key_0\": \"\"\n }\n },\n {\n \"id\": \"\",\n \"uniqueId\": \"\",\n \"partnerId\": \"\",\n \"dealId\": \"\",\n \"status\": \"Declined\",\n \"creationDate\": \"\",\n \"amount\": {\n \"value\": \"\",\n \"currency\": \"\"\n },\n \"payoutId\": \"\",\n \"comment\": \"\",\n \"rewardType\": \"Unknown\",\n \"properties\": {\n \"key_0\": \"\"\n }\n }\n ],\n \"paginationSkipCount\": \"\",\n \"totalCount\": \"\"\n}"},{"id":"3b825e21-7744-466e-9475-b5cafde0fc95","name":"Partner program settings do not grant access to rewards","originalRequest":{"method":"GET","header":[],"url":{"raw":"//v3/rewards?offset=&limit=&sort_by=&order_by=&from=&to=&partner_id=","host":["/"],"path":["v3","rewards"],"query":[{"description":"The cursor used in pagination. This is the index of the first transaction to be returned.","key":"offset","value":""},{"description":"The maximum number of transactions to be returned. The default is 20.","key":"limit","value":""},{"description":"The property used to sort the transactions by. The default is CreationDate.","key":"sort_by","value":""},{"description":"The sorting direction for the returned transactions. Accepted values: ASC, DESC. The default is DESC.","key":"order_by","value":""},{"description":"From date inclusive","key":"from","value":""},{"description":"To date exclusive","key":"to","value":""},{"description":"The partner ID","key":"partner_id","value":""}]}},"status":"Forbidden","code":403,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":null}],"_postman_id":"e0d03843-64a5-4b58-ba6b-418fafc244ab"}],"id":"ca547a65-33a1-463b-bf56-4c2ea63884c1","_postman_id":"ca547a65-33a1-463b-bf56-4c2ea63884c1","description":""},{"name":"Transactions","item":[{"name":"List transactions","id":"a790eedd-330d-429e-8115-8291569d4f8a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"//v3/transactions?partner_id=&partner_id=&customer_id=&customer_id=&deal_id=&deal_id=&offset=&limit=&sort_by=&order_by=","description":"

List transactions and filter them by partner, customer or any custom properties.

\n

To filter transactions on custom property, just add the property with its exact value as a query parameter:
myCustomProp=ThisIsAValue
This will return the transactions where myCustomProp exactly matches the provided value.

\n","urlObject":{"path":["v3","transactions"],"host":["/"],"query":[{"description":{"content":"

The list of partner IDs to filter the transactions on.

\n","type":"text/plain"},"key":"partner_id","value":""},{"description":{"content":"

The list of partner IDs to filter the transactions on.

\n","type":"text/plain"},"key":"partner_id","value":""},{"description":{"content":"

The list of customer IDs to filter the returned transactions on.

\n","type":"text/plain"},"key":"customer_id","value":""},{"description":{"content":"

The list of customer IDs to filter the returned transactions on.

\n","type":"text/plain"},"key":"customer_id","value":""},{"description":{"content":"

The list of deal IDs to filed the returned transactions on.

\n","type":"text/plain"},"key":"deal_id","value":""},{"description":{"content":"

The list of deal IDs to filed the returned transactions on.

\n","type":"text/plain"},"key":"deal_id","value":""},{"description":{"content":"

The cursor used in pagination. This is the index of the first transaction to be returned.

\n","type":"text/plain"},"key":"offset","value":""},{"description":{"content":"

The maximum number of transactions to be returned. The default is 20.

\n","type":"text/plain"},"key":"limit","value":""},{"description":{"content":"

The property used to sort the transactions by. The default is CreationDate.

\n","type":"text/plain"},"key":"sort_by","value":""},{"description":{"content":"

The sorting direction for the returned transactions. Accepted values: ASC, DESC. The default is DESC.

\n","type":"text/plain"},"key":"order_by","value":""}],"variable":[]}},"response":[{"id":"194229f4-997b-43eb-ae05-5d537ad90815","name":"Transactions returned","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"//v3/transactions?partner_id=&customer_id=&deal_id=&offset=&limit=&sort_by=&order_by=","host":["/"],"path":["v3","transactions"],"query":[{"description":"The list of partner IDs to filter the transactions on.","key":"partner_id","value":""},{"description":"The list of customer IDs to filter the returned transactions on.","key":"customer_id","value":""},{"description":"The list of deal IDs to filed the returned transactions on.","key":"deal_id","value":""},{"description":"The cursor used in pagination. This is the index of the first transaction to be returned.","key":"offset","value":""},{"description":"The maximum number of transactions to be returned. The default is 20.","key":"limit","value":""},{"description":"The property used to sort the transactions by. The default is CreationDate.","key":"sort_by","value":""},{"description":"The sorting direction for the returned transactions. Accepted values: ASC, DESC. The default is DESC.","key":"order_by","value":""}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"items\": [\n {\n \"id\": \"\",\n \"creationDate\": \"\",\n \"properties\": {\n \"key_0\": \"\"\n },\n \"customerId\": \"\",\n \"partnerId\": \"\",\n \"dealId\": \"\",\n \"currency\": \"\",\n \"isDeleted\": \"\",\n \"deletionDate\": \"\"\n },\n {\n \"id\": \"\",\n \"creationDate\": \"\",\n \"properties\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"customerId\": \"\",\n \"partnerId\": \"\",\n \"dealId\": \"\",\n \"currency\": \"\",\n \"isDeleted\": \"\",\n \"deletionDate\": \"\"\n }\n ]\n}"}],"_postman_id":"a790eedd-330d-429e-8115-8291569d4f8a"},{"name":"Get transaction","id":"fe3f48e2-aafd-450d-a64c-b46dac9e5f3b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"//v3/transactions/:id","description":"

Retrieve an existing transaction by id.

\n","urlObject":{"path":["v3","transactions",":id"],"host":["/"],"query":[],"variable":[{"id":"a404c7cb-fe01-47e1-bc63-a808ab1b0790","description":{"content":"

(Required) The ID of the transaction to return.

\n","type":"text/plain"},"type":"any","value":"","key":"id"}]}},"response":[{"id":"5bfd9f1d-42aa-497c-8199-86e482d8ad28","name":"Transaction found","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"//v3/transactions/:id","host":["/"],"path":["v3","transactions",":id"],"variable":[{"key":"id","value":"","description":"(Required) The ID of the transaction to return."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"\",\n \"creationDate\": \"\",\n \"properties\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"customerId\": \"\",\n \"partnerId\": \"\",\n \"dealId\": \"\",\n \"currency\": \"\",\n \"isDeleted\": \"\",\n \"deletionDate\": \"\"\n}"},{"id":"2f96a698-cf53-4f7f-b125-a70955cfcc3c","name":"Partner program settings do not grant access to transactions","originalRequest":{"method":"GET","header":[],"url":{"raw":"//v3/transactions/:id","host":["/"],"path":["v3","transactions",":id"],"variable":[{"key":"id","value":"","description":"(Required) The ID of the transaction to return."}]}},"status":"Forbidden","code":403,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":null},{"id":"5583402d-af32-4717-b4ff-290bbd4b2947","name":"Transaction not found","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"//v3/transactions/:id","host":["/"],"path":["v3","transactions",":id"],"variable":[{"key":"id","value":"","description":"(Required) The ID of the transaction to return."}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"errorCode\": \"\",\n \"errorMessage\": \"\"\n}"}],"_postman_id":"fe3f48e2-aafd-450d-a64c-b46dac9e5f3b"}],"id":"9722e09f-4416-4867-8c03-023bedbc8beb","_postman_id":"9722e09f-4416-4867-8c03-023bedbc8beb","description":""}],"id":"61261ffb-b28a-46ca-8d6d-c700e161cea5","_postman_id":"61261ffb-b28a-46ca-8d6d-c700e161cea5","description":""}],"id":"12d62d26-a889-4de3-9e2e-d2f555235065","_postman_id":"12d62d26-a889-4de3-9e2e-d2f555235065","description":""}],"variable":[{"key":"baseUrl","value":"/"}]}