# Add or Update Lead Type

## Add or Update Lead Type

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

#### Path Parameters

| Name | Type    | Description                                                               |
| ---- | ------- | ------------------------------------------------------------------------- |
| id   | integer | The unique id of the lead type (Leave empty if adding a new lead type)    |
| type | string  | The name of the crm lead type (Required when the ID parameter is missing) |

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

```
{
  "success": true,
  "id": 755
}
```

{% endtab %}
{% endtabs %}

## Example Request

### Add Lead Type

```javascript
{
  "type": "Referal Type",
}
```

### Update Lead Type

```javascript
{
  "id": 755,
  "type": "Another name"
}
```

## Returns

| Property | Description                            |
| -------- | -------------------------------------- |
| success  | Whether or not the lead type was added |
| id       | The unique id of the lead type         |

## Throws

| Code                 | Description                       |
| -------------------- | --------------------------------- |
| Specific Code: 24381 | The crm lead type does not exist  |
| Specific Code: 24382 | An error has occurred             |
| Specific Code: 24383 | The request contains invalid data |
| Specific Code: 24384 | The request contains invalid data |

This call takes values for a lead type, and either

1. Updates the values for that lead type (after you have provided an id in the parameters), or
2. Adds the lead type to the system (if the id parameter is missing) 1. The result of this call will contain the status of the result (either

   true or false) and the lead type identifier of the updated or newly

   created lead type.


---

# Agent Instructions: 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:

```
GET https://developer.ivvy.com/crm/add-or-update-lead-type.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
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.