PUT - /admin/tenant/profile/

General Information


ServiceAPIMethodData ModelsWorkflow
multitenant/admin/tenant/profile/PUTTenantN/A

Description

This API updates the profile of the tenant record that has an id that matches the one sent in the query.

Input


Type: application/json
NameSourceMandatoryTypeSpecial FormatDescription
idQueryYESStringN/ATenant ID
profileBodyYESObjectN/ATenant Profile Object

Output


Response

SOAJS has a unified response. Check out this link to understand more the schema of SOAJS response 

Valid Response

Valid Response Sample
{ 
  result: true,
  data: true
}

Invalid Response

Error Response Sample
{
    "result":false,
    "errors":{
        "codes":[602],
        "details":[
            {
                "code":602,
                "message":"Model error: + %model_error%"
            }
        ]
    }
}

Response schema

Follow this link to check out the response JSON Schema

SOAJS Error Codes


Code
Description
400

Business logic required data are missing

450

Unable to find tenant

471

Unable to update tenant

500

You cannot modify or delete a locked record

602Model error: + %model_error%