--- title: "/Endpoint/rest/api/v1/Account" slug: "endpointrestapiv1account-4" updated: 2024-12-18T10:21:23Z published: 2024-12-18T10:21:23Z canonical: "docs.agilenow.io/endpointrestapiv1account-4" --- > ## Documentation Index > Fetch the complete documentation index at: https://docs.agilenow.io/llms.txt > Use this file to discover all available pages before exploring further. # /Endpoint/rest/api/v1/Account Patch/Endpoint/rest/api/v1/Account Use the `AccountData` object resource to insert or update (Upsert) `Account` using `Id, Username, ExternalId` field(s) value. You can supply the required field values in the request data, and then use the `POST` method of the resource. The input parameter must be used in the `AccountData` record structure inside the `FieldType` parameter in the foreign key fields. Foreign key fields are: `TenantId, LanguageId, TimezoneId, DateFormatId` ### Update a record of Account - If the `Id` field value is not matched, then a `404` error is reported (`Errors/Not Found`), and the error record is returned.. You cannot change `Id` field value (primary key). - If the `Username, ExternalId` field value is not empty and `Id` field value is empty, action try insert record according `Username, ExternalId` field value (if set, the value is a unique identifier). ### Create a new record of Account - If the value in the `Username, ExternalId` and `Id` fields are empty then action insert a new record according input parameter entity record structure (`AccountData`). The response body will contain the object of the updated or created record if the call is successful. Method returns an extended `Account` structure. Here, all foreign key fields are abstract object structures, utilizing `AbstractText` or `AbstractLong` data types, offering a detailed view of the data and related entities. SecurityOAuth oAuth autentication flow FlowClient Credentials Token URLhttps://dev.esystems.fi/oAuth/rest/v2/Token Refresh URLhttps://dev.esystems.fi/oAuth/rest/v2/Token Scopes:AccessManager:Create, UpdateAllows to edit access groups and all related data. (ABAC) permissions required to perform a function. AccessUser:Create, UpdateAllows to review access groups and all related data. (ABAC) permissions required to perform a function. Body parameters `Account` information to insert or update. The input parameter must be used in the `AccountData` record structure inside the `FieldType` parameter in the foreign key fields. object The record of Account information. Idstring The identifier of account. Namestring The name of the account. FirstNamestring Person's first name. LastNamestring Person's last name. Phonestring The phone number of account. The phone number is unique in the system. PhoneVerifiedboolean Indicates whether the phone number has been verified. DefaultfalseExampleFalse Emailstring The e-mail of account. The email is unique in the system. LanguageIdstring The enum of Language. Valid values[ "ar-ae", "bn-IN", "zh-CN", "da-dk", "en-US", "fo-fo", "fi-FI", "fr-FR", "de-DE", "hi-IN", "ja-JP", "ko-KR", "ms-MY", "pt-PT", "ru-RU", "es-ES", "sv-se", "tr-TR", "ur-IN" ] TimezoneIdstring The enum of Timezone. Valid values[ "Afghanistan Standard Time", "Alaskan Standard Time", "Arab Standard Time", "Arabian Standard Time", "Arabic Standard Time", "Argentina Standard Time", "Atlantic Standard Time", "AUS Central Standard Time", "AUS Eastern Standard Time", "Azerbaijan Standard Time", "Azores Standard Time", "Canada Central Standard Time", "Cape Verde Standard Time", "Caucasus Standard Time", "Cen. Australia Standard Time", "Central America Standard Time", "Central Asia Standard Time", "Central Brazilian Standard Time", "Central Europe Standard Time", "Central European Standard Time", "Central Pacific Standard Time", "Central Standard Time", "Central Standard Time (Mexico)", "China Standard Time", "Dateline Standard Time", "E. Africa Standard Time", "E. Australia Standard Time", "E. Europe Standard Time", "E. South America Standard Time", "Eastern Standard Time", "Egypt Standard Time", "Ekaterinburg Standard Time", "Fiji Standard Time", "FLE Standard Time", "Georgian Standard Time", "GMT Standard Time", "Greenland Standard Time", "Greenwich Standard Time", "GTB Standard Time", "Hawaiian Standard Time", "India Standard Time", "Iran Standard Time", "Israel Standard Time", "Jordan Standard Time", "Korea Standard Time", "Mauritius Standard Time", "Mid-Atlantic Standard Time", "Middle East Standard Time", "Montevideo Standard Time", "Morocco Standard Time", "Mountain Standard Time", "Mountain Standard Time (Mexico)", "Myanmar Standard Time", "N. Central Asia Standard Time", "Namibia Standard Time", "Nepal Standard Time", "New Zealand Standard Time", "Newfoundland Standard Time", "North Asia East Standard Time", "North Asia Standard Time", "Pacific SA Standard Time", "Pacific Standard Time", "Pacific Standard Time (Mexico)", "Pakistan Standard Time", "Romance Standard Time", "Russian Standard Time", "SA Eastern Standard Time", "SA Pacific Standard Time", "SA Western Standard Time", "Samoa Standard Time", "SE Asia Standard Time", "Singapore Standard Time", "South Africa Standard Time", "Sri Lanka Standard Time", "Taipei Standard Time", "Tasmania Standard Time", "Tokyo Standard Time", "Tonga Standard Time", "US Eastern Standard Time", "US Mountain Standard Time", "UTC", "Venezuela Standard Time", "Vladivostok Standard Time", "W. Australia Standard Time", "W. Central Africa Standard Time", "W. Europe Standard Time", "West Asia Standard Time", "West Pacific Standard Time", "Yakutsk Standard Time" ] DateFormatIdstring The enum of DateFormat. Valid values[ "DD-MM-YYYY", "DD/MM/YYYY", "DD.MM.YYYY", "MM-DD-YYYY", "MM/DD/YYYY", "YYYY-MM-DD", "YYYY/MM/DD" ] Usernamestring Username used to log in into the system. The username is unique in the system. The value must be unique in the system and you cannot add multiple values. ExternalIdstring External Authentication identifier. Example Azure AD guid. The value must be unique in the system and you cannot add multiple values. NotifyByEmailboolean Defines if a person should get notifications via e-mail. DefaultfalseExampleFalse NotifyBySMSboolean Defines if a contact should get notifications via SMS. DefaultfalseExampleFalse Is_Activeboolean Defines if the account is active and can be used. DefaultfalseExampleFalse Responses200 Inserted or updated `Account` information. Expand Allobject The record of Account information. Idstring The identifier of account TenantIdobject (AbstractLong) This structure represents an abstract object with a primary key of type Long. It is used to encapsulate detailed information about related entities. Idinteger (int64) The primary key of the record. It uniquely identifies each record within the dataset. This attribute is required and must be unique across all records. Default0Example1234567891234567 ExternalIdstring An external identifier for the record, which can be used to link the record to external systems or datasets. This attribute is optional but should be unique if provided. Example3ad64ab3-bd04-46c5-b1d7-c0b34be9e5b5 Namestring The name of the record. This attribute provides a human-readable identifier for the record, making it easier to recognize and differentiate records in lists or other displays. This attribute is optional. ExampleBob Normal Typestring The type of the record object. This attribute is used to classify the record into specific categories or types, helping to organize and manage different kinds of records. This attribute is optional. ExampleUser Namestring The name of the account FirstNamestring Person's first name LastNamestring Person's last name Phonestring The phone number of account. The phone number is unique in the system PhoneVerifiedboolean Indicates whether the phone number has been verified. DefaultfalseExampleFalse Emailstring The e-mail of account. The email is unique in the system EmailVerifiedboolean Indicates whether the email address has been verified. DefaultfalseExampleFalse LanguageIdobject (AbstractText) This structure represents an abstract object with a primary key of type Text. It is used to encapsulate detailed information about related entities. Idstring The primary key of the record. It uniquely identifies each record within the dataset. This attribute is required and must be unique across all records. Example3ad64ab3-bd04-46c5-b1d7-c0b34be9e5b5 ExternalIdstring An external identifier for the record, which can be used to link the record to external systems or datasets. This attribute is optional but should be unique if provided. Example3ad64ab3-bd04-46c5-b1d7-c0b34be9e5b5 Namestring The name of the record. This attribute provides a human-readable identifier for the record, making it easier to recognize and differentiate records in lists or other displays. This attribute is optional. ExampleBob Normal Typestring The type of the record object. This attribute is used to classify the record into specific categories or types, helping to organize and manage different kinds of records. This attribute is optional. ExampleUser TimezoneIdobject (AbstractText) This structure represents an abstract object with a primary key of type Text. It is used to encapsulate detailed information about related entities. Idstring The primary key of the record. It uniquely identifies each record within the dataset. This attribute is required and must be unique across all records. Example3ad64ab3-bd04-46c5-b1d7-c0b34be9e5b5 ExternalIdstring An external identifier for the record, which can be used to link the record to external systems or datasets. This attribute is optional but should be unique if provided. Example3ad64ab3-bd04-46c5-b1d7-c0b34be9e5b5 Namestring The name of the record. This attribute provides a human-readable identifier for the record, making it easier to recognize and differentiate records in lists or other displays. This attribute is optional. ExampleBob Normal Typestring The type of the record object. This attribute is used to classify the record into specific categories or types, helping to organize and manage different kinds of records. This attribute is optional. ExampleUser DateFormatIdobject (AbstractText) This structure represents an abstract object with a primary key of type Text. It is used to encapsulate detailed information about related entities. Idstring The primary key of the record. It uniquely identifies each record within the dataset. This attribute is required and must be unique across all records. Example3ad64ab3-bd04-46c5-b1d7-c0b34be9e5b5 ExternalIdstring An external identifier for the record, which can be used to link the record to external systems or datasets. This attribute is optional but should be unique if provided. Example3ad64ab3-bd04-46c5-b1d7-c0b34be9e5b5 Namestring The name of the record. This attribute provides a human-readable identifier for the record, making it easier to recognize and differentiate records in lists or other displays. This attribute is optional. ExampleBob Normal Typestring The type of the record object. This attribute is used to classify the record into specific categories or types, helping to organize and manage different kinds of records. This attribute is optional. ExampleUser Usernamestring Username used to log in into the system. The username is unique in the system ExternalIdstring External Authentication identifier. Example Azure AD guid NotifyByEmailboolean Defines if a person should get notifications via e-mail DefaultfalseExampleFalse NotifyBySMSboolean Defines if a contact should get notifications via SMS DefaultfalseExampleFalse Is_Activeboolean Defines if the account is active and can be used DefaultfalseExampleFalse ModifiedOnstring (date-time) The date the record was updated Default"1900-01-01T12:00:00Z"Example1900-01-01T12:00:00Z CreatedOnstring (date-time) The date the record was created Default"1900-01-01T12:00:00Z"Example1900-01-01T12:00:00Z 400 Bad Request - The user has provided input that the browser is unable to convert. ```json { "Errors": [ "The user has provided input that the browser is unable to convert.", "There are multiple rows in the database for the same value", "The value does not match the specified entity structure", "..." ], "Type": "/Errors/Bad Input", "Title": "Bad Request", "StatusCode": 400, "Instance": "/OpenApi/rest/Xzy", "RequestKey": "894ea43c-b8a6-4195-9a9c-82c07d9cc33a" } ``` object The list of errors. Throw specific exceptions based on the received error. Errors Array of string Human-readable explanation of the errors string Default"" Typestring URI identifier that categorizes the error Default"" Titlestring Brief, human-readable message about the error Default"" StatusCodeinteger (int32) The HTTP response code Example400 Instancestring URI that identifies the specific occurrence of the error Default"" RequestKeystring Provides a request key that identifies the current request. Default"" 401 Unauthorized - The response status code indicates that the client request has not been completed because it lacks valid authentication credentials for the requested resource. ```json { "Errors": [ "The session Id or OAuth token used has expired or is invalid." ], "Type": "/Errors/Unauthorized", "Title": "Unauthorized", "StatusCode": 401, "Instance": "/OpenApi/rest/Xzy", "RequestKey": "894ea43c-b8a6-4195-9a9c-82c07d9cc33a" } ``` object The list of errors. Throw specific exceptions based on the received error. Errors Array of string Human-readable explanation of the errors string Default"" Typestring URI identifier that categorizes the error Default"" Titlestring Brief, human-readable message about the error Default"" StatusCodeinteger (int32) The HTTP response code Example400 Instancestring URI that identifies the specific occurrence of the error Default"" RequestKeystring Provides a request key that identifies the current request. Default"" 403 Forbidden - The user does not have access to execute operation ```json { "Errors": [ "The user does not have access to execute operation" ], "Type": "/Errors/Permission", "Title": "Bad Request", "StatusCode": 403, "Instance": "/OpenApi/rest/Xzy", "RequestKey": "894ea43c-b8a6-4195-9a9c-82c07d9cc33a" } ``` object The list of errors. Throw specific exceptions based on the received error. Errors Array of string Human-readable explanation of the errors string Default"" Typestring URI identifier that categorizes the error Default"" Titlestring Brief, human-readable message about the error Default"" StatusCodeinteger (int32) The HTTP response code Example400 Instancestring URI that identifies the specific occurrence of the error Default"" RequestKeystring Provides a request key that identifies the current request. Default"" 500 Internal Server Error - An internal server error is an error on the web server you're trying to access. ```json { "Errors": [ "An internal server error is an error on the web server you're trying to access." ], "Type": "/Errors/Internal Server Error", "Title": "Internal Server Error", "StatusCode": 500, "Instance": "/OpenApi/rest/Xzy", "RequestKey": "894ea43c-b8a6-4195-9a9c-82c07d9cc33a" } ``` object The list of errors. Throw specific exceptions based on the received error. Errors Array of string Human-readable explanation of the errors string Default"" Typestring URI identifier that categorizes the error Default"" Titlestring Brief, human-readable message about the error Default"" StatusCodeinteger (int32) The HTTP response code Example400 Instancestring URI that identifies the specific occurrence of the error Default"" RequestKeystring Provides a request key that identifies the current request. Default""