PUT /api/v202211/account/customAction

Fires a custom account action webhook for one or more accounts

ProcessAccountCustomActionV202211 Permissions: Accounts (Edit)
Use this endpoint to trigger a configured webhook-based custom action on a set of accounts. Custom account actions are configured as webhooks in the system. All specified account IDs must be within the authenticated user’s topmost node or the request fails. Returns the webhook execution log details, or 204 if no account IDs were provided.

Request Headers

Header Value Required Description
ECI-ApiKey string Yes Your API key. See Authentication.
Content-Type application/json Yes All requests must specify JSON content type, including the request body.

Request Body

WebhookCustomAction
Property Description Type
ids The list of ids on which to perform the custom action Cannot be Empty Required (defined) integer[]
webhookId The webhook identifier that represents the custom action Required integer (int32)
Example Request Body application/json 
{  "ids": [
    1
  ],  "webhookId": 1
}

Responses

200 OK The request succeeded and the response body contains the requested data.

Response Body Parameters

WebhookLogDetailsResponse
Property Description Type
request The request that was sent from the webhook (headers and body) Required (defined) string
response The response that was received from the configured url (headers and body) Required (defined) string
result The HTTP status code that was received from the configured url 0 indicates no response was received from the configured url Required (defined) string
url The URL that the webhook is configured for Required (defined) string
user UserChild
UserChild properties
Property Description Type
fullName The user’s full name string
userCode The user code string
userId The user identifier integer (int32)
Example Response application/json 
{  "request": "string",  "response": "string",  "result": "string",  "url": "string",  "user": {    "fullName": "string",    "userCode": "string",    "userId": 1
  }
}
204 No Content The request succeeded. No content is returned in the response body.