PostGrid Integration

Field	Description	Required	Format
PostGrid API Key	Your PostGrid API key from app.postgrid.com	Yes	`live_sk_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx`

create_contact — Create a new contact in PostGrid

Parameters

string

required

The first name of the contact

string

The last name of the contact

string

The contact’s company name

string

required

The contact’s first address line

string

The contact’s second address line

string

The contact’s city

string

The province or state of the contact

string

The contact’s email address

string

The contact’s phone number

string

The contact’s job title

string

The postal code or ZIP code of the contact

string

ISO 3166-1 country code of the contact’s address. Defaults to CA (Default: CA)

string

A description for the contact

boolean

If true, skip address verification and mark the address as failed

Response

{
  "$defs": {
    "ContactResource": {
      "additionalProperties": false,
      "description": "A contact object returned by the PostGrid API.",
      "properties": {
        "id": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Id"
        },
        "object": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Object"
        },
        "live": {
          "anyOf": [
            {
              "type": "boolean"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Live"
        },
        "first_name": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "First Name"
        },
        "last_name": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Last Name"
        },
        "company_name": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Company Name"
        },
        "address_line1": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Address Line1"
        },
        "address_line2": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Address Line2"
        },
        "city": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "City"
        },
        "province_or_state": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Province Or State"
        },
        "postal_or_zip": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Postal Or Zip"
        },
        "country": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Country"
        },
        "country_code": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Country Code"
        },
        "email": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Email"
        },
        "phone_number": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Phone Number"
        },
        "job_title": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Job Title"
        },
        "description": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Description"
        },
        "address_status": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Address Status"
        }
      },
      "title": "ContactResource",
      "type": "object"
    }
  },
  "additionalProperties": false,
  "properties": {
    "success": {
      "title": "Success",
      "type": "boolean"
    },
    "error": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Error"
    },
    "contact": {
      "anyOf": [
        {
          "$ref": "#/$defs/ContactResource"
        },
        {
          "type": "null"
        }
      ],
      "default": null
    }
  },
  "required": [
    "success"
  ],
  "title": "CreateContactOutput",
  "type": "object"
}

create_letter — Create a new letter in PostGrid

Parameters

string

required

The ID or contact object of the receiver

string

required

The ID or contact object of the sender

string

required

The HTML content of the letter

string

Location where the address will be placed. One of: top_first_page, insert_blank_page

boolean

Whether the letter is double sided

boolean

Whether the letter will be printed in color

integer

Page number to be perforated

string

Extra services for the letter. One of: certified, certified_return_receipt, registered

string

Envelope type. One of: standard_double_window, flat

string

The ID of the return envelope to be used

string

Desired date for the letter to be sent out (ISO 8601 format)

string

A description for the letter

boolean

Whether to use express shipping

string

Mailing class. One of: standard_class, first_class. Defaults to first_class

string

Letter size. One of: us_letter, us_legal, a4

Response

{
  "$defs": {
    "LetterResource": {
      "additionalProperties": false,
      "description": "A letter object returned by the PostGrid API.",
      "properties": {
        "id": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Id"
        },
        "object": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Object"
        },
        "live": {
          "anyOf": [
            {
              "type": "boolean"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Live"
        },
        "send_date": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Send Date"
        },
        "status": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Status"
        },
        "url": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Url"
        }
      },
      "title": "LetterResource",
      "type": "object"
    }
  },
  "additionalProperties": false,
  "properties": {
    "success": {
      "title": "Success",
      "type": "boolean"
    },
    "error": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Error"
    },
    "letter": {
      "anyOf": [
        {
          "$ref": "#/$defs/LetterResource"
        },
        {
          "type": "null"
        }
      ],
      "default": null
    }
  },
  "required": [
    "success"
  ],
  "title": "CreateLetterOutput",
  "type": "object"
}

create_postcard — Create a new postcard in PostGrid

Parameters

string

required

The ID or contact object of the receiver

string

required

The ID or contact object of the sender

string

required

The HTML content for the front of the postcard

string

required

The HTML content for the back of the postcard

string

required

Postcard size. One of: 6x4, 9x6, 11x6

string

Desired date for the postcard to be sent out (ISO 8601 format)

boolean

Whether to use express shipping

string

A description for the postcard

string

Mailing class. One of: standard_class, first_class. Defaults to first_class

Response

{
  "$defs": {
    "PostcardResource": {
      "additionalProperties": false,
      "description": "A postcard object returned by the PostGrid API.",
      "properties": {
        "id": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Id"
        },
        "object": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Object"
        },
        "live": {
          "anyOf": [
            {
              "type": "boolean"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Live"
        },
        "send_date": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Send Date"
        },
        "status": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Status"
        },
        "size": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Size"
        },
        "url": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Url"
        }
      },
      "title": "PostcardResource",
      "type": "object"
    }
  },
  "additionalProperties": false,
  "properties": {
    "success": {
      "title": "Success",
      "type": "boolean"
    },
    "error": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Error"
    },
    "postcard": {
      "anyOf": [
        {
          "$ref": "#/$defs/PostcardResource"
        },
        {
          "type": "null"
        }
      ],
      "default": null
    }
  },
  "required": [
    "success"
  ],
  "title": "CreatePostcardOutput",
  "type": "object"
}

Using

Providers

Building

Tools

PostGrid Integration for AI Agents & Workflows

Overview

Authentication

API Key Authentication

Required Credentials

Available Actions

Parameters

Response

Parameters

Response

Parameters

Response

Limits & Quotas

Ahrefs

Google Ad Manager

Google Ads

Links

​Overview

​Authentication

​API Key Authentication

​Required Credentials

​Available Actions

​Parameters

​Response

​Parameters

​Response

​Parameters

​Response

​Limits & Quotas

​Related integrations

Ahrefs

Google Ad Manager

Google Ads

​Links

Overview

Authentication

API Key Authentication

Required Credentials

Available Actions

Parameters

Response

Parameters

Response

Parameters

Response

Limits & Quotas

Related integrations

Links