Cofactr Platform API
  1. Auth
Cofactr Platform API
  • BOMs
    • Gets Boms that user has read access to
      GET
    • Creates a Bom using Cofactr Data
      POST
    • Creates a Bom using raw bomline data and performs searches to convert into Cofactr Data
      POST
    • Gets a Bom
      GET
    • Upsert BOM Async
      PUT
    • Updates a Bom
      PATCH
    • Deletes a Bom if still unapproved. Archives a bom if approved.
      DELETE
    • Approves an unapproved Bom.
      POST
    • Gets Bom Lines on a Bom.
      GET
    • Creates a new bomline on a Bom using Cofactr data. If a bomline with the provided part exists it will sum the quants instead of duplicating lines.
      POST
    • Gets a BomLine
      GET
    • Updates a BomLine
      PATCH
    • Removes a Bomline from a Bom.
      DELETE
    • Attempts to create a new Bomline using raw data and performs searches to convert into Cofactr Data. If a Bomline with the same part and refdes exists it will sum the quants instead of duplicating lines.
      POST
  • Programs
    • Gets Programs
      GET
    • Creates a Program
      POST
    • Gets a Program
      GET
    • Updates a Program
      PATCH
    • Deletes a Program
      DELETE
    • Gets Program Availabilities
      GET
    • Gets Program Availabilities Async
      GET
    • Gets Program Reference Pricing
      GET
    • Get Programs Lines
      GET
    • Get Programs Line
      GET
    • Update Programs Line
      PATCH
    • Delete Programs Line
      DELETE
    • Create Programs Lines
      POST
    • Get Program Part Overrides
      GET
    • Create Program Part Overrides
      POST
    • Get Program Part Override
      GET
    • Update Program Part Override
      PATCH
    • Delete Program Part Override
      DELETE
  • Account
    • Sub Org
      • List Sub Orgs
      • Get Sub Org
      • Update Sub Org
      • Create Sub Org
    • Get Org
    • Get Users
    • Get User
  • Reporting
    • Customer SQL Query
  • Email
    • Mark Outbound Email as Sent
    • Create Outbound Email
    • Get Outbound Email
  • Auth
    • Update API Key
      PATCH
  • Async Jobs
    • Get Async Job Status
  • Stock Documents
    • List StockDocuments
    • Get StockDocument
    • Download StockDocument
    • Create StockDocument
  • Suppliers
    • Create Supplier
    • Update Supplier
    • Get Supplier
    • Get Suppliers
  • Parts
    • Async Create Parts
    • Async Upsert Parts
    • Get Part
  • Purchases
    • Get Purchase Order
    • Create Purchase Order
    • Update Purchase Order
    • Delete Purchase Order
    • Get Purchase Lines
    • Get Purchase Line
    • Create Purchase Line
    • Update Many Purchase Lines
    • Delete Purchase Line
    • Get NoPart Purchase Lines
    • Create NoPart Purchase Line
    • Update Many NoPart Purchase Lines
    • Delete NoPart Purchase Line
    • Create Purchase Event
    • Update Supplier Bill
    • Update Supplier Bill Line
    • Create Supplier Bill
    • Create Supplier Bill Line
  • Teams
    • Get Teams
    • Create Team
    • Get Team
    • Update Team
    • Delete Team
    • Archive Team
    • Unarchive Team
    • Get Team Types
    • Create Team Type
    • Get Team Type
    • Update Team Type
    • Delete Team Type
  • Custom Properties
    • Get Custom Properties
    • Create Custom Property
    • Update Custom Property
    • Get Custom Property
  • Stock Lots
    • Updates a StockLot
    • Upsert Part Stock
  • Tags
    • Get tags
    • Create tag
    • Get tag
    • Update tag
  • Rfqs
    • Create Rfq
    • Update Rfq
  • RfqLines
    • Create RfqLine
    • Update RfqLine
  • SupplierQuote
    • Create Supplier Quote
    • Update Supplier Quote
  • SupplierQuoteLines
    • Create Supplier Quote Line
    • Update Supplier Quote Line
  1. Auth

Update API Key

PATCH
/integrations/api_keys/
Auth
Update the stored API key object using the given request body.

Request

Authorization
Add parameter in header
Authorization
Example:
Authorization: ********************
Body Params application/json
name
string 
optional
The name of the API key.
<= 255 characters
integration_id
string 
optional
The ID of the integration associated with the API key.
<= 255 characters
integration_instance_id
string 
optional
The instance ID of the integration associated with the API key.
<= 255 characters
Example
{
  "name": "string",
  "integration_id": "string",
  "integration_instance_id": "string"
}

Request samples

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request PATCH '/integrations/api_keys/' \
--header 'Content-Type: application/json' \
--header 'Authorization;' \
--data-raw '{
    "name": "string",
    "integration_id": "string",
    "integration_instance_id": "string"
}'

Responses

🟢200Success
application/json
Body
id
string 
required
The unique identifier of the API key.
name
string 
required
The name of the API key.
prefix
string 
required
The prefix of the API key.
created
string <date-time>
required
The creation date of the API key.
expiry_date
string <date-time>
required
The expiry date of the API key.
has_expired
boolean 
required
Indicates whether the API key has expired.
revoked
boolean 
required
Indicates whether the API key has been revoked.
key_type
string 
required
The type of the API key.
created_by
string 
required
The user who created the API key.
integration_id
string 
required
The ID of the integration associated with the API key.
integration_instance_id
string 
required
The instance ID of the integration associated with the API key.
Example
{
  "id": "string",
  "name": "string",
  "prefix": "string",
  "created": "2019-08-24T14:15:22Z",
  "expiry_date": "2019-08-24T14:15:22Z",
  "has_expired": true,
  "revoked": true,
  "key_type": "string",
  "created_by": "string",
  "integration_id": "string",
  "integration_instance_id": "string"
}
Modified at 2024-08-23 00:21:33
Previous
Get Outbound Email
Next
Get Async Job Status
Built with