---
title: "Create Opportunity Status"
method: POST
path: "/opportunityStatuses"
tags: ["Opportunities / Statuses"]
---

# Create Opportunity Status

`POST /opportunityStatuses`

## Request

- Base URL: `https://api.forcemanager.com/api/v4`
- URL: `https://api.forcemanager.com/api/v4/opportunityStatuses`
- Auth: API key in header `X-Session-Key`

This endpoint allows you to create a Opportunity Status based on JSON input.

You will only be able to create a Opportunity Status after first providing the Session Key. To know how you can obtain the Session Key, [go to Authentication](#tag/authentication/POST/login).

**HEADERS**

| **Parameter** | **Value** | **Description** |
| --- | --- | --- |
| Content-Type | application/json | Language in which all request and response bodies are encoded |
| Accept | \*/\* | Any data of whatever mime type is accepted |
| X-Session-Key | AUTH_TOKEN | This field must be completed with the token obtained at the authentication |

**REQUEST BODY**

| **Attribute** | **Type** | **Description** |
| --- | --- | --- |
| branchVisibility | Array | In which Branch the Opportunity Status is visible |
| endStatus | Integer | Set to 1 if the Opportunity is closed 0 otherwise |
| won | Boolean | If true, the close opportunity has been won |
| idParent | Integer | This is mostly used to stick an Opportunity Status with an Opportunity Type (see [Types](#) resource), in the case the Opportunity Types are used to represent multiple pipelines |
| descriptionDE | String | Opportunity Status label in German |
| descriptionDK | String | Opportunity Status label in Dutch |
| descriptionEN (*Required*) | String | Opportunity Status label in English |
| descriptionES | String | Opportunity Status label in Spanish |
| descriptionFR | String | Opportunity Status label in French |
| descriptionIT | String | Opportunity Status label in Italian |
| descriptionPT | String | Opportunity Status label in Portuguese |
| descriptionRU | String | Opportunity Status label in Russian |
| descriptionUS | String | Opportunity Status label in American English |
| order | Integer | The position of the Opportunity Status in the Opportunity Statuses value list |

**RESPONSE**

Returns a JSON with information about the Opportunity Status just created.

| **Attribute** | **Type** |
| --- | --- |
| Id | Id assigned to the new Opportunity Status |
| Message | The operation status |

**RESPONSE CODES**

| **Status** | **Description** |
| --- | --- |
| 200 OK | Shows if operation succeeded |
| 400 Bad Request | Shows when an invalid request or the requested service is not available |

## Headers

- `Accept` string

## Request body

- object
  - `descriptionBR` string
  - `descriptionDE` string
  - `descriptionDK` string
  - `descriptionEN` string
  - `descriptionES` string
  - `descriptionFR` string
  - `descriptionIT` string
  - `descriptionPT` string
  - `descriptionRU` string
  - `descriptionUS` string
  - `endStatus` boolean
  - `order` integer
  - `won` integer
  - `idParent` integer

## Response `200`

Create Opportunity Status

---

[API](https://skmtc.dev/forcemanager/apis/sage-sales-management-public-api-documentation-for-developer.md) · [All operations](https://skmtc.dev/forcemanager/apis/sage-sales-management-public-api-documentation-for-developer/llms.txt) · [OpenAPI document](https://skmtc.dev/forcemanager/apis/sage-sales-management-public-api-documentation-for-developer/revisions/87db17204e2f?raw)