User

Create or join a user

Adds a user to the account. If no user exists for the supplied email, one is created and invited. If the user already exists, they are joined to the account.

Roles and permissions can be granted to the user as part of the request. A user that is already a member of the account, or an account that has reached its plan’s member limit, results in a 409.

Permissions

Resource	Permission	Usage
`user`	`manage`	Adds the user and grants their roles and permissions

POST

auth

user

Create or join a user

curl --request POST \
  --url https://api.mezmo.com/v3/auth/user \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "email": "member@snippetfactory.com",
  "firstname": "John",
  "lastname": "Doe",
  "roles": [
    "<string>"
  ],
  "permissions": {
    "view": {
      "read": true,
      "write": true,
      "manage": false
    }
  }
}
'

import requests

url = "https://api.mezmo.com/v3/auth/user"

payload = {
    "email": "member@snippetfactory.com",
    "firstname": "John",
    "lastname": "Doe",
    "roles": ["<string>"],
    "permissions": { "view": {
            "read": True,
            "write": True,
            "manage": False
        } }
}
headers = {
    "Authorization": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    email: 'member@snippetfactory.com',
    firstname: 'John',
    lastname: 'Doe',
    roles: ['<string>'],
    permissions: {view: {read: true, write: true, manage: false}}
  })
};

fetch('https://api.mezmo.com/v3/auth/user', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.mezmo.com/v3/auth/user",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'email' => 'member@snippetfactory.com',
    'firstname' => 'John',
    'lastname' => 'Doe',
    'roles' => [
        '<string>'
    ],
    'permissions' => [
        'view' => [
                'read' => true,
                'write' => true,
                'manage' => false
        ]
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: <api-key>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.mezmo.com/v3/auth/user"

	payload := strings.NewReader("{\n  \"email\": \"member@snippetfactory.com\",\n  \"firstname\": \"John\",\n  \"lastname\": \"Doe\",\n  \"roles\": [\n    \"<string>\"\n  ],\n  \"permissions\": {\n    \"view\": {\n      \"read\": true,\n      \"write\": true,\n      \"manage\": false\n    }\n  }\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.mezmo.com/v3/auth/user")
  .header("Authorization", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"email\": \"member@snippetfactory.com\",\n  \"firstname\": \"John\",\n  \"lastname\": \"Doe\",\n  \"roles\": [\n    \"<string>\"\n  ],\n  \"permissions\": {\n    \"view\": {\n      \"read\": true,\n      \"write\": true,\n      \"manage\": false\n    }\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.mezmo.com/v3/auth/user")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"email\": \"member@snippetfactory.com\",\n  \"firstname\": \"John\",\n  \"lastname\": \"Doe\",\n  \"roles\": [\n    \"<string>\"\n  ],\n  \"permissions\": {\n    \"view\": {\n      \"read\": true,\n      \"write\": true,\n      \"manage\": false\n    }\n  }\n}"

response = http.request(request)
puts response.read_body

{
  "meta": {
    "type": "<string>",
    "page": {
      "next": "<string>",
      "previous": "<string>"
    },
    "pk": "<string>",
    "links": {
      "self": {
        "list": {
          "method": "get",
          "uri": "https://api.mezmo.com/v3/auth/resource"
        },
        "detail": {
          "method": "get",
          "uri": "https://api.mezmo.com/v3/auth/resource/{resource_id}"
        },
        "update": {
          "method": "patch",
          "uri": "https://api.mezmo.com/v3/auth/resource/{resource_id}"
        },
        "replace": {
          "method": "put",
          "uri": "https://api.mezmo.com/v3/auth/resource/{resource_id}"
        },
        "create": {
          "method": "post",
          "uri": "https://api.mezmo.com/v3/auth/resource"
        }
      },
      "related": {}
    }
  },
  "data": {
    "user_id": "5b7ca8b2b59ba49d58cc79ac",
    "firstname": "John",
    "lastname": "Doe",
    "email": "member@snippetfactory.com",
    "name": "John Doe",
    "accounts": [
      "25ef43eae1",
      "b7bebbcd13"
    ],
    "enterprise_ids": [
      "25ef43eae1",
      "b7bebbcd13"
    ],
    "verified": true,
    "isbanned": true,
    "bandetails": {
      "bannedat": "2026-01-15T12:00:00.000Z",
      "banreason": "Unprofessional Conduct",
      "bannedby": {
        "name": "Jand Doe",
        "email": "admin@snippetfactory.com"
      }
    },
    "roles": [
      "5b7ca8b2b59ba49d58cc79ac",
      "5b8fa85cb59ba49d588942b3"
    ],
    "permissions": {
      "view": {
        "read": true,
        "write": true,
        "manage": false
      }
    }
  }
}

{
  "status": 449,
  "code": "<string>",
  "message": "<string>",
  "context": "body",
  "errors": [
    {
      "keyword": "<string>",
      "params": {},
      "message": "<string>",
      "instance_path": null,
      "schema_path": null,
      "property_name": null
    }
  ]
}

{
  "status": 449,
  "code": "<string>",
  "message": "<string>",
  "context": "body",
  "errors": [
    {
      "keyword": "<string>",
      "params": {},
      "message": "<string>",
      "instance_path": null,
      "schema_path": null,
      "property_name": null
    }
  ]
}

{
  "status": 449,
  "code": "<string>",
  "message": "<string>",
  "context": "body",
  "errors": [
    {
      "keyword": "<string>",
      "params": {},
      "message": "<string>",
      "instance_path": null,
      "schema_path": null,
      "property_name": null
    }
  ]
}

{
  "status": 449,
  "code": "<string>",
  "message": "<string>",
  "context": "body",
  "errors": [
    {
      "keyword": "<string>",
      "params": {},
      "message": "<string>",
      "instance_path": null,
      "schema_path": null,
      "property_name": null
    }
  ]
}

{
  "status": 449,
  "code": "<string>",
  "message": "<string>",
  "context": "body",
  "errors": [
    {
      "keyword": "<string>",
      "params": {},
      "message": "<string>",
      "instance_path": null,
      "schema_path": null,
      "property_name": null
    }
  ]
}

{
  "status": 449,
  "code": "<string>",
  "message": "<string>",
  "context": "body",
  "errors": [
    {
      "keyword": "<string>",
      "params": {},
      "message": "<string>",
      "instance_path": null,
      "schema_path": null,
      "property_name": null
    }
  ]
}

{
  "status": 449,
  "code": "<string>",
  "message": "<string>",
  "context": "body",
  "errors": [
    {
      "keyword": "<string>",
      "params": {},
      "message": "<string>",
      "instance_path": null,
      "schema_path": null,
      "property_name": null
    }
  ]
}

{
  "status": 449,
  "code": "<string>",
  "message": "<string>",
  "context": "body",
  "errors": [
    {
      "keyword": "<string>",
      "params": {},
      "message": "<string>",
      "instance_path": null,
      "schema_path": null,
      "property_name": null
    }
  ]
}

{
  "status": 449,
  "code": "<string>",
  "message": "<string>",
  "context": "body",
  "errors": [
    {
      "keyword": "<string>",
      "params": {},
      "message": "<string>",
      "instance_path": null,
      "schema_path": null,
      "property_name": null
    }
  ]
}

{
  "status": 449,
  "code": "<string>",
  "message": "<string>",
  "context": "body",
  "errors": [
    {
      "keyword": "<string>",
      "params": {},
      "message": "<string>",
      "instance_path": null,
      "schema_path": null,
      "property_name": null
    }
  ]
}

Authorizations

Authorization

string

header

required

The primary authentication method for the Mezmo API.

Pass the key in the Authorization header in the format Token <ACCESS TOKEN>. For example:

curl -H 'Authorization: Token <ACCESS TOKEN>'

This key is used for all APIs with the exception of ingest.

Body

application/json

Represents an individual human and is used in registration, authentication and authorization.

string<email>

required

Used primarily as a means of authentication during login. Additionally, this is the address where platform emails intended for the user will be sent.

Maximum string length: 320

Example:

"member@snippetfactory.com"

firstname

string

Name of user given to them upon birth.

Maximum string length: 50

Example:

"John"

lastname

string

Common family or surname of the user.

Maximum string length: 50

Example:

"Doe"

roles

string[]

A list of role identifiers or role names to assign to the user

Maximum array length: 50

Required string length: 2 - 128

permissions

Permission list to be specified in requests body · object

Permissions represent the set of resources a particular entity has access to.

Show child attributes

Example:

{
  "view": {
    "read": true,
    "write": true,
    "manage": false
  }
}

Response

Response format containing the newly created or joined user in addition to the standard metadata object.

meta

object

required

Contains additional contextual information about the api response.

Show child attributes

data

User · object

required

Represents an individual human and is used in registration, authentication and authorization.

Show child attributes

Create or join a user

curl --request POST \
  --url https://api.mezmo.com/v3/auth/user \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "email": "member@snippetfactory.com",
  "firstname": "John",
  "lastname": "Doe",
  "roles": [
    "<string>"
  ],
  "permissions": {
    "view": {
      "read": true,
      "write": true,
      "manage": false
    }
  }
}
'

import requests

url = "https://api.mezmo.com/v3/auth/user"

payload = {
    "email": "member@snippetfactory.com",
    "firstname": "John",
    "lastname": "Doe",
    "roles": ["<string>"],
    "permissions": { "view": {
            "read": True,
            "write": True,
            "manage": False
        } }
}
headers = {
    "Authorization": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    email: 'member@snippetfactory.com',
    firstname: 'John',
    lastname: 'Doe',
    roles: ['<string>'],
    permissions: {view: {read: true, write: true, manage: false}}
  })
};

fetch('https://api.mezmo.com/v3/auth/user', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.mezmo.com/v3/auth/user",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'email' => 'member@snippetfactory.com',
    'firstname' => 'John',
    'lastname' => 'Doe',
    'roles' => [
        '<string>'
    ],
    'permissions' => [
        'view' => [
                'read' => true,
                'write' => true,
                'manage' => false
        ]
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: <api-key>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.mezmo.com/v3/auth/user"

	payload := strings.NewReader("{\n  \"email\": \"member@snippetfactory.com\",\n  \"firstname\": \"John\",\n  \"lastname\": \"Doe\",\n  \"roles\": [\n    \"<string>\"\n  ],\n  \"permissions\": {\n    \"view\": {\n      \"read\": true,\n      \"write\": true,\n      \"manage\": false\n    }\n  }\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.mezmo.com/v3/auth/user")
  .header("Authorization", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"email\": \"member@snippetfactory.com\",\n  \"firstname\": \"John\",\n  \"lastname\": \"Doe\",\n  \"roles\": [\n    \"<string>\"\n  ],\n  \"permissions\": {\n    \"view\": {\n      \"read\": true,\n      \"write\": true,\n      \"manage\": false\n    }\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.mezmo.com/v3/auth/user")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"email\": \"member@snippetfactory.com\",\n  \"firstname\": \"John\",\n  \"lastname\": \"Doe\",\n  \"roles\": [\n    \"<string>\"\n  ],\n  \"permissions\": {\n    \"view\": {\n      \"read\": true,\n      \"write\": true,\n      \"manage\": false\n    }\n  }\n}"

response = http.request(request)
puts response.read_body

{
  "meta": {
    "type": "<string>",
    "page": {
      "next": "<string>",
      "previous": "<string>"
    },
    "pk": "<string>",
    "links": {
      "self": {
        "list": {
          "method": "get",
          "uri": "https://api.mezmo.com/v3/auth/resource"
        },
        "detail": {
          "method": "get",
          "uri": "https://api.mezmo.com/v3/auth/resource/{resource_id}"
        },
        "update": {
          "method": "patch",
          "uri": "https://api.mezmo.com/v3/auth/resource/{resource_id}"
        },
        "replace": {
          "method": "put",
          "uri": "https://api.mezmo.com/v3/auth/resource/{resource_id}"
        },
        "create": {
          "method": "post",
          "uri": "https://api.mezmo.com/v3/auth/resource"
        }
      },
      "related": {}
    }
  },
  "data": {
    "user_id": "5b7ca8b2b59ba49d58cc79ac",
    "firstname": "John",
    "lastname": "Doe",
    "email": "member@snippetfactory.com",
    "name": "John Doe",
    "accounts": [
      "25ef43eae1",
      "b7bebbcd13"
    ],
    "enterprise_ids": [
      "25ef43eae1",
      "b7bebbcd13"
    ],
    "verified": true,
    "isbanned": true,
    "bandetails": {
      "bannedat": "2026-01-15T12:00:00.000Z",
      "banreason": "Unprofessional Conduct",
      "bannedby": {
        "name": "Jand Doe",
        "email": "admin@snippetfactory.com"
      }
    },
    "roles": [
      "5b7ca8b2b59ba49d58cc79ac",
      "5b8fa85cb59ba49d588942b3"
    ],
    "permissions": {
      "view": {
        "read": true,
        "write": true,
        "manage": false
      }
    }
  }
}

{
  "status": 449,
  "code": "<string>",
  "message": "<string>",
  "context": "body",
  "errors": [
    {
      "keyword": "<string>",
      "params": {},
      "message": "<string>",
      "instance_path": null,
      "schema_path": null,
      "property_name": null
    }
  ]
}

{
  "status": 449,
  "code": "<string>",
  "message": "<string>",
  "context": "body",
  "errors": [
    {
      "keyword": "<string>",
      "params": {},
      "message": "<string>",
      "instance_path": null,
      "schema_path": null,
      "property_name": null
    }
  ]
}

{
  "status": 449,
  "code": "<string>",
  "message": "<string>",
  "context": "body",
  "errors": [
    {
      "keyword": "<string>",
      "params": {},
      "message": "<string>",
      "instance_path": null,
      "schema_path": null,
      "property_name": null
    }
  ]
}

{
  "status": 449,
  "code": "<string>",
  "message": "<string>",
  "context": "body",
  "errors": [
    {
      "keyword": "<string>",
      "params": {},
      "message": "<string>",
      "instance_path": null,
      "schema_path": null,
      "property_name": null
    }
  ]
}

{
  "status": 449,
  "code": "<string>",
  "message": "<string>",
  "context": "body",
  "errors": [
    {
      "keyword": "<string>",
      "params": {},
      "message": "<string>",
      "instance_path": null,
      "schema_path": null,
      "property_name": null
    }
  ]
}

{
  "status": 449,
  "code": "<string>",
  "message": "<string>",
  "context": "body",
  "errors": [
    {
      "keyword": "<string>",
      "params": {},
      "message": "<string>",
      "instance_path": null,
      "schema_path": null,
      "property_name": null
    }
  ]
}

{
  "status": 449,
  "code": "<string>",
  "message": "<string>",
  "context": "body",
  "errors": [
    {
      "keyword": "<string>",
      "params": {},
      "message": "<string>",
      "instance_path": null,
      "schema_path": null,
      "property_name": null
    }
  ]
}

{
  "status": 449,
  "code": "<string>",
  "message": "<string>",
  "context": "body",
  "errors": [
    {
      "keyword": "<string>",
      "params": {},
      "message": "<string>",
      "instance_path": null,
      "schema_path": null,
      "property_name": null
    }
  ]
}

{
  "status": 449,
  "code": "<string>",
  "message": "<string>",
  "context": "body",
  "errors": [
    {
      "keyword": "<string>",
      "params": {},
      "message": "<string>",
      "instance_path": null,
      "schema_path": null,
      "property_name": null
    }
  ]
}

{
  "status": 449,
  "code": "<string>",
  "message": "<string>",
  "context": "body",
  "errors": [
    {
      "keyword": "<string>",
      "params": {},
      "message": "<string>",
      "instance_path": null,
      "schema_path": null,
      "property_name": null
    }
  ]
}