Update Profile

Update the profile name, work role and work URL using your API key or OAuth token

Updated Oct 27, 2026

PATCH

/v1/me

curl -X PATCH "https://api.orshot.com/v1/me" \
  -H "Authorization: Bearer <ORSHOT_API_KEY>" \
  -H "Content-Type: application/json" \
  -d '{
    "full_name": "<FULL_NAME>",
    "work_role": "<WORK_ROLE>",
    "work_url": "<WORK_URL>"
  }'

const res = await fetch("https://api.orshot.com/v1/me", {
  method: "PATCH",
  headers: {
    "Content-Type": "application/json",
    Authorization: "Bearer <ORSHOT_API_KEY>",
  },
  body: JSON.stringify({
    "full_name": "<FULL_NAME>",
    "work_role": "<WORK_ROLE>",
    "work_url": "<WORK_URL>"
  }),
});

const data = await res.json();

import requests

response = requests.patch(
    "https://api.orshot.com/v1/me",
    headers={"Authorization": "Bearer <ORSHOT_API_KEY>"},
    json={
      "full_name": "<FULL_NAME>",
      "work_role": "<WORK_ROLE>",
      "work_url": "<WORK_URL>"
    },
)

data = response.json()

$ch = curl_init("https://api.orshot.com/v1/me");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "PATCH");
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "Authorization: Bearer <ORSHOT_API_KEY>",
    "Content-Type: application/json",
]);
curl_setopt($ch, CURLOPT_POSTFIELDS, json_encode([
  "full_name" => "<FULL_NAME>",
  "work_role" => "<WORK_ROLE>",
  "work_url" => "<WORK_URL>"
]));

$data = json_decode(curl_exec($ch), true);
curl_close($ch);

require "net/http"
require "json"

uri = URI("https://api.orshot.com/v1/me")
req = Net::HTTP::Patch.new(uri)
req["Authorization"] = "Bearer <ORSHOT_API_KEY>"
req["Content-Type"] = "application/json"
req.body = {
  "full_name": "<FULL_NAME>",
  "work_role": "<WORK_ROLE>",
  "work_url": "<WORK_URL>"
}.to_json

res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) { |http| http.request(req) }
data = JSON.parse(res.body)

Update the workspace owner's profile. This is the owner's profile even when a teammate's API key or token makes the call. Only the three fields below can be changed through the API. POST is accepted as an alias for PATCH.

Works with API keys and with Orshot's own OAuth apps, such as the Orshot MCP server. Tokens from third-party OAuth apps are refused.

Your email address cannot be changed through the API since it is tied to your billing and login. Write to hi@orshot.com to change it. Requests that include email or any billing field return 400 with code forbidden_fields.

Endpoint#

Endpoint

https://api.orshot.com/v1/me

Request Body#

Parameter	Type	Required	Description
`full_name`	String	No	Your full name, up to 300 characters
`work_role`	String	No	What you do, e.g. "Founder", "Marketing lead", up to 300 characters
`work_url`	String	No	Your company or personal site as an http(s) URL. Empty string clears it

Omit a field to leave it unchanged. A request with none of the fields changes nothing and returns an empty updated list.

Request#

JavaScript

await fetch("https://api.orshot.com/v1/me", {
  method: "PATCH",
  headers: {
    "Content-Type": "application/json",
    Authorization: "Bearer <ORSHOT_API_KEY>",
  },
  body: JSON.stringify({
    full_name: "John Doe",
    work_role: "Founder",
    work_url: "https://acme.com",
  }),
});

JSON

{
  "data": {
    "updated": ["full_name", "work_role", "work_url"]
  }
}

Errors#

Status	Code	Description
`400`	`forbidden_fields`	The request included fields that can never be updated via the API
`400`	`unknown_fields`	The request included fields outside the list above
`400`		`work_url` was not a valid http(s) URL, or a value exceeded limits

Was this page helpful?

Ready to automate?

Start rendering images, PDFs and videos from your templates in under 2 minutes. Free plan, no credit card.

Get your API key

Image, PDF and video generation via API
Visual editor with AI and smart layouts
Zapier, Make, MCP and 40+ integrations
White-label embed for your own app
100 free credits a month, no credit card required