v1

latestOpenAPI 3.0.12026-07-243124341009.5 KB

Contacts

Update a Contact

Updates information about the specified contact

put/v1/contact/{contactId}

Path parameters

contactIdstring required

Headers

RequestIdstring uuid

The unique request identifier used to correlate request data with log entries and events, formatted as a UUID.

Unique request identifier (UUID) used to correlate request data with log entries and events.

FrontOfficeTenantIdinteger

An integer identifier for the tenant that the request is being made for. Required when Tenant header is not provided.

Tenantstring

Tenant company code that determines data access scope during the request. Required when FrontOfficeTenantId header is not provided.

Request body

idinteger

The identifier for the contact.

firstNamestring required

The contact's first name.

middleNamestring

The contact's middle name.

lastNamestring required

The contact's last name.

workPhonestring

The contact's work phone.

cellPhonestring

The contact's cell phone.

emailAddressstring required

The contact's email address.

address1string

The contact's address, line 1.

address2string

The contact's address, line 2.

citystring

The contact's city.

statestring

The contact's state/province.

postalCodestring

The contact's ZIP/postal code.

countrystring

The contact's country.

linkstring

URL to the contact profile.

companyNamestring

The name of the company.

companyIdinteger

The identifier for the company.

companyDepartmentIdinteger

The identifier for the company department.

titlestring

The contact's title within the organization.

emailOptOutboolean

An indication of whether the contact has opted out of receiving emails from Avionté BOLD or not.

isArchivedboolean

An indication of whether the contact record is archived or not.

createdDatestring date-time

The date the contact profile was created.

statusstring

The contact's status.

originstring

The partner or vendor that originated the request.

representativeUsersinteger[]

The ID of the representative who is working with the contact.

Response

The updated contact details.