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",
  "description": "Recorded after a sales rep visits the lead",
  "score": 10,
  "fieldSchema": {
    "customFieldDefinitions": [
      {
        "type": "TEXT",
        "apiName": "note",
        "label": "Note",
        "isVisible": true,
        "isLeadid": false
      },
      {
        "type": "DROPDOWN",
        "apiName": "outcome",
        "label": "Outcome",
        "isVisible": true,
        "isLeadid": false,
        "options": [
          { "id": "opt_1", "label": "Interested" },
          { "id": "opt_2", "label": "Not Interested" }
        ]
      }
    ]
  },
  "allowPredatedActivity": "ALLOW",
  "definitionType": "USER_DEFINED",
  "source": "USER"
}

fieldSchema.customFieldDefinitions is an array, and each entry has the same shape as a lead field from GET /custom-fields?detail=true.

401 Unauthorized ​

See the universal 401 in the overview.

404 Not Found ​

json
{
  "error": {
    "code": "ACTION_NOT_FOUND",
    "message": "Could not find action with given code"
  }
}

Notes ​

  • The path parameter takes the full ACTION_<numeric> form, even though Sync action payloads use just the numeric portion.
  • Use fieldSchema.customFieldDefinitions[].apiName to discover which fields the action accepts — each one except FILE fields is a valid fields.<apiName> entry on a create-action request. Set FILE fields after creation with POST .../action/{actionId}/file.
  • allowPredatedActivity is ALLOW or DONT_ALLOW. Only an ALLOW action honours created_on.