# Address Book APIs

The Address Book APIs provide operations to manage address book data used across shipping and contact management workflows.
The address book acts as a reusable data source for storing sender, recipient, and organizational contact information. Instead of entering the same details repeatedly in shipment or communication workflows, contact records can be created once and referenced later.
**Contact**- An address book record containing personal or business contact details such as name, company, email, phone, and address information
**Department**- An organizational grouping used to manage and retrieve department-level contact associations


Version: 1.0.0

## Servers

```
https://api-dev.sendpro360.pitneycloud.com/addressbookmgmt
```

```
https://api-qa.sendpro360.pitneycloud.com/addressbookmgmt
```

Sandbox Server
```
https://api-sandbox.sendpro360.pitneybowes.com/addressbookmgmt
```

Production Server (uses live data)
```
https://api.sendpro360.pitneybowes.com/addressbookmgmt
```

## Security

### bearerAuth

Type: http
Scheme: bearer

## Download OpenAPI description

[Address Book APIs](https://docs.sendpro360.pitneycloud.com/_bundle/openapi/addressbook.yaml)

## Contact

APIs for managing contact records in the address book. They are used to maintain reusable sender, recipient, and business contact information for downstream workflows.

### Create Contact

 - [POST /api/v1/contact](https://docs.sendpro360.pitneycloud.com/openapi/addressbook/contact/addcontact.md): This operaion add a new Contact in the Address book.

### Get Contact by contactID

 - [GET /api/v1/contact/{contactId}](https://docs.sendpro360.pitneycloud.com/openapi/addressbook/contact/getcontact.md): This API retrieves the details of a contact using the unique contactId. The contactId is generated when the contact is created.

### Update Contact details

 - [PUT /api/v1/contact/{contactId}](https://docs.sendpro360.pitneycloud.com/openapi/addressbook/contact/updatecontact.md): This operation will update existing contact's details.

### Update specific fields of Contact

 - [PATCH /api/v1/contact/{contactId}](https://docs.sendpro360.pitneycloud.com/openapi/addressbook/contact/updatespecificcontactfield.md): This operation updates specific fields of contact.Only the fields that need to be updated should be provided in the request. All other fields of the existing address will remain unchanged.

### Delete contact

 - [DELETE /api/v1/contact/{contactId}](https://docs.sendpro360.pitneycloud.com/openapi/addressbook/contact/deletecontact.md): This operation deletes an existing Contact from the address book using its contactId.

### Get Contact list or Search Contact

 - [GET /api/v1/contact/search](https://docs.sendpro360.pitneycloud.com/openapi/addressbook/contact/searchcontact.md): This operation retrieves a list of contacts or searches for specific contacts based on the provided filters.

## Department

APIs for retrieving department records and their associated contacts. They are used to organize and access address book data at a department level for operational and administrative workflows.

### Get Department list

 - [GET /api/v1/departments](https://docs.sendpro360.pitneycloud.com/openapi/addressbook/department/getdepartments.md): This operation retrieves all the departments. (For now, departments can only be created from the UI.)

### Get Contact list for a Department

 - [GET /api/v1/departments/{departmentId}/contacts](https://docs.sendpro360.pitneycloud.com/openapi/addressbook/department/getdepartmentcontacts.md): This operation retrieves all the contacts of the specified department