Skip to main content
POST
/
v1
/
members
cURL
curl --request POST \
  --url https://api.nomod.com/v1/members \
  --header 'Content-Type: application/json' \
  --header 'X-API-KEY: <api-key>' \
  --data '
{
  "first_name": "<string>",
  "last_name": "<string>",
  "email": "jsmith@example.com",
  "job_title": "<string>",
  "role": "admin"
}
'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "role": "<string>",
  "job_title": "<string>",
  "user": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "first_name": "<string>",
    "last_name": "<string>"
  },
  "status": "invited",
  "volume": "<string>",
  "volume_currency": "<string>"
}

Documentation Index

Fetch the complete documentation index at: https://nomod-26.mintlify.app/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
X-API-KEY
string
header
required

Your API key. This is required by all endpoints to access our API programatically. You can view your API Key by navigating to the app settings

Body

application/json
​
first_name
string
required

First Name

Required string length: 2 - 50
​
last_name
string
required

Last Name

Required string length: 2 - 50
​
email
string<email>
required

Email Address

​
job_title
string
required

Job Title

Maximum string length: 50
​
role
enum<string>
required

Role of the member in the team.

  • admin - ADMINISTRATOR
  • manager - MANAGER
  • staff - STAFF
Available options:
admin,
manager,
staff

Response

​
id
string<uuid>
required
read-only
​
role
string
required
​
job_title
string
required
read-only
​
user
object
required
​
status
enum<string>
required
  • invited - Invited
  • enabled - Enabled
  • disabled - Disabled
Available options:
invited,
enabled,
disabled
​
volume
string<decimal>
Pattern: ^-?\d{0,12}(?:\.\d{0,3})?$
​
volume_currency
string