Invite a company team member
POST
/api/v3/teams/company
const url = 'https://api.tryletterhead.com/api/v3/teams/company';const options = { method: 'POST', headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'}, body: '{"email":"[email protected]","role":"content_contributor","channels":["amazing-example"],"accountAdminAccess":false}'};
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/company \ --header 'Authorization: Bearer <token>' \ --header 'Content-Type: application/json' \ --data '{ "email": "[email protected]", "role": "content_contributor", "channels": [ "amazing-example" ], "accountAdminAccess": false }'Invites someone to your company’s team, scoped to the channels and role you give them.
Authorizations
Section titled “Authorizations ”Request Body required
Section titled “Request Body required ” Media type application/json
object
email
required
string
name
string
surname
string
role
required
string
channels
required
Channel slugs this member has access to.
Array<string>
accountAdminAccess
required
boolean
temporary
Whether the grant expires automatically.
boolean
expiresInDays
Days until a temporary grant expires (1-365).
integer
Example
{ "role": "content_contributor", "channels": [ "amazing-example" ], "accountAdminAccess": false}Responses
Section titled “ Responses ”Team member invited
Media type application/json
object
items
Array
message
string
total
integer
Example
{ "items": [], "message": "Team member invited successfully.", "total": 10}Still can’t find what you need? Contact support.