| Table of Contents | ||||
|---|---|---|---|---|
|
Non-LDAP Contacts can be easily updated or added to the system with the API. This endpoint acts similarly to the Contacts Import for Primary Email and Primary Phone.
Below is the proper format for making a separate request.
Contact End point
| Code Block | ||
|---|---|---|
| ||
http://DOMAIN/api/API_KEY/contact.OUTPUT |
Available Fields
...
Field
...
Required
...
Data Type
...
Options
...
Default
...
Notes
...
department
...
customer_number
...
first_name
...
contact_directory
...
address_directory
...
First Line of the Address.
*If any Address fields are sent, all become Required
...
City the Address is in.
*If any Address fields are sent, all become Required
...
State the Address is in. Use standard 2 Letter Abbreviation.
*If any Address fields are sent, all become Required
...
5 digit Postal Code assigned to the Address.
*If any Address fields are sent, all become Required
...
Email Request
In addition to the main Contact fields, additional fields are available for creating or updating Email Information.
- Requires "type = EMAIL"
Available Fields
...
Field
...
Required
...
Data Type
...
Options
...
Default
...
Notes
...
Call:
| Code Block | ||
|---|---|---|
| ||
POST DOMAIN/KEY/contact.json |
Headers:
...
Key
...
Value
...
Content-Type
...
application/json
...
Pcr-Html-Encoded
...
TRUE
Body:
...
Key
...
Value
...
type
...
...
...
help@pcr.com
...
| Cloak | |||||||
|---|---|---|---|---|---|---|---|
If the request is successful, the RECID of the Contact is returned as follows:
|
Address Request
In addition to the main Contact fields, additional fields are available for creating or updating Address Information.
- Requires "type = ADDRESS"
Available Fields
...
Field
...
Required
...
Data Type
...
Options
...
Default
...
Notes
...
address_directory
...
First Line of the Address.
*See Note below
...
City the Address is in.
*See Note below
...
State the Address is in. Use standard 2 Letter Abbreviation.
*See Note below
...
5 digit Postal Code assigned to the Address.
*See Note below
- Note: If any Address fields are sent, all become Required
...
Call:
| Code Block | ||
|---|---|---|
| ||
POST DOMAIN/KEY/contact.json |
Headers:
...
Key
...
Value
...
Content-Type
...
application/json
...
Pcr-Html-Encoded
...
TRUE
Body:
...
Key
...
Value
...
type
...
ADDRESS
...
address_directory
...
0
...
| Cloak | |||||||
|---|---|---|---|---|---|---|---|
If the request is successful, the RECID of the Contact is returned as follows:
|
Phone Request
In addition to the main Contact fields, additional fields are available for creating or updating Phone Information.
- Requires "type = PHONE"
Available Fields
...
Field
...
Required
...
Data Type
...
Options
...
Default
...
Notes
...
Call:
| Code Block | ||
|---|---|---|
| ||
POST DOMAIN/KEY/contact.json |
Headers:
...
Key
...
Value
...
Content-Type
...
application/json
...
Pcr-Html-Encoded
...
TRUE
Body:
...
Key
...
Value
...
type
...
PHONE
...
phone_directory
...
0
...
| Cloak | |||||||
|---|---|---|---|---|---|---|---|
If the request is successful, the RECID of the Contact is returned as follows:
|
Locating Contact Data
To locate contact data navigate to Main > People > Workers / Contacts, to view the Workers / Contacts Grid.
All grids have the option to show the ROW ID column, which is also the RECID for that particular record.
| Child pages (Children Display) | ||||
|---|---|---|---|---|
|