Skip to content

Get a custom action

Returns the full definition of a single custom action, looked up by its code. The shape always matches detail=true from GET /custom-actions.

Request

FieldValue
MethodGET
URLhttps://next.telecrm.in/autoupdate/v2/enterprise/{enterpriseId}/custom-actions/{code}
AuthBearer token (Sync-typed). See Authentication.

Path parameters

NameTypeRequiredDescription
enterpriseIdstringyesThe enterprise (workspace) ID.
codestringyesCustom action code (e.g. ACTION_1001). Case-sensitive.

Example request

bash
curl "https://next.telecrm.in/autoupdate/v2/enterprise/{enterpriseId}/custom-actions/ACTION_1001" \
  -H "Authorization: Bearer YOUR_SYNC_TOKEN"

Responses

200 OK

json
{
  "id": "5f8a1b2c3d4e5f6a7b8c9d10",
  "code": "ACTION_1001",
  "displayName": "Site Visit",
  "icon": "map-pin",
  "description": "Recorded after a sales rep visits the lead",
  "score": 10,
  "fieldSchema": {
    "note": { "type": "TEXT" },
    "outcome": { "type": "DROPDOWN", "options": ["Interested", "Not Interested"] }
  },
  "displaySchema": {},
  "allowPredatedActivity": { "enabled": true },
  "quickAdd": {},
  "definitionType": "USER_DEFINED",
  "createdOn": 1609459200000,
  "createdBy": "admin@example.com",
  "modifiedOn": 1609459200000,
  "modifiedBy": "admin@example.com",
  "source": "USER"
}

401 Unauthorized

See the universal 401 in the overview.

404 Not Found

json
{
  "error": {
    "code": "NOT_FOUND",
    "message": "Custom action with code ACTION_1001 was not found."
  }
}

Notes

  • The path parameter takes the full ACTION_<numeric> form, even though Sync action payloads use just the numeric portion.
  • Use fieldSchema to discover which custom fields the action accepts and their types — every key in the schema is a valid fields.<key> entry on a create-action request.