Page Comparison

Versions Compared

Key

This line was added.
This line was removed.
Formatting was changed.

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

Tip
Available from CRM.COM R14.0.0 Deprecated from CRM.COM R18.0.0

Excerpt
This method creates a User based on an existing user template. A single user is returned by each call. Users are created in an ACTIVE state

Resource URL

Parameters

Name

Type

Description

token

String

The token retrieved from the login method

user_template_identifier

(mandatory)

User Template Identifier

The user's template. The allowed user template identifier fields are the following:

Include Page

	V4:user_template_identifier
	V4:user_template_identifier

username

(mandatory)

String

The user's username

password

(mandatory)

String

The user's password

password_confirmation

(mandatory)

String

The user's password confirmation

first_name

(mandatory)

String

The user's first name

last_name

(mandatory)

String

The user's last name

email

(optional)

String

The user's email

ip_address

(optional)

String

The user's IP address

cti_phone_extension_number

(mandatory on conditions)

String

The extension number of the phone device of this user and only if the user's account is CTI enabled

udf_string_1

(optional)

String

User Defined Field of type String

udf_string_2

(optional)

String

User Defined Field of type String

udf_string_3

(optional)

String

User Defined Field of type String

udf_string_4

(optional)

String

User Defined Field of type String

udf_string_5

(optional)

String

User Defined Field of type String

udf_string_6

(optional)

String

User Defined Field of type String

udf_string_7

(optional)

String

User Defined Field of type String

udf_string_8

(optional)

String

User Defined Field of type String

udf_float_1

(optional)

Float

User Defined Field of type Float

udf_float_2

(optional)

Float

User Defined Field of type Float

udf_float_3

(optional)

Float

User Defined Field of type Float

udf_float_4

(optional)

Float

User Defined Field of type Float

udf_date_1

(optional)

Date

User Defined Field of type Date

udf_date_2

(optional)

Date

User Defined Field of type Date

udf_date_3

(optional)

Date

User Defined Field of type Date

udf_date_4

(optional)

Date

User Defined Field of type Date

fields_set

(optional)

List of Strings, comma separated

A list of fields that should be included in the results. If not specified then all the available fields will be returned

Restrictions

It is mandatory to specify one of the semi-optional parameters. Only one of those parameters is allowed to be specified.

...

Expand

title	Example 1

HTTP Method: POST

Request

Body

Code Block

language	javascript
theme	Confluence	language	javascript
linenumbers	true

 {
	"token": {{token}},
	"user_template_identifier": {
		"name": "Lebanese Template"
	},
	"username": "testuser-01",
	"password": "crm.com",
	"password_confirmation": "crm.com",
	"first_name": "Test",
	"last_name": "API User",
	"email": "testuser01@test.com",
	"ip_address": "",
	"udf_string_1": "User Field 1",
	"udf_float_2": 200.22,
	"udf_date_3": "2018-01-23T00:00:00"
}

Response

Code Block

language	javascript
theme	Confluence	language	javascript
linenumbers	true

 {
    "data": {
        "log_information": {
            "created_by_unit": {
                "alternative_code": "adminunit",
                "group_name": "Main Group",
                "community_name": "Community",
                "name": "Admin Unit",
                "description": "admin unit",
                "id": "1"
            },
            "updated_by_unit": {
                "alternative_code": "adminunit",
                "group_name": "Main Group",
                "community_name": "Community",
                "name": "Admin Unit",
                "description": "admin unit",
                "id": "1"
            },
            "created_date": "2018-01-23T09:50:01",
            "updated_date": "2018-01-23T09:50:01",
            "updated_by_user": {
                "person_name": "CRM COM",
                "id": "1",
                "username": "MPAdministrator"
            },
            "created_by_user": {
                "person_name": "CRM COM",
                "id": "1",
                "username": "MPAdministrator"
            }
        },
        "contact_information": {
            "company_profile": null,
            "company_name": null,
            "name": "Test API User",
            "last_name": "API User",
            "id": "9A7BD4C374654AB8B5E1DF8F4F490866",
            "life_cycle_state": "MARKETING",
            "middle_name": null,
            "title": null,
            "type": "PERSON",
            "first_name": "Test",
            "demographics": {
                "name_day": {
                    "month": null,
                    "day": null
                },
                "id_number": null,
                "gender": null,
                "country_of_residence": {
                    "alternative_code": "LBN",
                    "three_character_code": null,
                    "name": "LEBANON",
                    "id": "23",
                    "two_character_code": null
                },
                "date_of_birth": {
                    "month": null,
                    "year": null,
                    "day": null
                },
                "industry_sector": null,
                "passport_number": null,
                "industry": null,
                "social_security_number": null,
                "id_issued_by_country": null,
                "passport_issued_by_country": null
            }
        },
        "udf_date_2": null,
        "udf_date_1": null,
        "udf_date_4": null,
        "udf_date_3": "2018-01-23T00:00:00",
        "security_profile": {
            "name": "Customer Access",
            "description": "Customer Access",
            "id": "C887E42F669B4DFD84FAB48BB0D37DDE"
        },
        "udf_float_3": null,
        "udf_float_4": null,
        "cti_phone_extension_number": null,
        "super_user": false,
        "id": "028CEB50DD6B4CBC98DB2A7E20AC1F86",
        "udf_float_1": null,
        "udf_float_2": 200.22,
        "email": "testuser01@test.com",
        "udf_string_2": null,
        "udf_string_3": null,
        "udf_string_4": null,
        "udf_string_5": null,
        "udf_string_1": "User Field 1",
        "active": true,
        "person_name": "Test API User",
        "ip_address": "",
        "cti_enabled": false,
        "domain": "lebanon.com",
        "developer": true,
        "units_set": [
            {
                "default": true,
                "unit": {
                    "alternative_code": "adminunit",
                    "group_name": "Main Group",
                    "community_name": "Community",
                    "name": "Admin Unit",
                    "description": "admin unit",
                    "id": "1"
                },
                "id": "FE2A081346FD49379005FD81EDD3C031"
            }
        ],
        "udf_string_6": null,
        "udf_string_7": null,
        "udf_string_8": null,
        "username": "testuser-01"
    },
    "status": {
        "code": "OK",
        "description": "",
        "message": ""
    }
}