Companies

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

patch

Retries companies wallet creation

Authorizations

x-w3block-api-keyx-w3block-idx-w3block-secretbearer

x-w3block-api-keystringRequired

W3block API key

Path parameters

companyIdstringRequired

Responses

200Success

No content

401

Need user with one of these roles: superAdmin, admin

patch

/companies/{companyId}/setup

HTTPcURLJavaScriptPython

PATCH /companies/{companyId}/setup HTTP/1.1
Host: 
x-w3block-api-key: YOUR_API_KEY
Accept: */*

No content

Get company details

get

Get company by company id

Authorizations

x-w3block-api-keyx-w3block-idx-w3block-secretbearer

x-w3block-api-keystringRequired

W3block API key

Path parameters

companyIdstringRequired

Responses

200Success

application/json

401

Need user with one of these roles: superAdmin, admin

get

/companies/{companyId}

HTTPcURLJavaScriptPython

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-12-15T19:46:53.189Z",
  "createdAt": "2025-12-15T19:46:53.189Z",
  "updatedAt": "2025-12-15T19:46:53.189Z"
}

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

get

Get email templates by company id

Authorizations

x-w3block-api-keyx-w3block-idx-w3block-secretbearer

x-w3block-api-keystringRequired

W3block API key

Path parameters

companyIdstringRequired

Responses

401

Need user with one of these roles: superAdmin, admin

get

/companies/{companyId}/emails

HTTPcURLJavaScriptPython

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 a new email custumization

post

Creates a new email template for a company

Authorizations

x-w3block-api-keyx-w3block-idx-w3block-secretbearer

x-w3block-api-keystringRequired

W3block API key

Path parameters

companyIdstringRequired

Body

application/json

triggerstring · enumRequiredPossible values:

subjectstringRequired

greetingTextobjectOptional

templatestringRequired

Responses

401

Need user with one of these roles: superAdmin, admin

post

/companies/{companyId}/emails

HTTPcURLJavaScriptPython

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