Update Contact details

This operation will update existing contact's details.

SecuritybearerAuth
Request
path Parameters
contactId
required
string

This is the unique identifier of the contact to be updated. The contactId is generated at the time of contact creation.

Example: 6763e149671f04cace818d76
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
200

Contact has been updated 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.

put/api/v1/contact/{contactId}
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
{ }