Update Profile

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

Updated


Update your user profile. Only the three fields below can be changed through the API. POST is accepted as an alias for PATCH.

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#

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

Request Body#

ParameterTypeRequiredDescription
full_nameStringNoYour full name, up to 300 characters
work_roleStringNoWhat you do, e.g. "Founder", "Marketing lead", up to 300 characters
work_urlStringNoYour company or personal site as an http(s) URL. Empty string clears it

Omit a field to leave it unchanged. At least one field is required.

Request#

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",
  }),
});

Errors#

StatusCodeDescription
400forbidden_fieldsThe request included fields that can never be updated via the API
400unknown_fieldsThe request included fields outside the list above
400work_url was not a valid http(s) URL, or a value exceeded limits

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 50+ integrations
  • White-label embed for your own app
  • 30 free credits — no credit card required