7x Developer Portal & API Documentation

Updates an existing renewal agent record, including identity and attachment details. Keeps agent information synchronized before approval and payment processing.

Request builder

PUT

/api/v1/Renewal/UpdateAgent

api-versionstring

*object

agentId*integer

mobileNostring

array<object>

emiratesIdstring

emirateCodestring

idExpiryDatestring

agentFullNameEnstring

agentFullNameArstring

emailIdstring

Reference details

Query Parameters

api-version?string

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

`application/json`

curl -X PUT "https://example.com/api/v1/Renewal/UpdateAgent" \  -H "Content-Type: application/json" \  -d '{    "agentId": 0  }'

{  "isSuccess": true,  "responseMessage": "string",  "responseCode": 0,  "errorDetail": {    "httpStatusCode": "string",    "poBoxErrorCode": "string",    "displayMessage": "string"  },  "orderNumber": "string",  "paymentGateWayResponse": {    "paymentUrl": "string",    "referenceNumber": "string",    "niOrderResult": null,    "savedCardResponse": null  }}

{  "type": "string",  "title": "string",  "status": 0,  "detail": "string",  "instance": "string",  "errors": {    "property1": [      "string"    ],    "property2": [      "string"    ]  },  "property1": null,  "property2": null}

{  "type": "string",  "title": "string",  "status": 0,  "detail": "string",  "instance": "string",  "property1": null,  "property2": null}

{  "type": "string",  "title": "string",  "status": 0,  "detail": "string",  "instance": "string",  "property1": null,  "property2": null}

Overview

Updates an existing renewal agent record, including identity and attachment details. Keeps agent information synchronized before approval and payment processing.

Request builder

PUT

/api/v1/Renewal/UpdateAgent

api-versionstring

*object

agentId*integer

mobileNostring

array<object>

emiratesIdstring

emirateCodestring

idExpiryDatestring

agentFullNameEnstring

agentFullNameArstring

emailIdstring

Reference details

Query Parameters

api-version?string

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

agentId*integer

Formatint32

mobileNo?string

attachments?array<>

emiratesId?string

emirateCode?string

idExpiryDate?string

Formatdate-time

agentFullNameEn?string

agentFullNameAr?string

emailId?string

Response Body

`application/json`

curl -X PUT "https://example.com/api/v1/Renewal/UpdateAgent" \  -H "Content-Type: application/json" \  -d '{    "agentId": 0  }'

{  "isSuccess": true,  "responseMessage": "string",  "responseCode": 0,  "errorDetail": {    "httpStatusCode": "string",    "poBoxErrorCode": "string",    "displayMessage": "string"  },  "orderNumber": "string",  "paymentGateWayResponse": {    "paymentUrl": "string",    "referenceNumber": "string",    "niOrderResult": null,    "savedCardResponse": null  }}

{  "type": "string",  "title": "string",  "status": 0,  "detail": "string",  "instance": "string",  "errors": {    "property1": [      "string"    ],    "property2": [      "string"    ]  },  "property1": null,  "property2": null}

{  "type": "string",  "title": "string",  "status": 0,  "detail": "string",  "instance": "string",  "property1": null,  "property2": null}

{  "type": "string",  "title": "string",  "status": 0,  "detail": "string",  "instance": "string",  "property1": null,  "property2": null}

agentId*integer

Formatint32

mobileNo?string

attachments?array<>

emiratesId?string

emirateCode?string

idExpiryDate?string

Formatdate-time

agentFullNameEn?string

agentFullNameAr?string

emailId?string

Query Parameters

Request Body

Response Body

200application/json

400application/json

404application/json

500application/json

Query Parameters

Request Body

Response Body

200application/json

400application/json

404application/json

500application/json

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`