Cofactr Platform API
  1. Email
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
      POST
    • Create Outbound Email
      POST
    • Get Outbound Email
      GET
  • 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
    • 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. Email

Create Outbound Email

Developing
POST
v1/outbound_emails/

Request

Authorization
Add parameter in header
Authorization
Example:
Authorization: ********************
Body Params application/json
to_emails
array[string <email>]
required
cc_emails
array[string <email>]
optional
bcc_emails
array[string <email>]
optional
subject
string 
required
body
string 
required
attachments
array[string <stock_document_id>]
optional
Example
{
  "to_emails": [
    "user@example.com"
  ],
  "cc_emails": [
    "user@example.com"
  ],
  "bcc_emails": [
    "user@example.com"
  ],
  "subject": "string",
  "body": "string",
  "attachments": [
    "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 POST 'v1/outbound_emails/' \
--header 'Content-Type: application/json' \
--header 'Authorization;' \
--data-raw '{
    "to_emails": [
        "user@example.com"
    ],
    "cc_emails": [
        "user@example.com"
    ],
    "bcc_emails": [
        "user@example.com"
    ],
    "subject": "string",
    "body": "string",
    "attachments": [
        "string"
    ]
}'

Responses

🟢200Success
application/json
Body
id
string <uuid>
required
to_emails
string 
required
cc_emails
string 
required
bcc_emails
string 
required
subject
string 
required
body
string 
required
attachments
array[string <uuid>]
required
queued_at
string <date-time> | null 
required
sent_at
string <date-time> | null 
required
Example
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "to_emails": "string",
  "cc_emails": "string",
  "bcc_emails": "string",
  "subject": "string",
  "body": "string",
  "attachments": [
    "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  ],
  "queued_at": "2019-08-24T14:15:22Z",
  "sent_at": "2019-08-24T14:15:22Z"
}
Modified at 2024-08-22 19:01:25
Previous
Mark Outbound Email as Sent
Next
Get Outbound Email
Built with