Create a company administrator
POST
/api/v3/teams/member
const url = 'https://api.tryletterhead.com/api/v3/teams/member';const options = { method: 'POST', headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request POST \ --url https://api.tryletterhead.com/api/v3/teams/member \ --header 'Authorization: Bearer <token>' \ --header 'Content-Type: application/json' \Grant someone full company-administrator access.
Because of the access this grants, this endpoint is restricted to Letterhead staff: it
authenticates as a signed-in user with a @tryletterhead.com or @whereby.us email address
rather than a company API key, so it is not available to external integrations.
Authorizations
Section titled “Authorizations ”Request Body required
Section titled “Request Body required ” Media type application/json
object
email
required
Email address to grant company-administrator access to.
string
name
string
surname
string
temporary
Whether the grant expires automatically.
boolean
expiresInDays
Days until a temporary grant expires (1-365).
integer
company
Company slug to scope the grant to, on a shared tenant where one tenant holds many companies. Omitted grants tenant-wide company-level access.
string
Example
{ "temporary": true, "expiresInDays": 7}Responses
Section titled “ Responses ”200 OK
Media type application/json
object
items
Array
message
string
total
integer
Example
{ "items": [], "message": "Your team is one person stronger.", "total": 0}Still can’t find what you need? Contact support.