> For the complete documentation index, see [llms.txt](https://developer.ivvy.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://developer.ivvy.com/getting-started/batch/run.md).

# Run

## Run

<mark style="color:green;">`POST`</mark> `[PlatformAddress]/api/1.0/batch?action=run`

#### Path Parameters

| Name        | Type   | Description                                                                                          |
| ----------- | ------ | ---------------------------------------------------------------------------------------------------- |
| jobs        | string | Array of api jobs to be run on the api. Each job needs to have keys                                  |
| callbackUrl | string | The URL to hit with a POST request after the batch has been run, with a JSON object of the responses |

{% tabs %}
{% tab title="200 " %}

```
{
    "asyncId":"e35e06ee592d17a42dc9e6252a058617"
}
```

{% endtab %}
{% endtabs %}

## Example Request

```javascript
{
  "jobs": [
	{"namespace":"event","action":"inviteContacts","params":{"event":1,"contacts":[1,2,3]}},
	{"namespace":"event","action":"inviteContacts","params":{"event":2,"contacts":[1,2,4]}},
  ],
  "callbackUrl":"http://example.callback.url.com"
}
```

## Keys

| namespace |
| --------- |
| action    |
| params    |

## Returns

| Property | Description                      |
| -------- | -------------------------------- |
| asyncId  | Identifier for the batch request |

## Throws

| Code                 | Description                                                      |
| -------------------- | ---------------------------------------------------------------- |
| Specific Code: 24092 | Incorrect Job Format                                             |
| Specific Code: 24093 | Empty job parameter found                                        |
| Specific Code: 24091 | The information was not saved                                    |
| Specific Code: 24448 | The maximum number of jobs can be put on a single request is 200 |

The run action takes an array of api calls and returns an identifier that can be used to identify the batch. Keep this identifier as it can be used to identify the response of the batch request, as well as being used to fetch the progress and results of the request.

To run a batch job, an JSON object must be provided with the following keys:

* jobs: An array of jobs, each element being an object with the following keys
  * namespace: The namespace of the api call
  * action: The api call to make
  * params: Any parameters required for the api call
* callbackUrl: A URL that will be called after the batch has completed.
  * The request will be a POST request
  * The response will be a JSON object with the following keys
    * asyncId: The async identifier provided when the batch was created
    * results: An array of objects for each result of the batch, with the following keys
      * namespace: The namespace of the call for the response
      * action: The action of of the call for the response
      * request: The original request parameters used
      * response: The response of the api call


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://developer.ivvy.com/getting-started/batch/run.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.