W3Block Docs
  • 🚀Start here
    • Welcome to the Docs
    • Integrated Blockchains
  • 👨‍💻Dev Docs
    • API
      • Getting Started
      • Authentication
      • Commerce API services
        • Company Administration
          • Companies (Admin)
          • Assets (Admin)
          • Tags (Admin)
          • Products (Admin)
            • Order Rules (Admin)
          • Orders (Admin)
          • Faq (Admin)
          • Webhooks (Admin)
        • Products
        • Orders
        • Webhooks
        • Faq
        • Globals
      • Key API Services
        • Authentication
        • Companies
        • Tokens
          • Contracts
            • External Contacts
            • Royalty Eligible
          • Categories
            • Subcategories
          • Token Collections
            • Token Editions
          • Metadata
        • Blockchain
        • Cloudinary
        • Integration
          • Ecommerce
            • Associate Tokens
            • Hooks
        • Users
        • Vouchers
  • 📘Knowledge Base
    • First Steps
    • FAQ
    • Glossary
Powered by GitBook
On this page
  • Retry company wallet creation
  • PATCH/companies/{companyId}/setup
  • Get company details
  • GET/companies/{companyId}
  • Emails
  • Get company's emails
  • GET/companies/{companyId}/emails
  • Post a new email custumization
  • POST/companies/{companyId}/emails
  1. Dev Docs
  2. API
  3. Key API Services

Companies

PreviousAuthenticationNextTokens

Last updated 2 years ago

When you use our API you will most likely be assigned a companyId. This companyId will be necessary for most operations in the API as anything you read or create will be inside the scope of your company.

Retry company wallet creation

Get company details

Emails

As a company you can create personalized emails for certain actions, there are 3 kinds of emails that are sent from this application and they can all be customized, they are:

  • successTransferEmail

  • completeAccountEmail

  • ecommerceProcessingOrderEmail

Another thing that also appears on your email is your company logo, this must be set up using the ID Application

Get company's emails

Post a new email custumization

👨‍💻
patch

Retries companies wallet creation

Authorizations
Path parameters
companyIdstringRequired
Responses
patch
PATCH /companies/{companyId}/setup HTTP/1.1
Host: 
x-w3block-api-key: YOUR_API_KEY
Accept: */*

No content
get

Get company by company id

Authorizations
Path parameters
companyIdstringRequired
Responses
application/json
objectOptional
get
GET /companies/{companyId} HTTP/1.1
Host: 
x-w3block-api-key: YOUR_API_KEY
Accept: */*

{
  "id": "text",
  "defaultOwnerAddress": "text",
  "transferConfig": {
    "transferDelay": 1
  },
  "gasRetry": 1,
  "platformRoyalty": {
    "name": "W3block",
    "share": 2,
    "payee": "0x0a8a5a4624f4937a540302e385ba66550242369c"
  },
  "customEmailsTemplates": {},
  "deletedAt": "2025-04-19T02:24:55.073Z",
  "createdAt": "2025-04-19T02:24:55.073Z",
  "updatedAt": "2025-04-19T02:24:55.073Z"
}
get

Get email templates by company id

Authorizations
Path parameters
companyIdstringRequired
Responses
get
GET /companies/{companyId}/emails HTTP/1.1
Host: 
x-w3block-api-key: YOUR_API_KEY
Accept: */*
401

Need user with one of these roles: superAdmin, admin

No content
post

Creates a new email template for a company

Authorizations
Path parameters
companyIdstringRequired
Body
triggerstring · enumRequiredAvailable options:
subjectstringRequired
greetingTextobjectOptional
templatestringRequired
Responses
post
POST /companies/{companyId}/emails HTTP/1.1
Host: 
x-w3block-api-key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 87

{
  "trigger": "successTransferEmail",
  "subject": "text",
  "greetingText": {},
  "template": "text"
}
401

Need user with one of these roles: superAdmin, admin

No content