Access Token

Update an access token

Changes the name of an access token. The key, roles and permissions of an existing token cannot be changed. Create a new token instead.

Permissions

Resource	Permission	Usage
`access_token`	`write`	Updates the access token

PATCH

auth

token

{token_id}

Update an access token

curl --request PATCH \
  --url https://api.mezmo.com/v3/auth/token/{token_id} \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "My First Access Token"
}
'

import requests

url = "https://api.mezmo.com/v3/auth/token/{token_id}"

payload = { "name": "My First Access Token" }
headers = {
    "Authorization": "<api-key>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'PATCH',
  headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({name: 'My First Access Token'})
};

fetch('https://api.mezmo.com/v3/auth/token/{token_id}', 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/token/{token_id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'name' => 'My First Access Token'
  ]),
  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/token/{token_id}"

	payload := strings.NewReader("{\n  \"name\": \"My First Access Token\"\n}")

	req, _ := http.NewRequest("PATCH", 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.patch("https://api.mezmo.com/v3/auth/token/{token_id}")
  .header("Authorization", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"My First Access Token\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.mezmo.com/v3/auth/token/{token_id}")

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

request = Net::HTTP::Patch.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"My First Access Token\"\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": {
    "name": "My First Access Token",
    "trailer": "a3f1",
    "token_id": "5b7ca8b2b59ba49d58cc79ac",
    "created_at": "2026-01-15T12:00:00.000Z",
    "modified_at": "2026-01-15T12:00:00.000Z",
    "last_used_at": "2026-01-15T12:00:00.000Z",
    "user_id": "5b7ca8b2b59ba49d58cc79ac",
    "account_id": "5b7ca8b2b59ba49d58cc79ac",
    "enterprise_id": "25ef43eae1",
    "expire_at": "2026-01-15T12:00:00.000Z",
    "type": "access",
    "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
    }
  ]
}

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.

Path Parameters

token_id

string

required

The unique identifer of the token to be removed

Maximum string length: 24

Pattern: ^[a-f\d]{24}$

Body

application/json

Access Tokens represent a fixed level of access to the platform for a specific user

name

string

required

A user friendly name for a specific access token.

Required string length: 3 - 128

Example:

"My First Access Token"

Response

Response format containing the updated Access Token, in addition to the standard metadata object.

meta

object

required

Contains additional contextual information about the api response.

Show child attributes

data

Access Token · object

required

Access Tokens represent a fixed level of access to the platform for a specific user

Show child attributes

Update an access token

curl --request PATCH \
  --url https://api.mezmo.com/v3/auth/token/{token_id} \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "My First Access Token"
}
'

import requests

url = "https://api.mezmo.com/v3/auth/token/{token_id}"

payload = { "name": "My First Access Token" }
headers = {
    "Authorization": "<api-key>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'PATCH',
  headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({name: 'My First Access Token'})
};

fetch('https://api.mezmo.com/v3/auth/token/{token_id}', 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/token/{token_id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'name' => 'My First Access Token'
  ]),
  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/token/{token_id}"

	payload := strings.NewReader("{\n  \"name\": \"My First Access Token\"\n}")

	req, _ := http.NewRequest("PATCH", 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.patch("https://api.mezmo.com/v3/auth/token/{token_id}")
  .header("Authorization", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"My First Access Token\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.mezmo.com/v3/auth/token/{token_id}")

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

request = Net::HTTP::Patch.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"My First Access Token\"\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": {
    "name": "My First Access Token",
    "trailer": "a3f1",
    "token_id": "5b7ca8b2b59ba49d58cc79ac",
    "created_at": "2026-01-15T12:00:00.000Z",
    "modified_at": "2026-01-15T12:00:00.000Z",
    "last_used_at": "2026-01-15T12:00:00.000Z",
    "user_id": "5b7ca8b2b59ba49d58cc79ac",
    "account_id": "5b7ca8b2b59ba49d58cc79ac",
    "enterprise_id": "25ef43eae1",
    "expire_at": "2026-01-15T12:00:00.000Z",
    "type": "access",
    "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
    }
  ]
}