How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Valimail Users API

The Users API from Valimail — 4 operation(s) for users.

Valimail Users API is one of 17 APIs that Valimail publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include User. The published artifact set on APIs.io includes an OpenAPI specification and an API reference.

This API exposes 6 operations across 4 paths, and defines 9 schemas. It is described by OpenAPI 3.0.0, at version 1.0.0.

Requests are made against 3 base URLs: https://api.valimail.com, https://api.valimail-staging.com, http://localhost:7001.

6 operations 4 paths 9 schemas 1 DELETE2 GET2 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.0
API Version
1.0.0
Base URL
https://api.valimail.com
Authentication
HTTP Bearer
Resource Areas
1

Authentication & Security 1

Valimail Users API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (JWT) (bearerAuth). By default, every request must be authenticated.

Paths & Operations 6

Across 4 paths, the API surfaces 6 operations — 1 DELETE, 2 GET, 2 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

Users 6
GET
/accounts/{slug}/users
Returns users linked to the account slug provided.
11 params → 200400401403422429500
POST
/accounts/{slug}/users
Creates a new user linked to the account slug provided and sends an invitation email.
1 param body → 200400401403422429500
POST
/accounts/{slug}/users/{user-slug}/invitation
Sends a new invitation email for the existing user and returns the latest activation link.
2 params → 200400401403404422429500
GET
/accounts/{slug}/users/{user-slug}
Returns account user data by account slug and user slug.
2 params → 200400401403404422429500
PUT
/accounts/{slug}/users/{user-slug}
Updates user data by account slug and user slug.
2 params body → 200400401403404422429500
DELETE
/accounts/{slug}/v2/users/{user-slug}
Inactivates a user according to the account slug and user slug provided.
2 params → 200400401403422429500

Schemas 9

The contract defines 9 schemas that model the data the API accepts and returns. The most detailed are User (8 properties), ErrorResponse (5 properties), UserUpdate (4 properties), DefaultDelegatedAPIErrorResponse (4 properties). Each schema is shown below with its type and property counts.

DefaultDelegatedAPIErrorResponse
object
4 properties
ValidationResponse
object
2 properties
ErrorResponse
object
5 properties
InvitedUser
CreateUser
object
4 properties
User
object
8 properties
UserUpdate
object
4 properties
UserDelete
object
2 properties
ValidationDetail
object
3 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

valimail-users-api-openapi.yml Raw ↑

Other APIs Valimail publishes across the network.

Valimail Reporting Data API
Valimail Accounts API
Valimail Authentication API
Valimail DKIMs by Domain API
Valimail DKIMs by Sender API
Valimail Domains API
Valimail MTA-STS Policy API
Valimail MTA-STS Policy Reports API
Valimail Netblocks API
Valimail Portfolios API
Valimail SCIM API
Valimail Senders API
Where this information came from

This is an independent, third-party profile of Valimail Users API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.