Cofactr Platform API
  1. Teams
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
  • 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
      GET
    • Create Team
      POST
    • Get Team
      GET
    • Update Team
      PATCH
    • Delete Team
      DELETE
    • Archive Team
      POST
    • Unarchive Team
      POST
    • Get Team Types
      GET
    • Create Team Type
      POST
    • Get Team Type
      GET
    • Update Team Type
      PATCH
    • Delete Team Type
      DELETE
  • 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. Teams

Create Team

Developing
POST
/v1/teams/
Creates a new Team

Request

Authorization
Add parameter in header
Authorization
Example:
Authorization: ********************
Body Params application/json
synced_from_integration
boolean 
Synced from integration
optional
integration_source_name
string 
Integration source name
optional
integration_record_id
string 
Integration record id
optional
synced_from_integration_at
string <date-time>
Synced from integration at
optional
name
string 
Name
required
>= 1 characters<= 255 characters
team_type
string <uuid>
Team type
required
Example
{
  "synced_from_integration": true,
  "integration_source_name": "string",
  "integration_record_id": "string",
  "synced_from_integration_at": "2019-08-24T14:15:22Z",
  "name": "string",
  "team_type": "2d7c39ca-4caf-4164-b565-82a0bee8dc34"
}

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 POST '/v1/teams/' \
--header 'Content-Type: application/json' \
--header 'Authorization;' \
--data-raw '{
    "synced_from_integration": true,
    "integration_source_name": "string",
    "integration_record_id": "string",
    "synced_from_integration_at": "2019-08-24T14:15:22Z",
    "name": "string",
    "team_type": "2d7c39ca-4caf-4164-b565-82a0bee8dc34"
}'

Responses

🟢200Success
application/json
Body
id
string <uuid>
Id
read-onlyrequired
name
string 
Name
required
>= 1 characters<= 255 characters
org
object (OrgLite) 
required
id
string <uuid>
Id
read-onlyoptional
name
string 
Name
required
>= 1 characters<= 255 characters
slug
string 
Slug
required
>= 1 characters<= 255 characters
image
string 
Image
read-onlyoptional
website
string <uri>
Website
optional
<= 200 characters
timezone
string 
Timezone
read-onlyoptional
price_model
string <uuid>
Price model
required
msl_reset_on_receipt
boolean 
Msl reset on receipt
optional
lcr_inspection_on_receipt
boolean 
Lcr inspection on receipt
optional
dimensional_inspection_on_receipt
boolean 
Dimensional inspection on receipt
optional
inspection_photo_on_receipt
boolean 
Inspection photo on receipt
optional
package_photo_on_receipt
boolean 
Package photo on receipt
optional
created_from
string <uuid>
Created from
optional
sandbox
boolean 
Sandbox
optional
available_purchase_amount
string <decimal>
Available purchase amount
optional
Used to store the maximum purchase amount that can be automatically approved for this org. 0 will disable auto-approval of purchase lines.
order_approval_threshold
string <decimal>
Order approval threshold
optional
Used to store a threshold amount that will trigger a need for an order approval request.
order_approval_threshold_direction
enum<string> 
Order approval threshold direction
optional
Used to store the direction of the threshold amount that will trigger a need for an order approval request.
Allowed values:
updown
po_footer_notes
string 
Po footer notes
optional
bom_missing_custom_id_warning
enum<string> 
Bom missing custom id warning
optional
Allowed values:
allowedwarningerror
bom_upload_custom_id
enum<string> 
Bom upload custom id
optional
Allowed values:
noneprimarydifferent_punctuationalts
bom_clear_custom_id_on_alt_unapprove
boolean 
Bom clear custom id on alt unapprove
optional
bom_add_custom_id_on_alt_approve
boolean 
Bom add custom id on alt approve
optional
bom_transfer_custom_id_on_edit
boolean 
Bom transfer custom id on edit
optional
logging_enabled
boolean 
Logging enabled
optional
billed_with_parent
boolean 
Billed with parent
optional
Determines if the org is billed with its parent org. Used by Metronome billing integration.
industry
string 
Industry
optional
Indicates the industry that this customer operates in. For use in end-user authorizations.
military_use
boolean 
Military use
optional
Indicates that this customer's end use is a military application. For use in end-user authorizations.
onboarding_required
boolean 
Onboarding required
optional
Indicates that this customer requires onboarding before their account can be accessed by non-Cofactr users.
trial_ends_on
string <date>
Trial ends on
optional
Indicates the last date of the trial period for this customer's Metronome plan.
plan_expires_on
string <date>
Plan expires on
optional
Indicates the last date of the assigned Metronome plan for this customer's plan.
dpas
string 
Dpas
optional
DPAS code for purchased made for this customer. For use in end-user authorizations.
ups_account_number
string 
Ups account number
optional
<= 25 characters
ups_account_country
string 
Ups account country
read-onlyoptional
ups_account_postal_code
string 
Ups account postal code
optional
<= 25 characters
fedex_account_number
string 
Fedex account number
optional
<= 25 characters
fedex_account_country
string 
Fedex account country
read-onlyoptional
fedex_account_postal_code
string 
Fedex account postal code
optional
<= 25 characters
billing_email
string <email>
Billing email
optional
Used to store the email address to send invoices to.
<= 254 characters
billing_address_line_1
string 
Billing address line 1
optional
<= 255 characters
billing_address_line_2
string 
Billing address line 2
optional
<= 255 characters
billing_address_city
string 
Billing address city
optional
<= 255 characters
billing_address_state
string 
Billing address state
optional
<= 255 characters
billing_address_country
string 
Billing address country
read-onlyoptional
billing_address_postal_code
string 
Billing address postal code
optional
<= 25 characters
billing_address_name
string 
Billing address name
optional
<= 255 characters
team_type
object (TeamType) 
required
id
string <uuid>
Id
read-onlyoptional
name
string 
Name
required
>= 1 characters<= 255 characters
plural_name
string 
Plural name
required
>= 1 characters<= 255 characters
org
string <uuid>
Org
required
external_metadata
object 
External metadata
required
internal_metadata
object 
Internal metadata
required
related_records
array[object (RelatedRecord) {4}] 
read-onlyrequired
name
string 
Name
required
>= 1 characters
record_type
string 
Record type
required
>= 1 characters
record_id
string <uuid>
Record id
required
org_id
string <uuid>
Org id
required
archived
string 
Archived
read-onlyrequired
synced_from_integration
boolean 
Synced from integration
read-onlyrequired
synced_from_integration_at
string <date-time>
Synced from integration at
read-onlyrequired
integration_source_name
string 
Integration source name
read-onlyrequired
>= 1 characters
integration_record_id
string 
Integration record id
read-onlyrequired
>= 1 characters
Example
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "name": "string",
  "org": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "name": "string",
    "slug": "string",
    "image": "string",
    "website": "http://example.com",
    "timezone": "string",
    "price_model": "ef362370-6cb3-458c-ac97-9accb6c62257",
    "msl_reset_on_receipt": true,
    "lcr_inspection_on_receipt": true,
    "dimensional_inspection_on_receipt": true,
    "inspection_photo_on_receipt": true,
    "package_photo_on_receipt": true,
    "created_from": "11c45396-e67e-4827-86cd-a07bcded47bc",
    "sandbox": true,
    "available_purchase_amount": "string",
    "order_approval_threshold": "string",
    "order_approval_threshold_direction": "up",
    "po_footer_notes": "string",
    "bom_missing_custom_id_warning": "allowed",
    "bom_upload_custom_id": "none",
    "bom_clear_custom_id_on_alt_unapprove": true,
    "bom_add_custom_id_on_alt_approve": true,
    "bom_transfer_custom_id_on_edit": true,
    "logging_enabled": true,
    "billed_with_parent": true,
    "industry": "string",
    "military_use": true,
    "onboarding_required": true,
    "trial_ends_on": "2019-08-24",
    "plan_expires_on": "2019-08-24",
    "dpas": "string",
    "ups_account_number": "string",
    "ups_account_country": "string",
    "ups_account_postal_code": "string",
    "fedex_account_number": "string",
    "fedex_account_country": "string",
    "fedex_account_postal_code": "string",
    "billing_email": "user@example.com",
    "billing_address_line_1": "string",
    "billing_address_line_2": "string",
    "billing_address_city": "string",
    "billing_address_state": "string",
    "billing_address_country": "string",
    "billing_address_postal_code": "string",
    "billing_address_name": "string"
  },
  "team_type": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "name": "string",
    "plural_name": "string",
    "org": "3b4eb1f5-aaca-43c1-9ccf-5bbd44308aba"
  },
  "external_metadata": {},
  "internal_metadata": {},
  "related_records": [
    {
      "name": "string",
      "record_type": "string",
      "record_id": "8bf519b6-a3e0-49d2-8e42-039542d9a489",
      "org_id": "a40f5d1f-d889-42e9-94ea-b9b33585fc6b"
    }
  ],
  "archived": "string",
  "synced_from_integration": true,
  "synced_from_integration_at": "2019-08-24T14:15:22Z",
  "integration_source_name": "string",
  "integration_record_id": "string"
}
Modified at 2024-08-23 10:43:46
Previous
Get Teams
Next
Get Team
Built with