pr_create_contact

pr_create_contact

Description

API call to create a new contact.

Access

Update, master access required, available to internal users with update access to the Contacts function (54)

Parameters

Number	Name	O/R	Usage
1	Auth	Required	Authentication structure.*
2	Values	Required	A structure consisting of field name as the key and the value of the field. All fields are optional and only those included will be updated.

*See call structure explanation.

2. Values fields:

Field	Description
first_name	First name
last_name	Last name of the contact
title_id	Id of the title to use. The rf_get_title call may be used to get a list of possible titles.
suffix_id	Id of the suffix to use. The rf_get_suffix call may be used to get a list of possible suffixes.
email	Email address
post_addr_line1	First line of the postal address
post_addr_line2	Second line of the postal address
post_addr_line3	Third line of the postal address
post_city	Postal address city
post_post_code	Postal address post code
post_country_id	Id of the postal address country. The rf_get_country call may be used to get a list of possible countries.
phys_addr_line1	First line of the physical address
phys_addr_line2	Second line of the physical address
phys_addr_line3	Third line of the physical address
phys_city	Physical address city
phys_post_code	Physical address post code
phys_country_id	Id of the physical address country. The rf_get_country call may be used to get a list of possible countries.
guest	An optional structure containing guest role information. If the structure is empty a default guest role will be created. If the structure is populated with field names as the key and values of each field this will be populated into the guest profile. Available fields, their types, and possible values are available using the rf_get_guest_field call. In addition the field “primary_yn” may be specified with 0=non primary and 1=primary.

Example

Requests

{
    "method": "pr_create_contact",
	"params": [
		"{{username}}",
		"{{password}}",
		"{{principal}}",
		{
			"first_name": "John",
			"last_name": "Doe"
		}
	],
	"id": null
}

Response

{
    "id": 0,
    "error": null,
    "result": "WB519"
}

pr_create_contact

Description

Access

Parameters

Example

Keep up to date with us

Menu

Visit our website

ResRequest Modules