Page Comparison

Table of Contents

outline	true
style	none

...

Field	Required	Data Type	Options	Default	Notes
department	no	Integer			Department RECID that the Contact is assigned to.
customer_number	no*	Integer			Customer Number assigned to the Contact. Conditionally Required if Contact is a CUSTOMER type
first_name	yes	String			Contact's First Name.
last_name	yes	String			Contact's Last Name.
contact_directory	noyes	Integer	No = 0, Yes = 1		Is this Contact in the Directory?
contact_types	noyes	StringContact Types	CONTACT_TYPE List		What Type(s) of Contact is this? Example: "USER,CUSTOMER"
status	yes	Integer	STATUS_TYPE List		Stats of the Contact (Active/Inactive).
type	no	String	EMAIL, ADDRESS, PHONE		What type of Contact information is being provided?
email_directory	yes	Integer	No = 0, Yes = 1		Should this Email show in the Directory.
email	yes	String			New Primary Email for the Contact.
address_directory	no	Integer	No = 0, Yes = 1		Is this Address in the Directory?
address_type	no	string	ADDRESS_TYPE TYPE List		What Type of Address is it?
street_address	no*	String			First Line of the Address. If any Address fields are sent, all become Required*
address2	no	String			Second Line of the Address.
city	no*	String			City the Address is in. If any Address fields are sent, all become Required*
state	no*	String			State the Address is in. Use standard 2 Letter Abbreviation. If any Address fields are sent, all become Required*
zip_code	no*	Integer			5 digit Postal Code assigned to the Address. If any Address fields are sent, all become Required*
phone_directory	yes	Integer	No = 0, Yes = 1		Should this Phone Number show in the Directory.
phone_primary	noyes	Integer	No = 0, Yes = 1	1		Is this the Primary Phone Number?
phone_type	yes	String	PHONE_TYPE TYPE List		What Type of Phone Number is this.?
phone_number	yes	Integer			Phone Number for the Contact.

List Types
Anchor
lists
lists

Type	Description	Values
STATUS_TYPE	Available Status Types	1 = ACTIVE, 0 = INACTIVE
CONTACT_TYPE	Available Contact Types	USER, CUSTOMER, COORDINATOR, WORKER, SERVICE REP, VENDOR, VIP, GUEST
ADDRESS_TYPE	Available Address Types	OFFICE, WAREHOUSE, BILLING
PHONE_TYPE	Available Phone Number Types	WORK, HOME, CELL, FAX

Email Request

In addition to the main Contact fields, additional fields are available for creating or updating Email Information.

...

Field	Required	Data Type	Options	Notes
contact_recid	yes	Integer		RECID for the Contact
email_directory	yes	Integer	No = 0, Yes = 1	Should this Email show in the Directory.
email	yes	String		New Primary Email for the Contact.

...

Key	Value
Content-Type	application/json
Pcr-Html-Encoded	TRUE

Body:

Key	Value
type	EMAIL
email	help@pcr.com
email_directory	0
contact_Directory	1
first_name	PCR
last_name	SysAdmin
contact_types	USER
status	1
contact_recid	1

Results

Toggle cloak

Cloak

If the request is successful, the RECID of the Contact is returned as follows:

Code Block

language	php
linenumbers	true

{
    <status>success</status>
    <page>1</page>
    <count>1</count>
    <total_count>1</total_count>
    <contact>199017</contact>
}

...

Field	Required	Data Type	Options	Notes
contact_recid	yes	Integer		RECID for the Contact
address_directory	no	Integer	No = 0, Yes = 1	Is this Address in the Directory?
address_type	no	string	ADDRESS_TYPE List	What Type of Address is it?
street_address	no*	String		First Line of the Address. *See Note below
address2	no	String		Second Line of the Address.
city	no*	String		City the Address is in. *See Note below
state	no*	String		State the Address is in. Use standard 2 Letter Abbreviation. *See Note below
zip_code	no*	Integer		5 digit Postal Code assigned to the Address. *See Note below

...

Key	Value
Content-Type	application/json
Pcr-Html-Encoded	TRUE

Body:

Key	Value
type	ADDRESS
address_directory	0
address_type	Warehouse
street_address	1313 Mockingbird Lane
city	Mockingbird Heights
state	CA
zip_code	55555
contact_Directory	1
first_name	PCR
last_name	SysAdmin
contact_types	USER
status	1
contact_recid	1

Results

Toggle cloak

Cloak

If the request is successful, the RECID of the Contact is returned as follows:

Code Block

language	php
linenumbers	true

{
    <status>success</status>
    <page>1</page>
    <count>1</count>
    <total_count>1</total_count>
    <contact>199017</contact>
}

...

Field	Required	Data Type	Options	Default	Notes
contact_recid	yes	Integer			RECID for the Contact
phone_directory	yes	Integer	No = 0, Yes = 1		Should this Phone Number show in the Directory.
phone_primary	no	Integer	No = 0, Yes = 1	1	Is this the Primary Phone Number?
phone_type	yes	String	PHONE_TYPE List		What Type of Phone Number is this.
phone_number	yes	Integer			Phone Number for the Contact.

...

Key	Value
Content-Type	application/json
Pcr-Html-Encoded	TRUE

Body:

Key	Value
type	PHONE
phone_directory	0
phone_primary	0
phone_type	Work
phone_number	5558675309
contact_Directory	1
first_name	PCR
last_name	SysAdmin
contact_types	USER
status	1
contact_recid	1

Results

Toggle cloak

Cloak

If the request is successful, the RECID of the Contact is returned as follows:

Code Block

language	php
linenumbers	true

{
    <status>success</status>
    <page>1</page>
    <count>1</count>
    <total_count>1</total_count>
    <contact>199017</contact>
}

...

Versions Compared

Old Version 14

New Version 15

Key

List Types
Anchor
lists
lists

Email Request

Body:

Results
Toggle cloak

Body:

Results
Toggle cloak

Body:

Results
Toggle cloak

Page Comparison

Versions Compared

Old Version 14

New Version 15

Key

List Types Anchorlistslists

Email Request

Body:

Results Toggle cloak

Body:

Results Toggle cloak

Body:

Results Toggle cloak

List Types
Anchor
lists
lists

Results
Toggle cloak

Results
Toggle cloak

Results
Toggle cloak