Skip to main content
POST

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

environmentKey
string
required

The environment identifier, e.g. 'production'.

key
string
required

The branch key.

Body

application/json

The request message for proposing changes from a branch environment.

environmentKey
string

The environment identifier, e.g. 'production'.

key
string

The branch key.

title
string

The title of the proposal.

body
string

The body of the proposal.

draft
boolean

The draft status of the proposal.

Response

200 - application/json

OK

The details of a proposal.

url
string

The URL of the proposal in the source control management system.

state
enum<string>

The state of the proposal.

Available options:
PROPOSAL_STATE_UNKNOWN,
PROPOSAL_STATE_OPEN,
PROPOSAL_STATE_MERGED,
PROPOSAL_STATE_CLOSED