PostGrid Print & Mail

https://docs.postgrid.com
Admin
PostGrid Print & Mail is an API service that enables developers to automate transactional mailings...
Tokens:3,826
Snippets:67
Trust Score:10
Update:5 months ago
Show doc for...
Tokens:
Raw
### cURL Authorization Example

Source: https://docs.postgrid.com/

Demonstrates how to use cURL to authorize an API request using the `-u` shorthand with your API key.

```bash
curl -u YOUR_API_KEY: https://api.postgrid.com/api/v1/some/endpoint
```

--------------------------------

### Expand Resource Example

Source: https://docs.postgrid.com/

Utilize the 'expand[]' query parameter to retrieve nested resource data in a single API request. Note that this is not supported for listing endpoints.

```http
GET /letters?expand[]=template
```

--------------------------------

### Metadata Attachment Example

Source: https://docs.postgrid.com/

Attach arbitrary metadata to API objects using the 'metadata' field. The metadata object has a size limit of 10kb uncompressed.

```json
{
    "metadata": {
        "campaignID": "ABC"
    }
}
```

--------------------------------

### Structured Search Example

Source: https://docs.postgrid.com/

Perform structured queries using a JSON object for the 'search' parameter to target specific fields within resources. This allows for more precise filtering.

```http
GET /v1/letters?search={"metadata.campaignID": "ABC"}
```

--------------------------------

### Search Contacts Example

Source: https://docs.postgrid.com/

Use the 'search' query parameter to find contacts matching a specific string. This is useful for filtering resources based on exact text matches.

```http
GET /v1/contacts?search="New York"
```

--------------------------------

### Merge Variables Example

Source: https://docs.postgrid.com/

Demonstrates how to use nested merge variables in a POST request. The `mergeVariables` object can contain arbitrarily nested structures, accessed using dot notation in templates.

```json
{
    "income": {
        "beforeTax": 100,
        "afterTax": 73
    }
}
```

--------------------------------

### Authorize Request with x-api-key

Source: https://docs.postgrid.com/

All API requests can be authorized using an `x-api-key` header. For cURL, the shorthand `-u YOUR_API_KEY:` can be used.

```http
GET /api/v1/some/endpoint
Host: api.postgrid.com
x-api-key: YOUR_API_KEY
```

--------------------------------

### Idempotent Request Header

Source: https://docs.postgrid.com/

To ensure idempotence for order creation, include the `Idempotency-Key:` header with a unique key, such as a V4 UUID. Subsequent requests with the same key within 24 hours will return the same response.

```http
POST /api/v1/orders
Host: api.postgrid.com
Idempotency-Key: YOUR_UNIQUE_IDEMPOTENCY_KEY
```

--------------------------------

### Specify Letter Size

Source: https://docs.postgrid.com/

Override the default letter size by providing a `size` parameter. Available options are `us_letter`, `us_legal`, and `a4`.

```json
{
  "to": "recipient@example.com",
  "from": "sender@example.com",
  "message": {
    "text": "This is your document."
  },
  "size": "a4"
}
```

--------------------------------

### Cancel an Order

Source: https://docs.postgrid.com/

Orders can be cancelled if they are still in the `ready` status. For ASAP orders, cancellation is possible until 12 AM ET on the following day. For scheduled orders, cancellation is possible until 12 AM ET on the `sendDate`.

```text
If I create an order without a `sendDate` (i.e. send ASAP) at 3PM eastern time on `2020-09-14`, I can cancel it until 12AM eastern time on `2020-09-15`.
```

--------------------------------

### Authentication Error: Invalid API Key

Source: https://docs.postgrid.com/

This error occurs when your API key is incorrect. Ensure you are using a valid key retrieved from the dashboard's Settings page.

```text
Invalid API key ${keyValue}
```

--------------------------------

### URL Encoded Request Body Mapping to JSON

Source: https://docs.postgrid.com/

Illustrates how URL-encoded request parameters map to a JSON structure, specifically for nested objects.

```json
"to": { "addressLine1": "Example" }
```

--------------------------------

### Specify Cheque Size

Source: https://docs.postgrid.com/

Override the default cheque size by providing a `size` parameter. Available options are `us_letter` and `us_legal`.

```json
{
  "to": "recipient@example.com",
  "from": "sender@example.com",
  "message": {
    "text": "This is your cheque."
  },
  "size": "us_legal"
}
```

--------------------------------

### Error Response Structure

Source: https://docs.postgrid.com/

All error responses from the PostGrid API include a top-level `error` object containing a machine-readable `type` and a human-readable `message`.

```json
{
  "error": {
    "type": "invalid_pdf_error",
    "message": "The provided PDF is invalid."
  }
}
```
Tokens:
Raw