Create Delegates

Creates the specified delegate users. The Create Delegates API allows the logged-in user to send delegate requests to one or more users, as specified in the request array. The specified userNames must be valid citizen users. The logged-in user cannot send more than one delegate request to the same userName. For each new delegate, the delegateStatus is set to PENDING. The citizen user receiving the delegate request will need to accept the delegate request (via Update Invitation API) to enable the assigned permissions. If the citizen user rejects the invitation (via Update Invitation API) , the permissions will not take effect; the delegate record remains until it is deleted by the Delete Delegates API.

Resource Information

Scope	users Deprecated scope name: create_citizenaccess_citizens_delegates
App Type	Citizen
Authorization Type	Access token
URI	/v4/citizenaccess/citizens/delegates?lang={lang}
HTTP Method	POST
Automation Version(s)	7.3.3.5.0

Request Information

Field or Parameter	Type	Required	Values	Description	Automation Version
lang	String	No	�	Indicates the language applied.	7.3.3.5
invitationMessage	string	No	�	The invitation message sent to the delegate.	7.3.3.5
name	string	Yes	�	The delegate's nick name.	7.3.3.5
permissions[]	permissions{}	No	�	Contains delegate permission attributes.	7.3.3.5
permissions.amendAllowed	boolean	No	true \| false	If true, the delegate is allowed to amend records.	7.3.3.5
permissions.createRecordAllowed	boolean	No	true \| false	If true, the delegate is allowed to create records.	7.3.3.5
permissions.documentAllowed	boolean	No	true \| false	If true, the delegate is allowed to manage documents.	7.3.3.5
permissions.inspectionAllowed	boolean	No	true \| false	If true, the delegate is allowed to manage inspections.	7.3.3.5
permissions.level	string	No	MODULE \| AGENCY \| RECORD_TYPE	The permission level.	7.3.3.5
permissions.levelValue	string	No	�	The value for the permission level, as configured in Automation.	7.3.3.5
permissions.paymentAllowed	boolean	No	true \| false	If true, the delegate is allowed to make payments.	7.3.3.5
permissions.renewalAllowed	boolean	No	true \| false	If true, the delegate is allowed to renew records.	7.3.3.5
permissions.viewRecordAllowed	boolean	No	true \| false	If true, the delegate is allowed to view records.	7.3.3.5
userName	string	Yes	�	The delegate's login name.	7.3.3.5

Example

Sample Request Head

POST https://apis.accela.com/v4/citizenaccess/citizens/delegates

Sample Request Body

[
  {
    "userName": "apiextuser2@accela.com",
    "name": "testdelegate",
    "invitationMessage": "You are invited.",
    "permissions": [
      {
        "level": "MODULE",
        "levelValue": "Building",
        "viewRecordAllowed": "true",
        "createRecordAllowed": "false",
        "renewalAllowed": "false",
        "inspectionAllowed": "false",
        "documentAllowed": "false",
        "paymentAllowed": "false",
        "amendAllowed": "false"
      }
    ]
  }
]

Response Information

Field	Type	Description	Automation Version
result	result{}	�	7.3.3.5
result.code	string	A code identifying an associated item	7.3.3.5
result.id	string	The unique identifier for the object, assigned by the Civic Platform server and provided in a response.	7.3.3.5
result.isSuccess	boolean	Indicates whether or not the operation on the item is successful.	7.3.3.5
result.message	string	A text message related to the operation.	7.3.3.5
status	integer	The record status.	7.3.3.5

Example

Sample Response Body

{
  "status": 200,
  "result": [
    {
      "id": "8775",
      "code": "Success",
      "message": "apiextuser2@accela.com",
      "isSuccess": true
    }
  ]
}