MImiddesk
actions

Create an action on an object

Changed on
post/v1/actions

Request

Request body

object_type'businesses' | 'watchlist_result' required

Type of object to perform the action on

object_idstring uuid required

ID of the object to perform the action on

type'add_sources' | 'add_attributes' | 'verify_tin' | 'decision' | 'dismissal' required

The type of action to perform

notestring

Optional text note describing the reason for the action

thread_idstring uuid

Optional operator thread ID used to resolve an action actor

run_idstring uuid

Optional operator run ID used to resolve an action actor

payloadobject required

Action-specific parameters (varies by action type)

Response

action created - verify TIN

idstring uuid required
type'add_sources' | 'add_attributes' | 'update_address_risk' | 'verify_tin' | 'decision' | 'dismissal' required

The action type that was performed

object_type'Business' | 'Watchlist::Result' required

The type of object the action was performed on

object_idstring uuid required

The ID of the object the action was performed on

created_atstring date-time required
notestring nullable

Optional text note describing the reason for the action

metadataobject

Additional metadata associated with the action

Changes

  • 4c9cd4e834baRevision changes
    • breaking

      added to the // response property oneOf list for the response status

    • warning

      deleted the header request parameter Authorization

    • info

      the endpoint scheme security bearer_auth was added to the API

    • info

      removed from the // response property oneOf list for the response status

  • 668373c892ceRevision changes
    • info

      api operation id createAction removed and replaced with actions_createAction