SOAP API method Profile_createContact
Description
The newly created contact is marked as 'not done'. The method return a contact object. Use this object to set the other members.
Parameters
Name | Type | Description |
---|---|---|
id * | int | Unique identifier (id) of the object Profile. The method only applies to the profile with this id. |
timestamp | string | The timestamp for the historic profile |
user * | Structure of type 'user' | The user on which the contact needs to be created |
contacttype * | Structure of type 'contacttype' | Type of contact |
done * | boolean | Is the contact marked as 'done'? |
login | Structure of type 'login' | Optional login data (soon deprecated) |
access_token | string | Optional api access token |
* required parameters |
Return values
Name | Type | Description |
---|---|---|
contact | Structure of type 'contact' |
Structure 'user'
Name | Type | Description |
---|---|---|
id | int | The ID of the user. |
created | timestamp | The timestamp when the user is created. |
end | timestamp | The timestamp when the user is ended. |
gender | string | The gender of the user. |
name | string | The name of the user. |
description | string | The description of the user. |
string | The email address of the user. | |
phone | string | The phone number of the user. |
sms | string | The sms number of the user. |
fax | string | The fax number of the user. |
applicationadmin | boolean | Returns if the user is application admin. |
accountadmin | boolean | Returns if the user is account admin. |
styleadmin | boolean | Returns if the user is style admin. |
dummy | boolean | Returns if the user is a dummy user. |
apiaccess | boolean | Returns if the user has access to the API. |
uiacess | boolean | Returns if the user has access to the user interface. |
disabled | boolean | Is this user disabled?. |
active | boolean | Is this user active? |
receivenews | boolean | Will this user receive the news?. |
language | string | The prefered language of the user. |
timezone | string | Get the timezone for the user. If no timezone is set an empty string is returned. |
unsecure | boolean | Is this an insecure user?. |
Structure 'contacttype'
Name | Type | Description |
---|---|---|
id | int | This ID of the contact type |
name | string | Name of the contact type |
description | string | The description of the contact type |
icon | string | The icon of the contact type |
Structure 'login'
Name | Type | Description |
---|---|---|
username | string | The username of the login attempt |
account | string | The account name of the login attempt |
password | string | The password for the login attempt |
Structure 'contact'
Name | Type | Description |
---|---|---|
id | int | The ID of the contact. |
plannedtime | timestamp | The timestamp for which the contact is or was scheduled. |
executedtime | timestamp | The timestamp when the contact was scheduled. |
remarks | ContactData | The remarks of the contact. |
report | ContactData | The report of the contact. |
important | boolean | Is this a very important contact?. |
extra | string | The extra data of the contact. |
subject | string | Set a subject of the contact report |