Create Contact

This operaion add a new Contact in the Address book.

SecuritybearerAuth
Request
header Parameters
X-PB-Developer-Partner-ID
string

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.

Request Body schema: application/json
personalId
string

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

type
string

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"
contactType
string

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"
name
string

The name of the contact to be created/updated.

company
string

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

Array of objects

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

object

The email details of the contact.

additionalEmailIds
Array of strings

A list of additional email addresses for the contact.

object

The phone details of the contact.

Array of objects

custom fields associated with the contact.

otherNames
Array of strings

A list of other names associated with the contact.

object

Internal package delivery preferences within the organization.

object

Notification preferences for the contact.

Responses
201

The Contact has been added successfully.

400

Invalid request.

401

The request could not be authorized.

404

The requested resource was not found.

500

The request could not be completed due to an internal error.

post/api/v1/contact
Request samples
application/json
{
  • "personalId": "12RT345",
  • "type": "S",
  • "contactType": "RECIPIENT",
  • "name": "ContactTrans_101",
  • "company": "Pitney Bowes",
  • "addresses": [
    ],
  • "email": {
    },
  • "additionalEmailIds": [
    ],
  • "phone": {
    },
  • "customFields": [
    ],
  • "otherNames": [
    ],
  • "internalDelivery": {
    },
  • "notification": {
    }
}
Response samples
application/json
"6763e149671f04cace818d76"