PostGrid

PostGrid integration (Communication, Marketing). Imported from open-connector.

API key9 toolshttps://api.postgrid.com/print-mail/v1

POST

postgrid_create_contact

Create a PostGrid Print & Mail contact using either a person name, company name, or both.

/contacts

16 parameters

Param	Type	Required	Description
addressLine1	string	required	The first line of the contact's address.
addressLine2	string	optional	The second line of the contact's address.
city	string	optional	The city of the contact's address.
provinceOrState	string	optional	The state or province of the contact's address.
postalOrZip	string	optional	The postal or ZIP code of the contact's address.
countryCode	string	required	The ISO 3166-1 alpha-2 country code of the contact's address.
companyName	string	optional	The contact company name. Required when firstName is omitted.
firstName	string	optional	The contact first name. Required when companyName is omitted.
lastName	string	optional	The contact last name.
email	string	optional	The contact email address.
phoneNumber	string	optional	The contact phone number.
jobTitle	string	optional	The contact job title.
description	string	optional	An optional description visible in PostGrid and the dashboard.
metadata	object	optional	Metadata key-value pairs stored with the PostGrid resource.
skipVerification	boolean	optional	Whether PostGrid should skip address verification.
forceVerifiedStatus	boolean	optional	Whether PostGrid should force this contact to verified status.

GET

postgrid_list_contacts

List PostGrid Print & Mail contacts with optional pagination and search.

/contacts

3 parameters

Param	Type	Required	Description
skip	integer	optional	The number of resources to skip before returning results.
limit	integer	optional	The maximum number of resources to return.
search	string	optional	An unstructured search string or a JSON string representing a PostGrid structur…

GET

postgrid_get_contact

Retrieve one PostGrid Print & Mail contact by ID.

/contacts/{id}

1 parameter

Param	Type	Required	Description
id	string	required	The PostGrid contact ID.

DELETE

postgrid_delete_contact

Delete one PostGrid Print & Mail contact by ID.

/contacts/{id}

1 parameter

Param	Type	Required	Description
id	string	required	The PostGrid contact ID.

POST

postgrid_create_template

Create a PostGrid Print & Mail template with optional HTML, description, and metadata.

/templates

3 parameters

Param	Type	Required	Description
html	string	optional	The HTML content of the template.
description	string	optional	An optional description visible in PostGrid and the dashboard.
metadata	object	optional	Metadata key-value pairs stored with the PostGrid resource.

GET

postgrid_list_templates

List PostGrid Print & Mail templates with optional pagination and search.

/templates

3 parameters

Param	Type	Required	Description
skip	integer	optional	The number of resources to skip before returning results.
limit	integer	optional	The maximum number of resources to return.
search	string	optional	An unstructured search string or a JSON string representing a PostGrid structur…

GET

postgrid_get_template

Retrieve one PostGrid Print & Mail template by ID.

/templates/{id}

1 parameter

Param	Type	Required	Description
id	string	required	The PostGrid template ID.

POST

postgrid_update_template

Update the HTML, description, or metadata of one PostGrid Print & Mail template.

/templates/{id}

4 parameters

Param	Type	Required	Description
id	string	required	The PostGrid template ID to update.
html	string	optional	The replacement HTML content for the template.
description	string	optional	The replacement description for the template.
metadata	object	optional	Metadata key-value pairs stored with the PostGrid resource.

DELETE

postgrid_delete_template

Delete one PostGrid Print & Mail template by ID.

/templates/{id}

1 parameter

Param	Type	Required	Description
id	string	required	The PostGrid template ID.