> For the complete documentation index, see [llms.txt](https://docs.systemsx.co.uk/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.systemsx.co.uk/bridge/api-create-job.md).

# API Create Job

## <https://systemsx.co.uk/products/bridge>

## Create a Booking Job

<mark style="color:green;">`POST`</mark> `/external/deploy/booking`

This endpoint allows the creation of a booking job. Either the `username` **or** the `email_address` parameter is required, but **only one** should be provided.

**Body**

<table><thead><tr><th width="350">Name</th><th width="92">Type</th><th>Required</th></tr></thead><tbody><tr><td><code>api_key</code></td><td>string</td><td>true</td></tr><tr><td><code>type</code></td><td>string</td><td><code>po,msc,tui</code></td></tr><tr><td><code>bookingReference</code></td><td>string</td><td>true</td></tr><tr><td><code>return_url</code></td><td>url</td><td>false</td></tr><tr><td><code>organisationName</code></td><td>string</td><td>required</td></tr><tr><td><code>agentName</code></td><td>string</td><td>required</td></tr><tr><td><code>bookingFields[]</code></td><td>array</td><td>true</td></tr><tr><td><code>bookingFields[username]</code></td><td>string</td><td>[username OR email_address]</td></tr><tr><td><code>bookingFields[email_address]</code></td><td>email</td><td>[username OR email_address]</td></tr><tr><td><code>bookingFields[password]</code></td><td>string</td><td>true</td></tr></tbody></table>

**Response**

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

```json
{
  "hash": "XXXXXXXXXXXXXXXXXXXXX"
}
```

{% endtab %}

{% tab title="400" %}

```json
{
  "hash": "XXXXXXXXXXXXXXXXXXXXX",
  "errors": [
    "X field is Missing or Empty."
  ]
}
```

{% endtab %}
{% endtabs %}

{% tabs %}
{% tab title="return\_url Response" %}

```json
{
  "hash": "XXXXXXXX",
  "ImportDetail": {
      "importRequest": {
          "sourceReference": "",
          "bookingReference" : "",
          "bookingFields": [],
          "returnUrl": "",
          "api_key": "",
          "type": ""
      }
  }
}
```

{% endtab %}
{% endtabs %}