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
Retries companies wallet creation
PATCH /companies/{companyId}/setup HTTP/1.1
Host:
x-w3block-api-key: YOUR_API_KEY
Accept: */*
No content
Get company details
Get company by company id
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-07-15T20:25:12.579Z",
"createdAt": "2025-07-15T20:25:12.579Z",
"updatedAt": "2025-07-15T20:25:12.579Z"
}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 email templates by company id
GET /companies/{companyId}/emails HTTP/1.1
Host:
x-w3block-api-key: YOUR_API_KEY
Accept: */*
Need user with one of these roles: superAdmin, admin
No content
Post a new email custumization
Creates a new email template for a company
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"
}Need user with one of these roles: superAdmin, admin
No content
Last updated