Person update request (Object)

action

Value: Delete

string, Mandatory

cid

The company ID of the person. You need to specify this value.

int, Mandatory

pid, login, email

Use any of these three properties to uniquely identify the person to delete. The system will select in this order of priority: pid, then login, then email.

• pid: The unique person ID. An integer.

• login: The login of the person. This only works if the person actually was assigned a login in the first place.

• email: The email of the person. Please note that Wordbee does not enforce unique emails!

Examples:

{ "pid": 1000 }
or
{ "login": "john.hauser" }
or
{ "email": "john@hauser.me" }

int?, string?, string?

Mandatory

data

An optional free-text information. It will be returned with the results for your convenience.

string, Optional

action

Value: Create

string, Mandatory

cid

The company ID of the person. You need to specify this value.

int, Mandatory

email

The mandatory email.

string, Mandatory

login

An optional login. Only specify if you want this user to be able to login. Note that no password will be assigned at this stage.

string?, Optional

fname

First name.

string, Mandatory

lname

Last name.

string, Mandatory

title

Optional title of person, such as “Dr.”, “Mrs.” etc.

string?, Optional

role

Optional role of the person, such as “Manager”.

string?, Optional

code

Optional name abbreviation.

If not specified, the system automatically picks the initial letters of first and last name. “John Good” => “JG”

string?, Optional

phone

Optional phone number.

string?, Optional

phoneMobile

Optional mobile phone number.

string?, Optional

comments

Optional internal comments.

string?, Optional

timezone

Optional time zone. If not specified then the person inherits the time zone of the company to which he/she is attached (recommended).

To enumerate available time zones see: settings/timezones/codes

string?, Optional

cfs

Optional person-level custom fields. It contains a collection of custom fields. Example:

"cfs": [
  { "id": 10, "t": "myvalue" },
  { "t": "My field", "t": "myvalue" }
]

You can reference custom fields by their numeric ID (see id) or their title (see t). The example above shows both approaches.

• Configure custom fields online at Settings > Custom fields > Persons (Creating and updating Custom Fields )

• Enumerate custom fields using the API: Custom field configuration

object?, Optional

active

Optional boolean. If you want the person to be able to login, you should:

• Set active to true.

• Set a login.

• Optionally, set a profile.

bool?, Optional

profile

Optional integer. Use to assign a specific user profile.

If the new person has a login and is active, it is recommended to explicitly assign a user profile. If you do not do so then the system will automatically assign a user profile on your behalf. This will typically be the first profile in alphabetical order.

See User profiles to enumerate available profiles.

integer?, Optional

data

An optional free-text information. It will be returned with the results for your convenience.

string?, Optional

action

Value: Change

string, Mandatory

cid

The company ID of the person. You need to specify this value.

int, Mandatory

pid, login, email

Use any of these three properties to uniquely identify the person to delete. The system will select in this order of priority: pid, then login, then email.

• pid: The unique person ID. An integer.

• login: The login of the person. This only works if the person actually was assigned a login in the first place.

• email: The email of the person. Please note that Wordbee does not enforce unique emails!

Examples:

{ "pid": 1000 }
or
{ "login": "john.hauser" }
or
{ "email": "john@hauser.me" }

int?, string?, string?

Mandatory

*

Specify the properties that you want to change. These are those document further above for creating persons.

Optional

data

An optional free-text information. It will be returned with the results for your convenience.

string?, Optional

action

Value: ChangeOrCreate

string, Mandatory

cid

The company ID of the person. You need to specify this value.

int, Mandatory

pid, login, email

Specify any one of the three identifiers below:

• pid: Only specify if you have the person’s unique ID on records.

• login: To find back a person by login or create a person with this login

• email: To find back a person by email or create a person with this email.

If the system cannot find back the person with the identifiers above, it will proceed with the creation of a new person.

int?, string?, string?

Mandatory

*

Specify the other properties.

Important: All properties that are mandatory when creating persons must be specified.

Some mandatory,

Some optional

data

An optional free-text information. It will be returned with the results for your convenience.

string?, Optional

action

Value: Skip

string, Mandatory

data

The company ID of the person. You need to specify this value.

int, Mandatory

data

An optional free-text information. It will be returned with the results for your convenience.

string?, Optional