Postalytics

https://docs.postalytics.com
Admin
The Postalytics API provides a powerful and flexible platform for programmatically managing direct...
Tokens:83,678
Snippets:278
Trust Score:10
Update:10 months ago
Show doc for...
Tokens:
Raw
### Build GET Request to Postalytics API (Shell)

Source: https://docs.postalytics.com/references/postalytics-rest-api/get-contact

This example shows how to construct a GET request to the Postalytics API to retrieve contact details. It uses `curl` and requires an Authorization header for authentication. The input is a contact ID, and the output is a JSON object containing contact information.

```shell
curl --request GET \
  --url https://api-dev.postalytics.com/api/v1/contacts/details/123 \
  --header 'Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQ='
```

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

### Get Suppression List Contact Example (shell)

Source: https://docs.postalytics.com/references/postalytics-rest-api/get-suppression-list-contact

Demonstrates how to retrieve a specific contact from a suppression list using a GET request. It requires the list ID and contact ID as path parameters and an optional offset for pagination. The example uses cURL for the request.

```shell
curl --request GET \
  --url 'https://api-dev.postalytics.com/api/v1/lists/suppression/contacts/123/123?offset=123' \
  --header 'Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQ='

```

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

### Get Contact Event API Request Example (Shell)

Source: https://docs.postalytics.com/references/postalytics-rest-api/get-contact-event

This code example demonstrates how to retrieve the most recent events for a specific contact within a campaign using the Postalytics API. It includes the necessary GET request, URL parameters for campaign ID, contact ID, page number, and page size, as well as an example of the Authorization header. The PageSize parameter has a maximum value of 100.

```shell
curl --request GET \
  --url 'https://api-dev.postalytics.com/api/v1/campaigns/123/events/123?PageNumber=123&PageSize=123' \
  --header 'Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQ='

```

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

### Get Integrations API Request (Shell)

Source: https://docs.postalytics.com/references/postalytics-rest-api/get-integrations

Demonstrates how to retrieve all Connect integrations for the current user using a cURL command. This example shows the request method, URL, and necessary authorization header. The response is a JSON array of integration objects.

```shell
curl --request GET \
  --url https://api-dev.postalytics.com/api/v1/account/integrations \
  --header 'Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQ='
```

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

### Get Webhook API Request (Shell)

Source: https://docs.postalytics.com/references/postalytics-rest-api/get-webhook

Demonstrates how to make a GET request to retrieve a specific webhook using the Postalytics API. This example uses `curl` and includes necessary headers for authentication and endpoint specification. The response is a JSON array of webhook objects.

```shell
curl --request GET \
  --url https://api-dev.postalytics.com/api/v1/webhooks/123 \
  --header 'Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQ='

```

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

### Get Flow API Request Example (Shell)

Source: https://docs.postalytics.com/references/postalytics-rest-api/get-flow

This code snippet demonstrates how to make a GET request to retrieve a specific flow using the Postalytics API. It includes the necessary endpoint and authorization headers. The response shows the expected JSON structure for a flow object.

```shell
curl --request GET \
  --url https://api-dev.postalytics.com/api/v1/flow/string \
  --header 'Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQ='

```

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

### GET /Flow/Get All Flows

Source: https://docs.postalytics.com/getting-started/quick-start

Retrieves a list of all flows.

```APIDOC
## GET /Flow/Get All Flows

### Description
Retrieves a list of all flows.

### Method
GET

### Endpoint
/Flow/Get All Flows

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
N/A

### Response
#### Success Response (200)
- **flows** (array) - List of flows

#### Response Example
{
  "flows": [
    {
      "id": 678,
      "name": "Example Flow"
    }
  ]
}
```

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

### GET /Campaign/Get Campaign

Source: https://docs.postalytics.com/getting-started/quick-start

Retrieves information about a specific campaign.

```APIDOC
## GET /Campaign/Get Campaign

### Description
Retrieves information about a specific campaign.

### Method
GET

### Endpoint
/Campaign/Get Campaign

### Parameters
#### Path Parameters
None

#### Query Parameters
- **campaignId** (integer) - Required - The ID of the campaign

#### Request Body
None

### Request Example
N/A

### Response
#### Success Response (200)
- **campaign** (object) - Campaign details

#### Response Example
{
  "campaign": {
    "id": 789,
    "name": "Example Campaign",
    "status": "active"
  }
}
```

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

### Postalytics JSON Response Example

Source: https://docs.postalytics.com/references/postalytics-rest-api/send-mail

This JSON object shows an example response from the Postalytics API, likely indicating the scheduled send date for a mail piece. This response format is crucial for confirming the successful submission and processing of a request.

```json
{
  "send_date": "1999-02-19T12:00:00.00:00"
}
```

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

### GET /Flow/Get Flow

Source: https://docs.postalytics.com/getting-started/quick-start

Retrieves a specific flow.

```APIDOC
## GET /Flow/Get Flow

### Description
Retrieves a specific flow.

### Method
GET

### Endpoint
/Flow/Get Flow

### Parameters
#### Path Parameters
None

#### Query Parameters
- **flowId** (integer) - Required - The ID of the flow

#### Request Body
None

### Request Example
N/A

### Response
#### Success Response (200)
- **flow** (object) - Flow details

#### Response Example
{
  "flow": {
    "id": 678,
    "name": "Example Flow",
    "description": "A sample flow"
  }
}
```

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

### GET /api/campaign/getAllCampaigns

Source: https://docs.postalytics.com/references/postalytics-rest-api/get-suppression-list-contact

Retrieves all campaigns.

```APIDOC
## GET /api/campaign/getAllCampaigns

### Description
Retrieves all campaigns.

### Method
GET

### Endpoint
/api/campaign/getAllCampaigns

### Parameters
N/A

### Request Example
```json
{
  "example": "N/A"
}
```

### Response
#### Success Response (200)
- **Response Body** (array) - Contains a list of campaigns

#### Response Example
```json
{
  "example": "N/A"
}
```
```

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

### GET /api/campaign/getAllDripCampaigns

Source: https://docs.postalytics.com/references/postalytics-rest-api/get-suppression-list-contact

Retrieves all drip campaigns.

```APIDOC
## GET /api/campaign/getAllDripCampaigns

### Description
Retrieves all drip campaigns.

### Method
GET

### Endpoint
/api/campaign/getAllDripCampaigns

### Parameters
N/A

### Request Example
```json
{
  "example": "N/A"
}
```

### Response
#### Success Response (200)
- **Response Body** (array) - Contains a list of drip campaigns

#### Response Example
```json
{
  "example": "N/A"
}
```
```

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

### GET /api/flow

Source: https://docs.postalytics.com/index

Retrieves all flows. This endpoint lists all available flows.

```APIDOC
## GET /api/flow

### Description
Retrieves all flows.

### Method
GET

### Endpoint
/api/flow

### Parameters
No parameters required.

### Request Example
N/A

### Response
#### Success Response (200)
- **flows** (array) - An array of flow objects.

#### Response Example
{
  "flows": [
    {
      "id": "flow_id",
      "name": "Flow Name",
      "status": "active"
    }
  ]
}
```

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

### GET /Campaign/Get All Campaigns

Source: https://docs.postalytics.com/getting-started/quick-start

Retrieves a list of all campaigns associated with the account.

```APIDOC
## GET /Campaign/Get All Campaigns

### Description
Retrieves a list of all campaigns associated with the account.

### Method
GET

### Endpoint
/Campaign/Get All Campaigns

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
N/A

### Response
#### Success Response (200)
- **campaigns** (array) - List of campaigns

#### Response Example
{
  "campaigns": [
    {
      "id": 789,
      "name": "Example Campaign"
    }
  ]
}
```

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

### GET /SuppressionList/Get Suppression List

Source: https://docs.postalytics.com/getting-started/quick-start

Retrieves a suppression list.

```APIDOC
## GET /SuppressionList/Get Suppression List

### Description
Retrieves a suppression list.

### Method
GET

### Endpoint
/SuppressionList/Get Suppression List

### Parameters
#### Path Parameters
None

#### Query Parameters
- **suppressionListId** (integer) - Required - The ID of the suppression list

#### Request Body
None

### Request Example
N/A

### Response
#### Success Response (200)
- **suppressionList** (object) - Suppression list details

#### Response Example
{
  "suppressionList": {
    "id": 890,
    "name": "Example Suppression List",
    "description": "List of suppressed contacts"
  }
}
```

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

### Delete Campaign API Example (Shell)

Source: https://docs.postalytics.com/references/postalytics-rest-api/delete-campaign

This code example demonstrates how to delete a specified campaign using the Postalytics API. It requires the campaign ID as a path parameter and includes an Authorization header for authentication. The response indicates the date and time of deletion.

```shell
curl --request DELETE \
  --url https://api-dev.postalytics.com/api/v1/campaigns/123 \
  --header 'Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQ='

```

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

### Delete Suppression List Example (Shell)

Source: https://docs.postalytics.com/references/postalytics-rest-api/delete-suppression-list

This example demonstrates how to delete a specified suppression list using a cURL command. It requires the list ID as a path parameter and an Authorization header for authentication. The response includes a message confirming the deletion.

```shell
curl --request DELETE \
  --url https://api-dev.postalytics.com/api/v1/lists/suppression/123 \
  --header 'Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQ='

```

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

### GET /api/campaign/stats

Source: https://docs.postalytics.com/index

Retrieves campaign statistics. This allows you to track the performance of your campaigns.

```APIDOC
## GET /api/campaign/stats

### Description
Retrieves campaign statistics.

### Method
GET

### Endpoint
/api/campaign/stats

### Parameters
No parameters required.

### Request Example
N/A

### Response
#### Success Response (200)
- **stats** (object) - Campaign statistics.

#### Response Example
{
  "stats": {
    "sent": 1000,
    "delivered": 950,
    "opens": 50
  }
}
```

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

### Build Request and Response Example

Source: https://docs.postalytics.com/references/postalytics-rest-api/create-contact-on-list

This section demonstrates the structure of a request body for creating or updating contact information and the typical response received upon successful creation.

```APIDOC
## POST /websites/postalytics

### Description
This endpoint is used to build a request for creating or updating contact information within Postalytics. It accepts a detailed JSON payload with various contact and address fields. A success response typically includes the creation date of the record.

### Method
POST

### Endpoint
/websites/postalytics

### Parameters
#### Request Body
- **address_city** (string) - Required - The city of the address.
- **address_state** (string) - Required - The state of the address.
- **address_street** (string) - Required - The street address.
- **address_street2** (string) - Optional - Secondary address information (e.g., apartment or suite number).
- **address_zip** (string) - Required - The ZIP code of the address.
- **company** (string) - Optional - The company the contact is associated with.
- **contact_id** (integer) - Optional - The unique identifier for the contact.
- **contact_list_id** (integer) - Required - The ID of the contact list to which the contact belongs.
- **created_date** (string) - Optional - The date and time the contact was created, in ISO 8601 format.
- **email_address** (string) - Optional - The email address of the contact.
- **first_name** (string) - Optional - The first name of the contact.
- **last_name** (string) - Optional - The last name of the contact.
- **mobile_phone** (string) - Optional - The mobile phone number of the contact.
- **occupation** (string) - Optional - The occupation of the contact.
- **phone** (string) - Optional - The primary phone number of the contact.
- **var_field_1** to **var_field_35** (string) - Optional - Placeholder fields for custom data.
- **website** (string) - Optional - The website associated with the contact or company.

### Request Example
```json
{
  "address_city": "New York",
  "address_state": "NY",
  "address_street": "36 Pipers Row",
  "address_street2": "Room 101",
  "address_zip": "10001",
  "company": "Metacortex",
  "contact_id": 123,
  "contact_list_id": 10142067,
  "created_date": "1999-02-19T12:00:00.00:00",
  "email_address": "tanderson@metacortex.net",
  "first_name": "Thomas",
  "last_name": "Anderson",
  "mobile_phone": "888-574-7346",
  "occupation": "programmer",
  "phone": "888-574-7346",
  "var_field_1": "",
  "var_field_10": "",
  "var_field_11": "",
  "var_field_12": "",
  "var_field_13": "",
  "var_field_14": "",
  "var_field_15": "",
  "var_field_16": "",
  "var_field_17": "",
  "var_field_18": "",
  "var_field_19": "",
  "var_field_2": "",
  "var_field_20": "",
  "var_field_21": "",
  "var_field_22": "",
  "var_field_23": "",
  "var_field_24": "",
  "var_field_25": "",
  "var_field_26": "",
  "var_field_27": "",
  "var_field_28": "",
  "var_field_29": "",
  "var_field_3": "",
  "var_field_30": "",
  "var_field_31": "",
  "var_field_32": "",
  "var_field_33": "",
  "var_field_34": "",
  "var_field_35": "",
  "var_field_4": "",
  "var_field_5": "",
  "var_field_6": "",
  "var_field_7": "",
  "var_field_8": "",
  "var_field_9": "",
  "website": "metacortex.net"
}
```

### Response
#### Success Response (200)
- **created_date** (string) - The date and time the contact was created, in ISO 8601 format.

#### Response Example
```json
{
  "created_date": "1999-02-19T12:00:00.00:00"
}
```
```

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

### POST /LoginLink/Create Login Link

Source: https://docs.postalytics.com/getting-started/quick-start

Creates a login link.

```APIDOC
## POST /LoginLink/Create Login Link

### Description
Creates a login link.

### Method
POST

### Endpoint
/LoginLink/Create Login Link

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
- **email** (string) - Required - User's email address

### Request Example
{
  "email": "user@example.com"
}

### Response
#### Success Response (200)
- **loginLink** (string) - The login link

#### Response Example
{
  "loginLink": "https://app.postalytics.com/login-link/abcdefg"
}
```

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

### POST /Campaign/Create New Campaign

Source: https://docs.postalytics.com/getting-started/quick-start

Creates a new campaign. This endpoint allows for the creation of marketing campaigns.

```APIDOC
## POST /Campaign/Create New Campaign

### Description
Creates a new campaign.

### Method
POST

### Endpoint
/Campaign/Create New Campaign

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
- **name** (string) - Required - Campaign name
- **templateId** (integer) - Required - Template ID
- **contactListId** (integer) - Required - Contact List ID

### Request Example
{
  "name": "New Campaign",
  "templateId": 1,
  "contactListId": 2
}

### Response
#### Success Response (200)
- **campaignId** (integer) - The ID of the created campaign

#### Response Example
{
  "campaignId": 910
}
```

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

### Get Suppression List Contacts API Request (Shell)

Source: https://docs.postalytics.com/references/postalytics-rest-api/get-suppression-list-contacts

This example demonstrates how to make a GET request to retrieve all contacts from a specified suppression list using cURL. It includes the necessary URL, request method, and authorization header. The response includes contact details and list information.

```shell
curl --request GET \
  --url 'https://api-dev.postalytics.com/api/v1/lists/suppression/contacts/123?offset=123' \
  --header 'Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQ='

```

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

### Get Contacts On List (cURL)

Source: https://docs.postalytics.com/references/postalytics-rest-api/get-contacts-on-list

Retrieves all contacts associated with a specific list ID. The request supports limiting the number of returned records and specifying a starting row. The maximum limit for records is 100.

```shell
curl --request GET \
  --url 'https://api-dev.postalytics.com/api/v1/contacts/123?limit=123&start=123' \
  --header 'Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQ='

```

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

### GET /Account/Get My Account

Source: https://docs.postalytics.com/getting-started/quick-start

Fetches the details of the currently authenticated account. Use this to retrieve information specific to the logged-in user or account.

```APIDOC
## GET /Account/Get My Account

### Description
Fetches the details of the currently authenticated account.

### Method
GET

### Endpoint
/Account/Get My Account

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
N/A

### Response
#### Success Response (200)
- **accountDetails** (object) - Account details

#### Response Example
{
  "accountDetails": {
    "id": 123,
    "name": "Example Account",
    "email": "test@example.com"
  }
}
```

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

### GET /api/v1/templates/{id}

Source: https://docs.postalytics.com/references/postalytics-rest-api/get-template

Gets details for a specified template by its ID.

```APIDOC
## GET /api/v1/templates/{id}

### Description
Gets details for a specified template.

### Method
GET

### Endpoint
/api/v1/templates/{id}

### Parameters
#### Path Parameters
- **id** (integer) - Required - Id of the template to retrieve

### Request Example
```
curl --request GET \
  --url https://api-dev.postalytics.com/api/v1/templates/123 \
  --header 'Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQ='
```

### Response
#### Success Response (200)
- **back** (string) - URL for the back image.
- **count** (integer) - Count related to the template.
- **created_date** (string) - The date the template was created (ISO 8601 format).
- **font_family** (string) - The font family used in the template.
- **front** (string) - URL for the front image.
- **html** (string) - The full HTML content of the template.
- **is_double_sided** (boolean) - Indicates if the template is double-sided.
- **is_full_html** (boolean) - Indicates if the template is fully HTML.
- **is_proofed** (boolean) - Indicates if the template has been proofed.
- **name** (string) - The name of the template.
- **size** (string) - The size of the template.
- **template_id** (integer) - The unique identifier for the template.
- **thumbnail** (string) - URL for the front thumbnail.
- **thumbnail_back** (string) - URL for the back thumbnail.

#### Response Example
```json
[
  {
    "back": "https://some.url.com/back.jpg",
    "count": 2,
    "created_date": "1999-02-19T12:00:00.00:00",
    "font_family": "sans-serif",
    "front": "https://some.url.com/front.jpg",
    "html": "full html here",
    "is_double_sided": false,
    "is_full_html": true,
    "is_proofed": true,
    "name": "The Architect",
    "size": "0",
    "template_id": 10142067,
    "thumbnail": "https://some.url.com/thumb_front.jpg",
    "thumbnail_back": "https://some.url.com/thumb_back.jpg"
  }
]
```
```

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

### POST /SuppressionList/Create Suppression List

Source: https://docs.postalytics.com/getting-started/quick-start

Creates a new suppression list.

```APIDOC
## POST /SuppressionList/Create Suppression List

```

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

### POST /Contact/Create Contact On List

Source: https://docs.postalytics.com/getting-started/quick-start

Adds a new contact to a specific contact list.

```APIDOC
## POST /Contact/Create Contact On List

### Description
Adds a new contact to a specific contact list.

### Method
POST

### Endpoint
/Contact/Create Contact On List

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
- **contactListId** (integer) - Required - The ID of the contact list
- **email** (string) - Required - Contact's email address
- **firstName** (string) - Optional - Contact's first name
- **lastName** (string) - Optional - Contact's last name

### Request Example
{
  "contactListId": 345,
  "email": "newcontact@example.com",
  "firstName": "Jane"
}

### Response
#### Success Response (200)
- **contactId** (integer) - The ID of the created contact

#### Response Example
{
  "contactId": 567
}
```

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

### GET /api/flow

Source: https://docs.postalytics.com/what-is-the-postalytics-direct-mail-api

Retrieves a specific flow's details. This allows for getting details about automated flows.

```APIDOC
## GET /api/flow

### Description
Retrieves a specific flow.

### Method
GET

### Endpoint
/api/flow

### Parameters
No parameters.

### Request Example
N/A

### Response
#### Success Response (200)
- **flow** (object) - Flow details.

#### Response Example
{
  "flow": {
    "id": 121,
    "name": "My Flow",
    "status": "Active"
  }
}

```

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

### POST /api/campaign

Source: https://docs.postalytics.com/index

Creates a new campaign. This allows you to launch new direct mail campaigns programmatically.

```APIDOC
## POST /api/campaign

### Description
Creates a new campaign.

### Method
POST

### Endpoint
/api/campaign

### Parameters
#### Request Body
- **name** (string) - Required - The name of the campaign.
- **templateId** (string) - Required - The ID of the template to use.

### Request Example
{
  "name": "New Campaign",
  "templateId": "template_id"
}

### Response
#### Success Response (201)
- **campaign** (object) - The newly created campaign details.

#### Response Example
{
  "campaign": {
    "id": "new_campaign_id",
    "name": "New Campaign",
    "status": "draft"
  }
}
```

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

### Unenroll Contact from Flow API Example (Shell)

Source: https://docs.postalytics.com/references/postalytics-rest-api/unenroll-contact-from-flow

This example demonstrates how to unenroll a contact from a flow using a DELETE request. It requires the `dataId` of the contact and the `endPoint` of the flow. The response includes the date the contact was unenrolled.

```shell
curl --request DELETE \
  --url https://api-dev.postalytics.com/api/v1/flow/unenroll/string/123 \
  --header 'Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQ='

```

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

### POST /Flow/Enroll Contact To Flow

Source: https://docs.postalytics.com/getting-started/quick-start

Enrolls a contact to a flow.

```APIDOC
## POST /Flow/Enroll Contact To Flow

### Description
Enrolls a contact to a flow.

### Method
POST

### Endpoint
/Flow/Enroll Contact To Flow

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
- **flowId** (integer) - Required - The ID of the flow
- **contactId** (integer) - Required - The ID of the contact

### Request Example
{
  "flowId": 678,
  "contactId": 456
}

### Response
#### Success Response (200)
- **message** (string) - Success message

#### Response Example
{
  "message": "Contact enrolled to flow successfully"
}
```

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

### GET /Campaign/Get All Drip Campaigns

Source: https://docs.postalytics.com/getting-started/quick-start

Retrieves a list of all drip campaigns associated with the account.

```APIDOC
## GET /Campaign/Get All Drip Campaigns

### Description
Retrieves a list of all drip campaigns associated with the account.

### Method
GET

### Endpoint
/Campaign/Get All Drip Campaigns

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
N/A

### Response
#### Success Response (200)
- **campaigns** (array) - List of drip campaigns

#### Response Example
{
  "campaigns": [
    {
      "id": 789,
      "name": "Example Drip Campaign"
    }
  ]
}
```

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

### GET /api/flow/getAllFlows

Source: https://docs.postalytics.com/references/postalytics-rest-api/get-suppression-list-contact

Retrieves all flows.

```APIDOC
## GET /api/flow/getAllFlows

### Description
Retrieves all flows.

### Method
GET

### Endpoint
/api/flow/getAllFlows

### Parameters
N/A

### Request Example
```json
{
  "example": "N/A"
}
```

### Response
#### Success Response (200)
- **Response Body** (array) - Contains a list of flows

#### Response Example
```json
{
  "example": "N/A"
}
```
```

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

### POST /api/campaign/createNewCampaign

Source: https://docs.postalytics.com/references/postalytics-rest-api/get-suppression-list-contact

Creates a new campaign.

```APIDOC
## POST /api/campaign/createNewCampaign

### Description
Creates a new campaign.

### Method
POST

### Endpoint
/api/campaign/createNewCampaign

### Parameters
N/A

### Request Example
```json
{
  "example": "N/A"
}
```

### Response
#### Success Response (200)
- **Response Body** (object) - Indicates success

#### Response Example
```json
{
  "example": "N/A"
}
```
```

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

### GET /Contact/Get Contact

Source: https://docs.postalytics.com/getting-started/quick-start

Retrieves a specific contact by ID.

```APIDOC
## GET /Contact/Get Contact

### Description
Retrieves a specific contact by ID.

### Method
GET

### Endpoint
/Contact/Get Contact

### Parameters
#### Path Parameters
None

#### Query Parameters
- **contactId** (integer) - Required - The ID of the contact

#### Request Body
None

### Request Example
N/A

### Response
#### Success Response (200)
- **contact** (object) - Contact details

#### Response Example
{
  "contact": {
    "id": 456,
    "email": "contact@example.com",
    "firstName": "John"
  }
}
```

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

### GET /Account/Get Integrations

Source: https://docs.postalytics.com/getting-started/quick-start

Retrieves integrations associated with the account. This endpoint allows you to access information about existing integrations.

```APIDOC
## GET /Account/Get Integrations

### Description
Retrieves integrations associated with the account.

### Method
GET

### Endpoint
/Account/Get Integrations

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
N/A

### Response
#### Success Response (200)
- **integrations** (array) - List of integrations

#### Response Example
{
  "integrations": [
    {
      "id": 123,
      "name": "Example Integration"
    }
  ]
}
```

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

### GET /Campaign/Get Contact Event

Source: https://docs.postalytics.com/getting-started/quick-start

Retrieves a contact event.

```APIDOC
## GET /Campaign/Get Contact Event

### Description
Retrieves a contact event.

### Method
GET

### Endpoint
/Campaign/Get Contact Event

### Parameters
#### Path Parameters
None

#### Query Parameters
- **contactEventId** (integer) - Required - The ID of the contact event

#### Request Body
None

### Request Example
N/A

### Response
#### Success Response (200)
- **event** (object) - Contact event details

#### Response Example
{
  "event": {
    "id": 123,
    "type": "open"
  }
}
```

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

### Postalytics Website Creation

Source: https://docs.postalytics.com/references/postalytics-rest-api/create-template

This endpoint allows for the creation of a new website project within Postalytics. It requires a detailed JSON payload specifying various attributes of the website, and returns a confirmation with essential identifiers.

```APIDOC
## POST /websites/postalytics

### Description
Creates a new website project with specified details.

### Method
POST

### Endpoint
/websites/postalytics

### Parameters
#### Request Body
- **back** (string) - Optional - URL for the back image.
- **count** (integer) - Optional - Number of items.
- **created_date** (string) - Optional - Creation date in ISO 8601 format.
- **font_family** (string) - Optional - Font family to use.
- **front** (string) - Optional - URL for the front image.
- **html** (string) - Optional - Full HTML content.
- **is_double_sided** (boolean) - Optional - Whether the item is double-sided.
- **is_full_html** (boolean) - Optional - Whether the content is full HTML.
- **is_proofed** (boolean) - Optional - Whether the item is proofed.
- **name** (string) - Required - Name of the website project.
- **size** (string) - Optional - Size identifier.
- **template_id** (integer) - Required - ID of the template to use.
- **thumbnail** (string) - Optional - URL for the front thumbnail.
- **thumbnail_back** (string) - Optional - URL for the back thumbnail.

### Request Example
```json
{
  "back": "https://some.url.com/back.jpg",
  "count": 2,
  "created_date": "1999-02-19T12:00:00.00:00",
  "font_family": "sans-serif",
  "front": "https://some.url.com/front.jpg",
  "html": "full html here",
  "is_double_sided": false,
  "is_full_html": true,
  "is_proofed": true,
  "name": "The Architect",
  "size": "0",
  "template_id": 10142067,
  "thumbnail": "https://some.url.com/thumb_front.jpg",
  "thumbnail_back": "https://some.url.com/thumb_back.jpg"
}
```

### Response
#### Success Response (200)
- **CreatedDate** (string) - The date the resource was created.
- **TemplateId** (integer) - The ID of the template used.

#### Response Example
```json
{
  "CreatedDate": "1999-02-19T12:00:00.00:00",
  "TemplateId": 10142067
}
```
```

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

### POST /api/contact/list/{listId}

Source: https://docs.postalytics.com/index

Creates a new contact on a specific list. This allows you to add contacts to your lists.

```APIDOC
## POST /api/contact/list/{listId}

### Description
Creates a new contact on a specific list.

### Method
POST

### Endpoint
/api/contact/list/{listId}

### Parameters
#### Path Parameters
- **listId** (string) - Required - The ID of the contact list.
#### Request Body
- **firstName** (string) - Optional - The first name of the contact.
- **lastName** (string) - Optional - The last name of the contact.
- **email** (string) - Optional - The email of the contact.

### Request Example
{
  "firstName": "John",
  "lastName": "Doe",
  "email": "john.doe@example.com"
}

### Response
#### Success Response (201)
- **contact** (object) - The newly created contact.

#### Response Example
{
  "contact": {
    "id": "new_contact_id",
    "firstName": "John",
    "lastName": "Doe",
    "email": "john.doe@example.com"
  }
}
```

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

### GET /api/suppressionlist/getSuppressionLists

Source: https://docs.postalytics.com/references/postalytics-rest-api/get-suppression-list-contact

Retrieves suppression lists.

```APIDOC
## GET /api/suppressionlist/getSuppressionLists

### Description
Retrieves suppression lists.

### Method
GET

### Endpoint
/api/suppressionlist/getSuppressionLists

### Parameters
N/A

### Request Example
```json
{
  "example": "N/A"
}
```

### Response
#### Success Response (200)
- **Response Body** (array) - Contains a list of suppression lists

#### Response Example
```json
{
  "example": "N/A"
}
```
```

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

### GET /api/flow/getFlow

Source: https://docs.postalytics.com/references/postalytics-rest-api/get-suppression-list-contact

Retrieves a specific flow.

```APIDOC
## GET /api/flow/getFlow

### Description
Retrieves a specific flow.

### Method
GET

### Endpoint
/api/flow/getFlow

### Parameters
N/A

### Request Example
```json
{
  "example": "N/A"
}
```

### Response
#### Success Response (200)
- **Response Body** (object) - Contains flow details

#### Response Example
```json
{
  "example": "N/A"
}
```
```

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

### GET /api/contact/getContact

Source: https://docs.postalytics.com/references/postalytics-rest-api/get-suppression-list-contact

Retrieves a specific contact.

```APIDOC
## GET /api/contact/getContact

### Description
Retrieves a specific contact.

### Method
GET

### Endpoint
/api/contact/getContact

### Parameters
N/A

### Request Example
```json
{
  "example": "N/A"
}
```

### Response
#### Success Response (200)
- **Response Body** (object) - Contains contact details

#### Response Example
```json
{
  "example": "N/A"
}
```
```

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

### GET /api/account

Source: https://docs.postalytics.com/index

Retrieves account details. This endpoint provides access to the account's configuration and settings.

```APIDOC
## GET /api/account

### Description
Retrieves account details.

### Method
GET

### Endpoint
/api/account

### Parameters
No parameters required.

### Request Example
N/A

### Response
#### Success Response (200)
- **account** (object) - Account details.

#### Response Example
{
  "account": {
    "id": "account_id",
    "name": "Account Name",
    "status": "active"
  }
}
```
Tokens:
Raw