API Reference
Status PageRoadmapTestimoniesShare feedback
  1. Settings & Administration
  2. User

Create a new User

post
https://api-sandbox.yousign.app/v3/users

Creates a new application User and sends them an invitation email.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

You can create a new User only if you meet the following conditions:

  • You have at least one available license in the Organization. Learn more about licenses.
  • There is no existing Youtrust User with the same email address.
  • There is no User Invitation with the same email address in the Organization.

Related guide: User

🔓 Endpoint access

  • Environments: production
  • API key scopes: organization
  • Plans: plus, pro, scale
  • Add-ons (for production access): none
Body Params
string
required

The email address must not match any existing User's email.

string
enum
required

Role assigned to the User in the Organization.

Allowed:
string
enum
required
length ≥ 1

Locale settings used for communication.

workspaces
array of objects, unique
required
length ≥ 1

The new User must be associated with at least one Workspace in the Organization.

User's Workspace*
string | null
^(?!\s)[0-9A-Za-zĄÀÁÂÃÄÅÇĆÈÉÊËĘÌÍÎÏŁÑŃÒÓÔÕÖŚÙÚÛÜÝŹŻąàáâãäåæçćèéêëęìíîïłñńòóôõöśùúûüýÿźżßĀāĂăĈĉĊċČčĎďĐđĒēĔĕĖėĚěĜĝĞğĠġĢģĤĥĦħĨĩĪīĬĭĮįİıIJijĴĵĶķĸĹĺĻļĽľĿŀŅņŇňʼnŊŋŌōŎŏŐőŒœŔŕŖŗŘřŜŝŞşŠšŢţŤťŦŧŨũŪūŬŭŮůŰűŲųŴŵŶŷŸŽžſøØÆȘșȚț`'() -]+(?<!\s)$

User's first name

string | null
^(?!\s)[0-9A-Za-zĄÀÁÂÃÄÅÇĆÈÉÊËĘÌÍÎÏŁÑŃÒÓÔÕÖŚÙÚÛÜÝŹŻąàáâãäåæçćèéêëęìíîïłñńòóôõöśùúûüýÿźżßĀāĂăĈĉĊċČčĎďĐđĒēĔĕĖėĚěĜĝĞğĠġĢģĤĥĦħĨĩĪīĬĭĮįİıIJijĴĵĶķĸĹĺĻļĽľĿŀŅņŇňʼnŊŋŌōŎŏŐőŒœŔŕŖŗŘřŜŝŞşŠšŢţŤťŦŧŨũŪūŬŭŮůŰűŲųŴŵŶŷŸŽžſøØÆȘșȚț`'() -]+(?<!\s)$

User's last name

string | null

E.164 format

string | null

This property is a Safe String.

Responses

Updated about 2 months ago

Language
Credentials
Bearer
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated about 2 months ago