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.
Developer Tools
CommunityContact UsConsole
DocsAPI Reference
DocsAPI Reference
  • API Reference
      • POSTCreate a Custom Action
      • DELDelete a Custom Action
      • GETGet a Custom Action by ID
      • GETGet Custom Actions for a given Team
      • GETGet Custom Actions for an Account or Team
      • PUTUpdate a Custom Action

© 2026 Adobe Inc. All rights reserved.

TermsPrivacyDo not sell or share my personal information
Developer-friendly docs for your API
Logo
Developer Tools
CommunityContact UsConsole
API ReferenceCustom Actions

Create a Custom Action

POST
https://api.frame.io/v2/teams/:team_id/actions
POST
/v2/teams/:team_id/actions
1import requests
2
3url = "https://api.frame.io/v2/teams/team_id/actions"
4
5payload = {
6    "description": "string",
7    "event": "string",
8    "name": "string",
9    "url": "string"
10}
11headers = {
12    "Authorization": "Bearer <token>",
13    "Content-Type": "application/json"
14}
15
16response = requests.post(url, json=payload, headers=headers)
17
18print(response.json())
1{
2  "active": true,
3  "allow_collaborators": true,
4  "creator_id": "string",
5  "deleted_at": "2024-01-15T09:30:00Z",
6  "description": "string",
7  "event": "string",
8  "id": "string",
9  "image": "string",
10  "inserted_at": "2024-01-15T09:30:00Z",
11  "name": "string",
12  "team": {
13    "account_id": "string",
14    "disable_sbwm_internally": false,
15    "creator_id": "string",
16    "storage": 0,
17    "default_font_color": "string",
18    "access": "private",
19    "font_color": "string",
20    "user_role": {},
21    "file_count": 0,
22    "default_session_watermark_template": {
23      "account_id": "string",
24      "app_default": false,
25      "creator_id": "string",
26      "id": "string",
27      "name": "string",
28      "watermark_blocks": [
29        {
30          "alpha": 0.5,
31          "data_points": [
32            {
33              "order": 1,
34              "type": "email",
35              "value": "string"
36            }
37          ],
38          "font_size": "medium",
39          "name": "string",
40          "position": "top_left",
41          "position_reference_point": "top_left",
42          "position_x": 1,
43          "position_y": 1,
44          "scroll_text": "none",
45          "text_alignment": "left",
46          "text_color": "#FFFFFF",
47          "text_shadow": false
48        }
49      ]
50    },
51    "link": "string",
52    "asset_lifecycle_policy": 1,
53    "upload_url": "string",
54    "admin_only_actions": {
55      "lifecycle": false
56    },
57    "deleted_at": "2024-01-15T09:30:00Z",
58    "default_background_color": "string",
59    "storage_limit": 1,
60    "location": "string",
61    "name": "string",
62    "default_color": "string",
63    "slack_webhook": {},
64    "image_64": "string",
65    "archived_storage": 0,
66    "image_128": "string",
67    "solo": false,
68    "account": {
69      "invoice_emails": [
70        "string"
71      ],
72      "city": "string",
73      "account_default_color": "string",
74      "company_name": "string",
75      "storage": 1,
76      "file_count": 1,
77      "owner": {
78        "digest_frequency": "string",
79        "image_32": "string",
80        "image_128": "string",
81        "from_google": true,
82        "mfa_enforced_at": "string",
83        "email": "string",
84        "name": "string",
85        "image_64": "string",
86        "timezone_value": "string",
87        "account_id": "string",
88        "updated_at": "string",
89        "image_256": "string",
90        "_type": "string",
91        "user_hash": "string",
92        "upload_url": "string",
93        "profile_image": "string",
94        "first_login_at": "string",
95        "joined_via": "string",
96        "id": "string",
97        "next_digest_date": "string",
98        "last_seen": "string",
99        "inserted_at": "string",
100        "from_adobe": true,
101        "avatar_color": "string",
102        "highest_account_role": "string",
103        "integrations": [
104          "string"
105        ],
106        "roles": {
107          "admin": true,
108          "id": "string",
109          "sales": true,
110          "support": true,
111          "service_desk": true
112        },
113        "user_default_color": "string"
114      },
115      "upload_url": "string",
116      "deleted_at": "2024-01-15T09:30:00Z",
117      "line1": "string",
118      "postal_code": "string",
119      "vat": "string",
120      "company_address": "string",
121      "lifetime_file_count": 1,
122      "state": "string",
123      "teams": [
124        null
125      ],
126      "image_64": "string",
127      "archived_storage": 1,
128      "image_128": "string",
129      "owner_id": "string",
130      "user_count": 1,
131      "locked_at": "2024-01-15T09:30:00Z",
132      "image": "string",
133      "team_count": 1,
134      "collaborator_role_count": 1,
135      "billing_emails": "string",
136      "image_32": "string",
137      "unpaid_at": "2024-01-15T09:30:00Z",
138      "inserted_at": "2024-01-15T09:30:00Z",
139      "updated_at": "2024-01-15T09:30:00Z",
140      "project_count": 1,
141      "duration": 1,
142      "delinquent_at": "2024-01-15T09:30:00Z",
143      "collaborator_count": 1,
144      "plan": {
145        "archived_storage_limit": 1,
146        "autoscaling": true,
147        "available_features": {
148          "archival_storage": true,
149          "custom_branded_emails": true,
150          "custom_branded_presentations": true,
151          "reel_player": true,
152          "secure_sharing": true,
153          "session_based_watermarking": true,
154          "team_only_comments": true
155        },
156        "collaborator_limit": 1,
157        "cost": 1,
158        "default_plan": true,
159        "deleted_at": "2024-01-15T09:30:00Z",
160        "enterprise": true,
161        "file_limit": 1,
162        "id": "string",
163        "inserted_at": "2024-01-15T09:30:00Z",
164        "lifetime_file_limit": 1,
165        "member_limit": 1,
166        "name": "string",
167        "payment_method": "stripe",
168        "period": "monthly",
169        "project_limit": 1,
170        "storage_limit": 1,
171        "team_limit": 1,
172        "tier": "free",
173        "title": "string",
174        "updated_at": "2024-01-15T09:30:00Z",
175        "user_limit": 1,
176        "user_max": 1,
177        "version": 1
178      },
179      "watermark": {
180        "image": {
181          "alpha": 0.5,
182          "image": {
183            "bucket": "string",
184            "key": "string",
185            "type": "image/jpeg",
186            "uploaded": false
187          },
188          "position": "top_left"
189        },
190        "text": {
191          "alpha": 0.5,
192          "lines": [
193            "string"
194          ],
195          "position": "top"
196        }
197      },
198      "folder_count": 1,
199      "id": "string",
200      "display_name": "string",
201      "country": "string",
202      "subscription": {
203        "account_id": "string",
204        "archived_storage_limit": 1,
205        "balance": 1,
206        "cancellation_option": "string",
207        "cancellation_reason": "string",
208        "cancelled_at": "2024-01-15T09:30:00Z",
209        "deleted_at": "2024-01-15T09:30:00Z",
210        "id": "string",
211        "inserted_at": "2024-01-15T09:30:00Z",
212        "last_payment_at": "2024-01-15T09:30:00Z",
213        "member_limit": 1,
214        "next_bill_at": "2024-01-15T09:30:00Z",
215        "on_trial": true,
216        "plan": {
217          "archived_storage_limit": 1,
218          "autoscaling": true,
219          "available_features": {
220            "archival_storage": true,
221            "custom_branded_emails": true,
222            "custom_branded_presentations": true,
223            "reel_player": true,
224            "secure_sharing": true,
225            "session_based_watermarking": true,
226            "team_only_comments": true
227          },
228          "collaborator_limit": 1,
229          "cost": 1,
230          "default_plan": true,
231          "deleted_at": "2024-01-15T09:30:00Z",
232          "enterprise": true,
233          "file_limit": 1,
234          "id": "string",
235          "inserted_at": "2024-01-15T09:30:00Z",
236          "lifetime_file_limit": 1,
237          "member_limit": 1,
238          "name": "string",
239          "payment_method": "stripe",
240          "period": "monthly",
241          "project_limit": 1,
242          "storage_limit": 1,
243          "team_limit": 1,
244          "tier": "free",
245          "title": "string",
246          "updated_at": "2024-01-15T09:30:00Z",
247          "user_limit": 1,
248          "user_max": 1,
249          "version": 1
250        },
251        "plan_id": "string",
252        "promotion_expires_at": "2024-01-15T09:30:00Z",
253        "promotion_id": "string",
254        "requires_autoscaling": true,
255        "storage_limit": 1,
256        "subscription_end_at": "2024-01-15T09:30:00Z",
257        "total_archived_storage_limit": 1,
258        "total_lifetime_file_limit": 1,
259        "total_member_limit": 1,
260        "total_project_limit": 1,
261        "total_storage_limit": 1,
262        "total_user_limit": 1,
263        "updated_at": "2024-01-15T09:30:00Z",
264        "user_limit": 1
265      },
266      "account_members": [
267        {
268          "accepted_at": "2024-01-15T09:30:00Z",
269          "account_id": "string",
270          "declined_at": "2024-01-15T09:30:00Z",
271          "deleted_at": "2024-01-15T09:30:00Z",
272          "inserted_at": "2024-01-15T09:30:00Z",
273          "role": "admin",
274          "updated_at": "2024-01-15T09:30:00Z",
275          "user_id": "string"
276        }
277      ],
278      "frames": 1,
279      "member_count": 1,
280      "image_256": "string"
281    },
282    "image_32": "string",
283    "inserted_at": "2024-01-15T09:30:00Z",
284    "updated_at": "2024-01-15T09:30:00Z",
285    "project_count": 0,
286    "duration": 0,
287    "team_image": "string",
288    "collaborator_count": 0,
289    "bio": "string",
290    "color": "string",
291    "email_branding": {
292      "accent_color": "string",
293      "background_color": "string",
294      "image": {
295        "bucket": "string",
296        "key": "string",
297        "type": "image/jpeg",
298        "uploaded": false
299      }
300    },
301    "folder_count": 0,
302    "dark_theme": false,
303    "default_session_watermark_template_id": "string",
304    "session_watermark_templates": [
305      {
306        "account_id": "string",
307        "app_default": false,
308        "creator_id": "string",
309        "id": "string",
310        "name": "string",
311        "watermark_blocks": [
312          {
313            "alpha": 0.5,
314            "data_points": [
315              {
316                "order": 1,
317                "type": "email",
318                "value": "string"
319              }
320            ],
321            "font_size": "medium",
322            "name": "string",
323            "position": "top_left",
324            "position_reference_point": "top_left",
325            "position_x": 1,
326            "position_y": 1,
327            "scroll_text": "none",
328            "text_alignment": "left",
329            "text_color": "#FFFFFF",
330            "text_shadow": false
331          }
332        ]
333      }
334    ],
335    "id": "string",
336    "member_limit": 1,
337    "frames": 0,
338    "member_count": 0,
339    "image_256": "string",
340    "background_color": "string"
341  },
342  "team_id": "string",
343  "updated_at": "2024-01-15T09:30:00Z",
344  "upload_url": "string",
345  "url": "string",
346  "webhook": {
347    "account_id": "string",
348    "active": true,
349    "app_id": "string",
350    "deleted_at": "2024-01-15T09:30:00Z",
351    "events": [
352      "project.created"
353    ],
354    "id": "string",
355    "inserted_at": "2024-01-15T09:30:00Z",
356    "name": "string",
357    "project_id": "string",
358    "secret": "string",
359    "team": {
360      "account_id": "string",
361      "disable_sbwm_internally": false,
362      "creator_id": "string",
363      "storage": 0,
364      "default_font_color": "string",
365      "access": "private",
366      "font_color": "string",
367      "user_role": {},
368      "file_count": 0,
369      "default_session_watermark_template": {
370        "account_id": "string",
371        "app_default": false,
372        "creator_id": "string",
373        "id": "string",
374        "name": "string",
375        "watermark_blocks": [
376          {
377            "alpha": 0.5,
378            "data_points": [
379              {
380                "order": 1,
381                "type": "email",
382                "value": "string"
383              }
384            ],
385            "font_size": "medium",
386            "name": "string",
387            "position": "top_left",
388            "position_reference_point": "top_left",
389            "position_x": 1,
390            "position_y": 1,
391            "scroll_text": "none",
392            "text_alignment": "left",
393            "text_color": "#FFFFFF",
394            "text_shadow": false
395          }
396        ]
397      },
398      "link": "string",
399      "asset_lifecycle_policy": 1,
400      "upload_url": "string",
401      "admin_only_actions": {
402        "lifecycle": false
403      },
404      "deleted_at": "2024-01-15T09:30:00Z",
405      "default_background_color": "string",
406      "storage_limit": 1,
407      "location": "string",
408      "name": "string",
409      "default_color": "string",
410      "slack_webhook": {},
411      "image_64": "string",
412      "archived_storage": 0,
413      "image_128": "string",
414      "solo": false,
415      "account": {
416        "invoice_emails": [
417          "string"
418        ],
419        "city": "string",
420        "account_default_color": "string",
421        "company_name": "string",
422        "storage": 1,
423        "file_count": 1,
424        "owner": {
425          "digest_frequency": "string",
426          "image_32": "string",
427          "image_128": "string",
428          "from_google": true,
429          "mfa_enforced_at": "string",
430          "email": "string",
431          "name": "string",
432          "image_64": "string",
433          "timezone_value": "string",
434          "account_id": "string",
435          "updated_at": "string",
436          "image_256": "string",
437          "_type": "string",
438          "user_hash": "string",
439          "upload_url": "string",
440          "profile_image": "string",
441          "first_login_at": "string",
442          "joined_via": "string",
443          "id": "string",
444          "next_digest_date": "string",
445          "last_seen": "string",
446          "inserted_at": "string",
447          "from_adobe": true,
448          "avatar_color": "string",
449          "highest_account_role": "string",
450          "integrations": [
451            "string"
452          ],
453          "roles": {
454            "admin": true,
455            "id": "string",
456            "sales": true,
457            "support": true,
458            "service_desk": true
459          },
460          "user_default_color": "string"
461        },
462        "upload_url": "string",
463        "deleted_at": "2024-01-15T09:30:00Z",
464        "line1": "string",
465        "postal_code": "string",
466        "vat": "string",
467        "company_address": "string",
468        "lifetime_file_count": 1,
469        "state": "string",
470        "teams": [
471          null
472        ],
473        "image_64": "string",
474        "archived_storage": 1,
475        "image_128": "string",
476        "owner_id": "string",
477        "user_count": 1,
478        "locked_at": "2024-01-15T09:30:00Z",
479        "image": "string",
480        "team_count": 1,
481        "collaborator_role_count": 1,
482        "billing_emails": "string",
483        "image_32": "string",
484        "unpaid_at": "2024-01-15T09:30:00Z",
485        "inserted_at": "2024-01-15T09:30:00Z",
486        "updated_at": "2024-01-15T09:30:00Z",
487        "project_count": 1,
488        "duration": 1,
489        "delinquent_at": "2024-01-15T09:30:00Z",
490        "collaborator_count": 1,
491        "plan": {
492          "archived_storage_limit": 1,
493          "autoscaling": true,
494          "available_features": {
495            "archival_storage": true,
496            "custom_branded_emails": true,
497            "custom_branded_presentations": true,
498            "reel_player": true,
499            "secure_sharing": true,
500            "session_based_watermarking": true,
501            "team_only_comments": true
502          },
503          "collaborator_limit": 1,
504          "cost": 1,
505          "default_plan": true,
506          "deleted_at": "2024-01-15T09:30:00Z",
507          "enterprise": true,
508          "file_limit": 1,
509          "id": "string",
510          "inserted_at": "2024-01-15T09:30:00Z",
511          "lifetime_file_limit": 1,
512          "member_limit": 1,
513          "name": "string",
514          "payment_method": "stripe",
515          "period": "monthly",
516          "project_limit": 1,
517          "storage_limit": 1,
518          "team_limit": 1,
519          "tier": "free",
520          "title": "string",
521          "updated_at": "2024-01-15T09:30:00Z",
522          "user_limit": 1,
523          "user_max": 1,
524          "version": 1
525        },
526        "watermark": {
527          "image": {
528            "alpha": 0.5,
529            "image": {
530              "bucket": "string",
531              "key": "string",
532              "type": "image/jpeg",
533              "uploaded": false
534            },
535            "position": "top_left"
536          },
537          "text": {
538            "alpha": 0.5,
539            "lines": [
540              "string"
541            ],
542            "position": "top"
543          }
544        },
545        "folder_count": 1,
546        "id": "string",
547        "display_name": "string",
548        "country": "string",
549        "subscription": {
550          "account_id": "string",
551          "archived_storage_limit": 1,
552          "balance": 1,
553          "cancellation_option": "string",
554          "cancellation_reason": "string",
555          "cancelled_at": "2024-01-15T09:30:00Z",
556          "deleted_at": "2024-01-15T09:30:00Z",
557          "id": "string",
558          "inserted_at": "2024-01-15T09:30:00Z",
559          "last_payment_at": "2024-01-15T09:30:00Z",
560          "member_limit": 1,
561          "next_bill_at": "2024-01-15T09:30:00Z",
562          "on_trial": true,
563          "plan": {
564            "archived_storage_limit": 1,
565            "autoscaling": true,
566            "available_features": {
567              "archival_storage": true,
568              "custom_branded_emails": true,
569              "custom_branded_presentations": true,
570              "reel_player": true,
571              "secure_sharing": true,
572              "session_based_watermarking": true,
573              "team_only_comments": true
574            },
575            "collaborator_limit": 1,
576            "cost": 1,
577            "default_plan": true,
578            "deleted_at": "2024-01-15T09:30:00Z",
579            "enterprise": true,
580            "file_limit": 1,
581            "id": "string",
582            "inserted_at": "2024-01-15T09:30:00Z",
583            "lifetime_file_limit": 1,
584            "member_limit": 1,
585            "name": "string",
586            "payment_method": "stripe",
587            "period": "monthly",
588            "project_limit": 1,
589            "storage_limit": 1,
590            "team_limit": 1,
591            "tier": "free",
592            "title": "string",
593            "updated_at": "2024-01-15T09:30:00Z",
594            "user_limit": 1,
595            "user_max": 1,
596            "version": 1
597          },
598          "plan_id": "string",
599          "promotion_expires_at": "2024-01-15T09:30:00Z",
600          "promotion_id": "string",
601          "requires_autoscaling": true,
602          "storage_limit": 1,
603          "subscription_end_at": "2024-01-15T09:30:00Z",
604          "total_archived_storage_limit": 1,
605          "total_lifetime_file_limit": 1,
606          "total_member_limit": 1,
607          "total_project_limit": 1,
608          "total_storage_limit": 1,
609          "total_user_limit": 1,
610          "updated_at": "2024-01-15T09:30:00Z",
611          "user_limit": 1
612        },
613        "account_members": [
614          {
615            "accepted_at": "2024-01-15T09:30:00Z",
616            "account_id": "string",
617            "declined_at": "2024-01-15T09:30:00Z",
618            "deleted_at": "2024-01-15T09:30:00Z",
619            "inserted_at": "2024-01-15T09:30:00Z",
620            "role": "admin",
621            "updated_at": "2024-01-15T09:30:00Z",
622            "user_id": "string"
623          }
624        ],
625        "frames": 1,
626        "member_count": 1,
627        "image_256": "string"
628      },
629      "image_32": "string",
630      "inserted_at": "2024-01-15T09:30:00Z",
631      "updated_at": "2024-01-15T09:30:00Z",
632      "project_count": 0,
633      "duration": 0,
634      "team_image": "string",
635      "collaborator_count": 0,
636      "bio": "string",
637      "color": "string",
638      "email_branding": {
639        "accent_color": "string",
640        "background_color": "string",
641        "image": {
642          "bucket": "string",
643          "key": "string",
644          "type": "image/jpeg",
645          "uploaded": false
646        }
647      },
648      "folder_count": 0,
649      "dark_theme": false,
650      "default_session_watermark_template_id": "string",
651      "session_watermark_templates": [
652        {
653          "account_id": "string",
654          "app_default": false,
655          "creator_id": "string",
656          "id": "string",
657          "name": "string",
658          "watermark_blocks": [
659            {
660              "alpha": 0.5,
661              "data_points": [
662                {
663                  "order": 1,
664                  "type": "email",
665                  "value": "string"
666                }
667              ],
668              "font_size": "medium",
669              "name": "string",
670              "position": "top_left",
671              "position_reference_point": "top_left",
672              "position_x": 1,
673              "position_y": 1,
674              "scroll_text": "none",
675              "text_alignment": "left",
676              "text_color": "#FFFFFF",
677              "text_shadow": false
678            }
679          ]
680        }
681      ],
682      "id": "string",
683      "member_limit": 1,
684      "frames": 0,
685      "member_count": 0,
686      "image_256": "string",
687      "background_color": "string"
688    },
689    "team_id": "string",
690    "updated_at": "2024-01-15T09:30:00Z",
691    "url": "string"
692  }
693}
Create a Custom Action belonging to A Team
Was this page helpful?
Previous

Delete a Custom Action

Next

Authentication

AuthorizationBearer

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

Path parameters

team_idstringRequiredformat: "uuid"

Request

Action to create or update
descriptionstringRequired
Description of the custom Action
eventstringRequired
Arbitrary event name to include in custom Action webhook payloads
namestringRequired
Name of the custom Action
urlstringRequired
HTTPS endpoint to deliver Action events to
allow_collaboratorsbooleanOptionalDefaults to false
includestringOptional
Any associations to include in the response

Response

Action success response
activeboolean
allow_collaboratorsboolean
creator_idstringformat: "uuid"
deleted_atstringformat: "date-time"
descriptionstring
eventstring
idstringformat: "uuid"
imagestring
inserted_atstringformat: "date-time"
namestring
teamobject
team_idstringformat: "uuid"
updated_atstringformat: "date-time"
upload_urlstring
urlstring
webhookobject

Errors

401
Unauthorized Error
404
Not Found Error