People are employees, contractors, performers, and other individuals you need to call to your Events.
Their emails can be used to alert them about new Events or changes to Events through Prospero or third-party integrations.
Create a Person
Creates a Person based on the provided fields.
Request Body
orgIdstring · uuid · requiredThe id of the
Organizationthat owns thisPerson.legalFirstNamestring · requiredlegalLastNamestring · required
stageNamestringThe name the
Persongoes by when performing. This name has highest priority when rendering thePerson'sname throughout the platform.nicknamestringThe name the
Persongoes by informally. This name is preferred over thePerson'slegal name when rendering thePerson'sname throughout the platform, though superceded by thePerson'sstageName.titlestringThe job title of the
Person.pronounsstringCommon options include:
- she/her
- he/him
- they/them
- Not specified
You may also provide a custom string.
photoIdstring · uuidThe UUID of an image stored in Cloudflare Images.
emailstring · emailphonestringnotesstring · htmlAdditional notes about a
Person. Supports basic HTML tags and formatting.
Responses
The newly created Person.
personobject · required
Update a Person
Updates the specified Person by setting the values of the fields passed. Any fields not provided will be left unchanged. By design, you cannot change a Person's id.
path Parameters
personIdstring · uuid · requiredThe id of the
Person.
Request Body
legalFirstNamestringlegalLastNamestringstageNamestringThe name the
Persongoes by when performing. This name has highest priority when rendering thePerson'sname throughout the platform.nicknamestringThe name the
Persongoes by informally. This name is preferred over thePerson'slegal name when rendering thePerson'sname throughout the platform, though superceded by thePerson'sstageName.titlestringThe job title of the
Person.pronounsstringCommon options include:
- she/her
- he/him
- they/them
- Not specified
You may also provide a custom string.
photoIdstring · uuidThe UUID of an image stored in Cloudflare Images.
emailstring · emailphonestringnotesstring · htmlAdditional notes about a
Person. Supports basic HTML tags and formatting.
Responses
The updated Person.
personobject · required