Skip to content
Shared APIs
/
/Contact

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.

Operations

Create Contact

Request

This operaion add a new Contact in the Address book.

Security
bearerAuth
Headers
X-PB-Developer-Partner-IDstring

The Developer Partner ID is assigned by Pitney Bowes to uniquely identify a Developer's strategic business partners. If the developer is the sole business partner, this field isn't required.

Bodyapplication/jsonrequired
personnelIdstring

A unique identifier for the contact to be created/updated. One personnelId can be associated with only one contact. If not set, the personnelId will default to null.

Example:"12RT345"
typestring

This is the type of contact:

  • S: Shared contact created at the subscription level and accessible to all users within the subscription.
  • U: Contact created at the user level and private to that user only.
  • Default is subscription.
Enum:"S""U"
Example:"S"
contactTypestring

The type of contact to be created/updated.

  • RECIPIENT: The contact is a recipient.
  • SENDER: The contact is a sender.
  • ALL: The contact can be both sender and recipient.
Enum:"RECIPIENT""SENDER""ALL"
Example:"RECIPIENT"
namestring

The name of the contact to be created/updated.

Example:"ContactTrans_101"
companystring

The company name associated with the contact to be created/updated.

Example:"Pitney Bowes"
addressesArray of objects

A list of address for the contact to be created/updated.

emailobject

The email details of the contact.

additionalEmailIdsArray of strings

A list of additional email addresses for the contact.

Example:
[
  "testemail@yopmail.com.com"
]
phoneobject

The phone details of the contact.

customFieldsArray of objects

custom fields associated with the contact.

otherNamesArray of strings

A list of other names associated with the contact.

Example:
[
  "testotherNames1"
]
internalDeliveryobject

Internal package delivery preferences within the organization.

notificationobject

Notification preferences for the contact.

curl -i -X POST \
  https://api-sandbox.sendpro360.pitneybowes.com/addressbookmgmt/api/v1/contact \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -H 'X-PB-Developer-Partner-ID: string' \
  -d '{
    "personnelId": "12RT345",
    "type": "S",
    "contactType": "RECIPIENT",
    "name": "ContactTrans_101",
    "company": "Pitney Bowes",
    "addresses": [
      {
        "label": "Home",
        "residential": false,
        "addressLine1": "27 Waterview Dr",
        "addressLine2": "near abc street",
        "city": "Shelton",
        "state": "CT",
        "postalCode": "06484-4361",
        "countryCode": "US",
        "default": true
      }
    ],
    "email": {
      "label": "Home",
      "email": "testuser@yopmail.com"
    },
    "additionalEmailIds": [
      "testemail@yopmail.com.com"
    ],
    "phone": {
      "label": "Home",
      "phone": "2037963184",
      "isdCode": "string"
    },
    "customFields": [
      {
        "customFieldId": "xxx",
        "value": "123"
      }
    ],
    "otherNames": [
      "testotherNames1"
    ],
    "internalDelivery": {
      "enabledInternalDelivery": true,
      "mailStopId": "4a0e2Bbshdh",
      "officeLocationId": "4a0e2Bb4Njw"
    },
    "notification": {
      "enabledEmailNotification": true,
      "enabledSMSNotification": false,
      "enabledAccessibilityAccommodations": false
    }
  }'

Responses

The Contact has been added successfully.

Bodyapplication/json
string

The unique identifier for the newly added contact, used as contactId in other APIs.

Response
"6763e149671f04cace818d76"