External Contacts

External Contacts are wallets with no user inside the system

If you have a wallet that you want to be used in the system to receive royalties for example, but they do not have any user you can simply register their wallet as an External Contact.

Create a External contact

post

Create a new external contact

Authorizations

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

Path parameters

companyIdstringRequired

Body

namestringRequired

emailstringOptional

phonestringOptional

walletAddressstringRequired

royaltyEligiblebooleanRequired

Responses

application/json

objectOptional

post

HTTPcURLJavaScriptPython

POST /{companyId}/external-contacts/import HTTP/1.1
Host: 
x-w3block-api-key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 91

{
  "name": "text",
  "email": "text",
  "phone": "text",
  "walletAddress": "text",
  "royaltyEligible": true
}

{
  "id": "text",
  "companyId": "text",
  "active": true,
  "name": "text",
  "userId": "text",
  "walletAddress": "text",
  "email": "text",
  "description": "text",
  "method": "import",
  "address": "text",
  "phone": "text",
  "deletedAt": "2025-04-19T02:24:55.073Z",
  "createdAt": "2025-04-19T02:24:55.073Z",
  "updatedAt": "2025-04-19T02:24:55.073Z"
}

List External Contacts for your company

get

List external contacts by company id

Authorizations

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

Path parameters

companyIdstringRequired

Query parameters

pagenumberOptionalDefault: 1

limitnumberOptionalDefault: 10

searchstringOptional

sortBystringOptional

orderBystring · enumOptionalDefault: DESCAvailable options:

idstring[]Optional

userIdsstring[]Optional

minDatestringOptionalExample: 2022-02-15T10:30:05-03:00

maxDatestringOptionalExample: 2022-02-15T10:30:05-03:00

Responses

application/json

objectOptional

get

HTTPcURLJavaScriptPython

GET /{companyId}/external-contacts HTTP/1.1
Host: 
x-w3block-api-key: YOUR_API_KEY
Accept: */*

{
  "meta": {
    "itemCount": 1,
    "totalItems": 1,
    "itemsPerPage": 1,
    "totalPages": 1,
    "currentPage": 1
  },
  "links": {
    "first": "http://example.com?page=1",
    "prev": "http://example.com?page=1",
    "next": "http://example.com?page=2",
    "last": "http://example.com?page=3"
  },
  "items": [
    {
      "id": "text",
      "companyId": "text",
      "active": true,
      "name": "text",
      "userId": "text",
      "walletAddress": "text",
      "email": "text",
      "description": "text",
      "method": "import",
      "address": "text",
      "phone": "text",
      "deletedAt": "2025-04-19T02:24:55.073Z",
      "createdAt": "2025-04-19T02:24:55.073Z",
      "updatedAt": "2025-04-19T02:24:55.073Z"
    }
  ]
}

Get a External Contact

get

Get a external contact by id

Authorizations

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

Path parameters

companyIdstringRequired

idstringRequired

Responses

application/json

objectOptional

get

HTTPcURLJavaScriptPython

GET /{companyId}/external-contacts/{id} HTTP/1.1
Host: 
x-w3block-api-key: YOUR_API_KEY
Accept: */*

{
  "id": "text",
  "companyId": "text",
  "active": true,
  "name": "text",
  "userId": "text",
  "walletAddress": "text",
  "email": "text",
  "description": "text",
  "method": "import",
  "address": "text",
  "phone": "text",
  "deletedAt": "2025-04-19T02:24:55.073Z",
  "createdAt": "2025-04-19T02:24:55.073Z",
  "updatedAt": "2025-04-19T02:24:55.073Z"
}

Edit a External Contact

patch

Update a external contact by id

Authorizations

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

Path parameters

companyIdstringRequired

idstringRequired

Body

namestringOptional

emailstringOptional

phonestringOptional

walletAddressstringOptional

Responses

application/json

objectOptional

patch

HTTPcURLJavaScriptPython

PATCH /{companyId}/external-contacts/{id} HTTP/1.1
Host: 
x-w3block-api-key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 68

{
  "name": "text",
  "email": "text",
  "phone": "text",
  "walletAddress": "text"
}

{
  "id": "text",
  "companyId": "text",
  "active": true,
  "name": "text",
  "userId": "text",
  "walletAddress": "text",
  "email": "text",
  "description": "text",
  "method": "import",
  "address": "text",
  "phone": "text",
  "deletedAt": "2025-04-19T02:24:55.073Z",
  "createdAt": "2025-04-19T02:24:55.073Z",
  "updatedAt": "2025-04-19T02:24:55.073Z"
}