Getting StartedAPI Reference
API Reference

Executes the Add action for the Firm Contacts data object.

post
https://{apiHost}/connect/v1/direct/subscribers//vista/pm/2/data/firm_contacts/actions/add

Adds a new PM firm contact record in Vista PM Firm Contacts.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

The code of the subscriber that you are making this request for.

Body Params

Schema for adding a new PM firm contact record.

integer
required

The group code assigned to the firm/vendor.

integer
required

The unique identifying number for the firm.

integer
required

The unique code for the specific contact.

string
required
length ≤ 15

Short name used for sorting.

string
required
length ≤ 30

Contact's last name.

string
required
length ≤ 30

Contact's first name.

string | null

Contact's middle initial.

string | null

Job title of the contact.

string | null

Primary phone number.

string | null

Phone extension.

string | null

Mobile phone number.

string | null

Fax number.

string | null

Contact email address

string
required
length ≤ 1

Preferred contact method.

string | null

General notes for the contact.

string | null
[0-9a-fA-F]{8}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{12}

Unique identifier for attachments.

string
enum
required

Exclude from lists flag.

Allowed:
string | null

Mailing address line 1.

string | null

Mailing city.

string | null

Mailing state.

string | null

Mailing zip code.

string | null

Mailing address line 2.

string
enum
required

Portal access permission flag.

Allowed:
string | null

Username for portal access.

string | null

Country code.

__custom_fields
object

Vista custom fields defined for PMPM in Vista.

Headers
string
required

Used to authorize access to the Direct API.

Responses

401

You have not provided a proper X-Application-Key in the header of this request.

403

The X-Application-Key provided is valid but the key does not have access to this resource.

404

The object with the given ID was not found OR a subscriber with the given URL was not found.

Updated about 3 hours ago

Language
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated about 3 hours ago