Use this endpoint to void an agent. Use this operation when the agent is duplicated or no longer in use.
curl --location --request POST 'https://caas.digicert.com/automationws/v1/agent/void' \
--header 'X-DC-DEVKEY: {{api_key}}' \
--header 'Content-Type: application/json' \
--data-raw '{
"accountId": 5153184,
"reason": "No longer in use",
"identifiers": [
"C4518024C883BB79"
],
"divisionIds": [
"677793"
]
}'{
"error": null,
"data": "Agent updated successfully"
}| Name | Req/Opt | Type | Description |
|---|---|---|---|
| accountId | required | string | Account ID. |
| reason | optional | string | Reason for voiding the agent. |
| identifiers | required | array | License keys associated with the agents. |
| divisionIds | required | array | Division IDs. |
| Name | Type | Description |
|---|---|---|
| error | object |
Object with error details, if any. Note: Returns null if there are no errors.
|
| data | object | Message with information about the request. |
| .. data | object | Object with details about the voided agent details. |
| .. .. id | string | License key of the voided agent. |
| .. .. message | string | Message with information about the request. |