7x Developer Portal & API Documentation

Processes CRM approval or rejection for a pending agent profile linked to a PO Box. Captures approval remarks and updates downstream status used by renewal/rental journeys.

Request builder

POST

/api/v1/CRM/ApproveAgent

api-versionstring

*object

agentId*integer

remarksstring

approvalStatus*string

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 POST "https://example.com/api/v1/CRM/ApproveAgent" \  -H "Content-Type: application/json" \  -d '{    "agentId": 0,    "approvalStatus": "Approved"  }'

{  "message": "string",  "payload": [    {      "bundle_Id": "string",      "name_En": "string",      "name_Ar": "string",      "bundle_Price": "string",      "bundle24Month_Price": "string",      "bundle36Month_Price": "string",      "bundle60Month_Price": "string",      "bundle120Month_Price": "string",      "desc_En": "string",      "desc_Ar": "string",      "short_Desc_En": "string",      "short_Desc_Ar": "string",      "features_En": "string",      "features_Ar": "string"    }  ],  "responseCode": "Continue",  "errorDetails": {    "property1": null,    "property2": null  }}

{  "message": "string",  "payload": null,  "responseCode": "Continue",  "errorDetails": {    "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

Processes CRM approval or rejection for a pending agent profile linked to a PO Box. Captures approval remarks and updates downstream status used by renewal/rental journeys.

Request builder

POST

/api/v1/CRM/ApproveAgent

api-versionstring

*object

agentId*integer

remarksstring

approvalStatus*string

Reference details

Query Parameters

api-version?string

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

agentId*integer

Formatint32

remarks?string

approvalStatus*CRMApprovalStatus

Value in

"Approved"
"Rejected"

Response Body

`application/json`

curl -X POST "https://example.com/api/v1/CRM/ApproveAgent" \  -H "Content-Type: application/json" \  -d '{    "agentId": 0,    "approvalStatus": "Approved"  }'

{  "message": "string",  "payload": [    {      "bundle_Id": "string",      "name_En": "string",      "name_Ar": "string",      "bundle_Price": "string",      "bundle24Month_Price": "string",      "bundle36Month_Price": "string",      "bundle60Month_Price": "string",      "bundle120Month_Price": "string",      "desc_En": "string",      "desc_Ar": "string",      "short_Desc_En": "string",      "short_Desc_Ar": "string",      "features_En": "string",      "features_Ar": "string"    }  ],  "responseCode": "Continue",  "errorDetails": {    "property1": null,    "property2": null  }}

{  "message": "string",  "payload": null,  "responseCode": "Continue",  "errorDetails": {    "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

remarks?string

approvalStatus*CRMApprovalStatus

Value in

"Approved"
"Rejected"

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`