Update Invitation

Updates the status of the delegate invitation sent by a specified user. The Update Invitation API allows the logged-in user to accept or reject the delegate invitation sent by the user {id}.

Resource Information

Scopeusers

Deprecated scope name:   update_citizenaccess_citizens_invitation

App TypeCitizen
Authorization TypeAccess token
URI /v4/citizenaccess/citizens/invitation/{id}?lang={lang}
HTTP MethodPUT
Automation Version(s)7.3.3.5

Request Information

Field or ParameterTypeRequiredValuesDescriptionAutomation Version
idstringYes The unique identifier for the object, assigned by the Civic Platform server and provided in a response.7.3.3.5
langStringNo Indicates the language applied.7.3.3.5
delegateStatusstringNoACCEPT | REJECTThe status of the delegate request.7.3.3.5

Example

Sample Request Head

PUT https://apis.accela.com/v4/citizenaccess/citizens/invitation/8774

Sample Request Body

{
  "delegateStatus": "ACCEPT"
}

Notes

In the example, the logged-in user accepts the delegate invitation sent by the user whose id = 8774 (apiextuser1@accela.com) as shown in the Get All Invitations example. Note that in the Create Delegates example, the logged-in user whose id = 8774 (apiextuser1@accela.com) sent the delegate invitation to id=8775 (apiextuser2@accela.com).

Response Information

FieldTypeDescriptionAutomation Version
resultresult{} 7.3.3.5
result.delegateStatusstringThe status of the delegate request.7.3.3.5
result.idlongThe id of the user who sent the delegate request.7.3.3.5
statusintegerThe record status.7.3.3.5

Example

Sample Response Body

{
  "status": 200,
  "result": {
    "id": "8774",
    "delegateStatus": "ACCEPT"
  }
}