> For the complete documentation index, see [llms.txt](https://docs.alemba.com/asm-hermes/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.alemba.com/asm-hermes/integrate/apis/asm-api-quick-reference-guide/locking-and-updating-calls.md).

# Locking and Updating Calls

## ASM API Quick Reference Guide <a href="#asmapiquickreferenceguide" id="asmapiquickreferenceguide"></a>

#### Start a new Request  <a href="#lockingandupdatingcalls" id="lockingandupdatingcalls"></a>

1. In Postman, select 'New' in the top left-hand corner.&#x20;
2. Select HTTP from the dialogue window and give the request the name of {<mark style="color:green;">**Request name**</mark>}

### <mark style="color:green;">**Request Name**</mark>**&#x20;-&#x20;*****Lock Call***

* **Method**: PUT
* **URL**: `{{SystemURLTest}}/alemba.api/api/v2/call/{{CallRef}}/lock`
  * **Full URL**, if desired: `https://<yourservername>/<yourASMsystemname>/alemba.api/api/v2/call/<yourcallno>/lock`
* **Authorization:** `Bearer {{Login_Token}}`

<figure><img src="/files/yzcWL8Qo3sst9zdhqSsy" alt=""><figcaption><p>Successful Response</p></figcaption></figure>

### <mark style="color:green;">**Request Name**</mark>**&#x20;-&#x20;*****Update Call Fields***

* **Method**: PUT
* **URL**: `{{SystemURLTest}}/alemba.api/api/v2/call/{{CallRef}}`
  * **Full URL**, if desired: `https://<yourservername>/<yourASMsystemname>/alemba.api/api/v2/call/<yourcallRef>`
* **Headers**: `Content-Type: application/json`
* **Body:** `Raw`
* **Authorization:** `Bearer {{Login_Token}}`

{% hint style="info" %}
The Body of the HTTP request is where you enter the data/changes that you want to enact on the call. The Body is written in JSON. Please go to [Jargon Buster](/asm-hermes/integrate/apis/asm-api-quick-reference-guide.md#jargonbuster) to read more about JSON.
{% endhint %}

1. To update the Description of the call and the Call Status, the JSON body should look like as follows:

`{`

`"Description":"the new description",`

`"DescriptionHtml": "the new description",`

`"CallStatus": 3`

`}`

{% hint style="info" %}
Please note, where you have rich text fields (HTML), you always need to provide the FieldName value and the FieldNameHtml value.
{% endhint %}

<figure><img src="/files/U3Y1raUU5yq7O7KE7gbu" alt=""><figcaption></figcaption></figure>

<figure><img src="/files/8se58MdPCAWMErQurfzF" alt=""><figcaption><p>A Successful Response</p></figcaption></figure>

<mark style="color:green;">**Request Name -**</mark>**&#x20;*****Unlock Call***

{% hint style="warning" %}
This is Mandatory after doing an Update, unless an Update is followed by a Forward, Defer or Close action, which will automatically unlock the call.
{% endhint %}

* **Method**: PUT
* **URL**: `{{SystemURLTest}}/alemba.api/api/v2/call/{{CallRef}}/unlock`
  * **Full URL**, if desired: `https://<yourservername>/<yourASMsystemname>/alemba.api/api/v2/call/<yourcallno>/unlock`
* **Authorization:** `Bearer {{Login_Token}}`

<figure><img src="/files/rbCGKtLGXfFStYOO5TOj" alt=""><figcaption><p>A Successful Request</p></figcaption></figure>


---

# 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://docs.alemba.com/asm-hermes/integrate/apis/asm-api-quick-reference-guide/locking-and-updating-calls.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.