For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
Help CenterOpenAPI SpecStatus
OverviewInquiriesTransactionsAPI ReferenceChangelog
OverviewInquiriesTransactionsAPI ReferenceChangelog
  • Getting Started
    • Introduction
    • Quickstart Tutorial
  • API Overview
    • API Keys
    • Authentication
    • Protocol
    • Response Body
    • Idempotence
    • Pagination
    • Rate Limiting
    • Downloading Files
    • API Logs
    • Request IDs
  • Versioning
    • API Changelog
    • Versioning
  • Troubleshooting
    • Error Handling
  • API Reference
    • OpenAPI Specification
      • GETList all Accounts
      • POSTCreate an Account
      • GETRetrieve an Account
      • DELRedact an Account
      • PATCHUpdate an Account
      • POSTAdd tag to an Account
      • POSTConsolidate Accounts
      • GETGet all relations for an Account
      • POSTRemove tag from an Account
      • POSTSet tags on an Account
      • POSTRun an account action
    • Cases
    • Connect
    • Documents
    • Inquiries
    • List Items
    • Lists
    • OAuth
    • Reports
    • Transactions
    • Verifications
    • Workflows
  • Webhooks
LogoLogo
Help CenterOpenAPI SpecStatus
API ReferenceAccounts

Run an account action

POST
https://api.withpersona.com/api/v1/accounts/:account-id/run-action
POST
/api/v1/accounts/:account-id/run-action
$curl -X POST https://api.withpersona.com/api/v1/accounts/account-id/run-action \
>     -H "Authorization: Bearer <token>" \
>     -H "Content-Type: application/json" \
>     -d '{
>  "data": {
>    "account-action-id": "accac_h4Ln3agRBwdpZD55Lef8fDwjuvjG",
>    "parameters": {
>      "status": "activated"
>    }
>  }
>}'
1{
2  "data": {
3    "id": "act_hpNqyAbEG4HeVjZoBRNCMKkA",
4    "attributes": {
5      "reference-id": "abc-123",
6      "account-type-name": "User",
7      "created-at": "2023-09-22T17:13:49.000Z",
8      "updated-at": "2023-09-23T00:22:19.000Z",
9      "fields": {
10        "name": {
11          "type": "hash",
12          "value": {
13            "first": {
14              "type": "string",
15              "value": "Jane"
16            },
17            "middle": {
18              "type": "string",
19              "value": "Marie"
20            },
21            "last": {
22              "type": "string",
23              "value": "Doe"
24            }
25          }
26        },
27        "address": {
28          "type": "hash",
29          "value": {
30            "street_1": {
31              "type": "string",
32              "value": "123 Main St"
33            },
34            "street_2": {
35              "type": "string"
36            },
37            "subdivision": {
38              "type": "string",
39              "value": "California"
40            },
41            "city": {
42              "type": "string",
43              "value": "San Francisco"
44            },
45            "postal_code": {
46              "type": "string",
47              "value": "94111"
48            },
49            "country_code": {
50              "type": "string",
51              "value": "US"
52            }
53          }
54        },
55        "identification_numbers": {
56          "type": "array",
57          "value": [
58            {
59              "type": "hash",
60              "value": {
61                "identification_class": {
62                  "type": "string",
63                  "value": "visa"
64                },
65                "identification_number": {
66                  "type": "string",
67                  "value": "12345678"
68                },
69                "issuing_country": {
70                  "type": "string",
71                  "value": "US"
72                }
73              }
74            },
75            {
76              "type": "hash",
77              "value": {
78                "identification_class": {
79                  "type": "string",
80                  "value": "visa"
81                },
82                "identification_number": {
83                  "type": "string",
84                  "value": "87654321"
85                },
86                "issuing_country": {
87                  "type": "string",
88                  "value": "UK"
89                }
90              }
91            },
92            {
93              "type": "hash",
94              "value": {
95                "identification_class": {
96                  "type": "string",
97                  "value": "cct"
98                },
99                "identification_number": {
100                  "type": "string",
101                  "value": "A12345678"
102                },
103                "issuing_country": {
104                  "type": "string",
105                  "value": "AF"
106                }
107              }
108            }
109          ]
110        },
111        "birthdate": {
112          "type": "date",
113          "value": "1994-12-30"
114        },
115        "phone_number": {
116          "type": "string",
117          "value": "111-222-3333"
118        },
119        "email_address": {
120          "type": "string",
121          "value": "jane@doe.com"
122        },
123        "selfie_photo": {
124          "type": "file"
125        }
126      },
127      "tags": [
128        "tag1",
129        "tag2"
130      ]
131    },
132    "relationships": {
133      "account-type": {
134        "data": {
135          "id": "acttp_7X5W5w9GMtQntE6oPtKnj44c",
136          "type": "account-type"
137        }
138      }
139    },
140    "type": "account"
141  },
142  "meta": {
143    "workflow-run-id": "wfr_abc123def456ghi789"
144  }
145}
Triggers an account action for the specified account
Was this page helpful?
Previous

Retrieve an Account Type

Next
Built with

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

account-idstringRequiredformat: "^act_[a-zA-Z0-9]{24,28}$"
The ID of the account to run the action on

Request

This endpoint expects an object.
dataobjectRequired

Response

Account action executed successfully
dataobject

An Account object.

Note that fields is not key inflected.

metaobject

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
409
Conflict Error
422
Unprocessable Entity Error
429
Too Many Requests Error