Sub Organizations

Sub-organizations enable you to create isolated PostGrid accounts ("sub-organizations") under your PostGrid account (the "parent organization"). Each sub-organization has fully isolated resources and users, and can act independently.

This allows you to isolate different departments or even re-sell PostGrid entirely.

You can request access to this feature by reaching out to [email protected]

Create a sub-organization.

POST/print-mail/v1/sub_organizations

List sub-organizations.

GET/print-mail/v1/sub_organizations

Get a sub-organization.

GET/print-mail/v1/sub_organizations/{id}

List users for a sub-organization.

GET/print-mail/v1/sub_organizations/{id}/users

ModelsExpand Collapse

EmailPreferences = object { orderPreviewSendPreference }

A set of preferences for how a user should receive emails.

orderPreviewSendPreference: optional "do_not_send" or "send_live_only" or "send_live_and_test"

The list of preferences for receiving order preview emails.

One of the following:

"do_not_send"

"send_live_only"

"send_live_and_test"

SubOrganization = object { id, countryCode, createdAt, 6 more }

The Sub-Organization object.

id: string

A unique ID prefixed with sub_org_.

countryCode: string

The country code of the sub-organization.

createdAt: string

The UTC time at which this resource was created.

formatdate-time

limit: number

The limit of mailings the sub-organization can send before being charged overages for the month.

name: string

The name of the sub-organization.

object: "sub_org"

Always sub_org.

spend: number

The current rolling charge for the sub-organization for the month, in cents.

updatedAt: string

The UTC time at which this resource was last update.

formatdate-time

usage: number

The amount of mail the sub-organization has sent out this month.