API Reference

Print Mail

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

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.

print_mail.sub_organizations.update(SubOrganizationUpdateParams**kwargs) -> SubOrganizationUpdateResponse

POST/print-mail/v1/sub_organizations

List sub-organizations.

print_mail.sub_organizations.list(SubOrganizationListParams**kwargs) -> SyncSkipLimit[SubOrganization]

GET/print-mail/v1/sub_organizations

Get a sub-organization.

print_mail.sub_organizations.retrieve(strid) -> SubOrganization

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

List users for a sub-organization.

print_mail.sub_organizations.retrieve_users(strid, SubOrganizationRetrieveUsersParams**kwargs) -> SubOrganizationRetrieveUsersResponse

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

ModelsExpand Collapse

class EmailPreferences: …

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

order_preview_send_preference: Optional[Literal["do_not_send", "send_live_only", "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"

class SubOrganization: …

The Sub-Organization object.

id: str

A unique ID prefixed with sub_org_.

country_code: str

The country code of the sub-organization.

created_at: datetime

The UTC time at which this resource was created.

formatdate-time

limit: int

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

name: str

The name of the sub-organization.

object: Literal["sub_org"]

Always sub_org.

spend: int

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

updated_at: datetime

The UTC time at which this resource was last update.

formatdate-time

usage: int

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