API Reference (1.0)

Copy

• Copy for LLM

  Copy page as Markdown for LLMs
• View as Markdown

  Open this page as Markdown
• Open in ChatGPT

  Get insights from ChatGPT
• Open in Claude

  Get insights from Claude

curl -i -X PUT \
  https://bp-api-docs-v3.redocly.app/_mock/demogm_08_01_2025_schema/rest/2.0/PRODUCT \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json; charset=utf-8' \
  -H 'sessionId: string' \
  -d '{
    "brmObjects": {
      "Id": "string",
      "Status": "string",
      "Created": "string",
      "Updated": "string",
      "Name": "string",
      "CreatedUserId": "string",
      "OverridePermissions": "string",
      "CustomizeTaxRules": 0,
      "RatingMethodId": "string",
      "ContractRequiredFlag": 0,
      "DefaultRateFlag": 0,
      "Rate": "string",
      "ExternalKey": "string",
      "OrderOfExecution": "string",
      "UseFormulaSSP": 0,
      "RestrictUseOfUnreferencedContracts": 0,
      "SfRecordId": "string",
      "SfSyncBatchId": "string",
      "SfStatusError": "string",
      "SfLastSync": "string",
      "Ranking": "string",
      "UpdatedUserId": "string",
      "SSPFormula": "string"
    }
  }'

curl -i -X PATCH \
  https://bp-api-docs-v3.redocly.app/_mock/demogm_08_01_2025_schema/rest/2.0/PRODUCT \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json; charset=utf-8' \
  -H 'sessionId: string' \
  -d '{
    "brmObjects": {
      "Id": "string",
      "Status": "string",
      "Created": "string",
      "Updated": "string",
      "Name": "string",
      "CreatedUserId": "string",
      "OverridePermissions": "string",
      "CustomizeTaxRules": 0,
      "RatingMethodId": "string",
      "ContractRequiredFlag": 0,
      "DefaultRateFlag": 0,
      "Rate": "string",
      "ExternalKey": "string",
      "OrderOfExecution": "string",
      "UseFormulaSSP": 0,
      "RestrictUseOfUnreferencedContracts": 0,
      "SfRecordId": "string",
      "SfSyncBatchId": "string",
      "SfStatusError": "string",
      "SfLastSync": "string",
      "Ranking": "string",
      "UpdatedUserId": "string",
      "SSPFormula": "string"
    },
    "externalIDFieldName": "Name"
  }'

curl -i -X DELETE \
  https://bp-api-docs-v3.redocly.app/_mock/demogm_08_01_2025_schema/rest/2.0/delete/PRODUCT \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json; charset=utf-8' \
  -H 'sessionId: string' \
  -d '{
    "brmObjects": {
      "Id": "string"
    }
  }'