Run an account action

POST

https://api.withpersona.com/api/v1/accounts/:account-id/run-action

POST

/api/v1/accounts/:account-id/run-action

1 curl -X POST https://api.withpersona.com/api/v1/accounts/account-id/run-action \
2      -H "Authorization: Bearer <token>" \
3      -H "Content-Type: application/json"

Try it

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

Triggers an account action for the specified account

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

Authentication

Path parameters

Request

Response

Errors