Page Comparison

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" }

Note: If you would want to use a person custom field as the unique identifier then set the cfid field when updating, see persons/io/updates (POST) . Although we recommend to use the login or email as unique identifiers, nothing beats the flexibility of Wordbee!

int?, string?, string?

Mandatory

profile

To assign or change a user profile ID. This is only required for users that are assigned a login.

int?, Optional

profileKeepExisting

If true then the user profile ID of an existing person will not be modified.

This can be useful if the profile was changed inside Wordbee Translator, and an update request shall not tamper with such a change.

bool?, Optional

*

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.

Note: If you would want to use a person custom field as the unique identifier then set the cfid field when updating, see persons/io/updates (POST) . Although we recommend to use the login or email as unique identifiers, nothing beats the flexibility of Wordbee!

int?, string?, string?

Mandatory

profile

To assign or change a user profile ID. This is only required for users that are assigned a login.

int?, Optional

profileKeepExisting

If true then the user profile ID of an existing person will not be modified.

This can be useful if the profile was changed inside Wordbee Translator, and an update request shall not tamper with such a change.

bool?, Optional

*

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