Skip to main content
POST
Email the company admins
Key: Write Scope: Company

Authorizations

Authorization
string
header
required

Use your Primo API key in the Authorization header as Bearer <API_KEY>.

Body

application/json
subject
string
required

Subject line of the email

Required string length: 1 - 200
body
string
required

Body of the email, text or HTML (never markdown). It is sanitized and inserted into the Primo email template, which already provides the header and footer.

Required string length: 1 - 100000
adminIds
string[]

Admins to email, as returned by getAdmins (an employee id or an external userId). Omit to email every admin.

Minimum array length: 1
Minimum string length: 1

Response

default - application/json
recipientCount
integer
required
Required range: -9007199254740991 <= x <= 9007199254740991