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

yes

Integer

No = 0, Yes = 1

Is this Contact in the Directory?

contact_types

yes

String

CONTACT_TYPE Lists

Toggle cloak

Cloak

Insert excerpt

	API
	API
nopanel	true

What Type(s) of Contact is this? Example: "USER,CUSTOMER"

status

yes

Integer

STATUS_TYPE Lists

Toggle cloak

Cloak

Insert excerpt

	API
	API
nopanel	true

Stats of the Contact (Active/Inactive).

type

no

String

EMAIL, ADDRESS, PHONE, REMARKS, UDFS

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 Lists

Toggle cloak

Cloak

Insert excerpt

	API
	API
nopanel	true

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

yes

Integer

No = 0, Yes = 1

Is this the Primary Phone Number?

phone_type

yes

String

PHONE_TYPE Lists

Toggle cloak

Cloak

Insert excerpt

	API
	API
nopanel	true

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	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

...

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

...

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

...

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>
}

Remarks

Remarks can be added to Contacts.

Requires "type = REMARKS"

Available Fields

Field	Required	Data Type	Options	Default	Notes
contact_recid	yes	Integer			RECID of the Contact
remarks	yes	String			The remark to add to the Contact

Call:

Code Block

language	php

POST DOMAIN/KEY/contact.json

Headers:

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

Body:

Key	Value
type	REMARKS
contact_recid	1
remarks	This is the Demo Account

Results

If the request is successful, the RECID of the Remark record will be returned as follows:

Toggle cloak

Cloak

Code Block

language	xml
linenumbers	true

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

Image Added

Contact UDFs

User Defined Fields can be easily set for a Contact. To get a list of available UDFs for each Contact, visit Lists.

Requires "type = UDFS"

Available Fields

Field	Required	Data Type	Notes
contact_recid	Yes	Integer	The RECID of the Contact that the UDF is for
udf_UDF-RECID	Yes*	Integer	UDF-RECID is the RECID of the UDF to assign the value to. Example: udf_684=value See Note Below
udf_UDF-IDENTIFIER	Yes*	Mixed	IDENTIFIER is the unique Identifier of the UDF to assign the value to. Example: udf_LEGACYNUM=value See Note Below

udf_UDF-RECID and udf_UDF-IDENTIFIER are Conditionally Required. The use of one is Required, but not both.

Call:

Code Block

language	php

POST DOMAIN/KEY/contacts.json

Headers:

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

Body:

Key	Value
type	UDFS
contact_recid	1
udf_UDF-RECID1	0000
udf_UDF-IDENTIFIER2	test

Results

If the request is successful, the RECID(s) of the new Contact UDF records will be returned in the same order as provided:

Toggle cloak

Cloak

Code Block

language	xml
linenumbers	true

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

Manage Contacts User Defined Fields Tab Example Image Added

Locating Contact Data

To locate contact data navigate to Main > People > Workers / Contacts, to view the Workers / Contacts Grid.

...

Versions Compared

Old Version 30

New Version 31

Key

Body:

Body:

Body:

Remarks

Available Fields

Call:

Headers:

Body:

Results

Contact UDFs

Call:

Headers:

Body:

Results

Locating Contact Data