Trigger an action

POST

https://api.contentful.com/spaces/:space_id/environments/:environment_id/app_installations/:app_installation_id/actions/:app_action_id/calls

POST

/spaces/:space_id/environments/:environment_id/app_installations/:app_installation_id/actions/:app_action_id/calls

$ curl -X POST https://api.contentful.com/spaces/space_id/environments/environment_id/app_installations/app_installation_id/actions/app_action_id/calls \
>      -H "Authorization: Bearer <token>" \
>      -H "Content-Type: application/vnd.contentful.management.v1+json" \
>      -d '{
>   "parameters": {
>     "recipient": "Alice <alice@my-company.com>",
>     "message_body": "Hello from Bob!"
>   }
> }'

201App Action calls_triggerAnAction_example

1 {
2   "sys": {
3     "type": "AppActionCall",
4     "space": {
5       "sys": {
6         "type": "Link",
7         "linkType": "Space",
8         "id": "yadj1kx9rmg0"
9       }
10     },
11     "environment": {
12       "sys": {
13         "type": "Link",
14         "linkType": "Environment",
15         "id": "staging"
16       }
17     },
18     "appDefinition": {
19       "sys": {
20         "type": "Link",
21         "linkType": "AppDefinition",
22         "id": "<app_definition_id>"
23       }
24     },
25     "action": {
26       "sys": {
27         "type": "Link",
28         "linkType": "AppAction",
29         "id": "<app_action_id>"
30       }
31     },
32     "createdAt": "2025-11-30T19:48:18.000Z",
33     "createdBy": {
34       "sys": {
35         "type": "Link",
36         "linkType": "AppDefinition",
37         "id": "6FfrUHfsHdvhsLi9czfji"
38       }
39     },
40     "updatedAt": "2025-11-30T19:48:18.000Z",
41     "updatedBy": {
42       "sys": {
43         "type": "Link",
44         "linkType": "AppDefinition",
45         "id": "6FfrUHfsHdvhsLi9czfji"
46       }
47     },
48     "status": "processing | succeeded | failed",
49     "error": {
50       "sys": {
51         "type": "Error",
52         "id": "<error_id>"
53       },
54       "message": "<error_message>"
55     }
56   }
57 }

Authentication

AuthorizationBearer

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

Path parameters

space_idstringRequired

space_id identifier

environment_idstringRequired

environment_id identifier

app_installation_idstringRequired

app_installation_id identifier

app_action_idstringRequired

app_action_id identifier

Request

This endpoint expects a map from strings to any.

Response headers

Content-Typestring

Content-Type

Response

Created - Resource created successfully