Update placement status

PUT

/api/nova/placements/{placementId}/status

Changes the status of the placement given by the placementId path variable. The JSON body must contain a statusId identifying the new status and may include optional comments; the service resolves the full status from the statusId. Authenticated by an apiKey query parameter tied to an API user whose visibility rules apply. Returns the placement id with a confirmation message on success. Responds with 400 if statusId is blank, 404 if the placement is not found or not visible or the statusId does not match a placement status in the account, 401 if the apiKey is invalid, 429 when rate limited, and 500 on unexpected failures.

Authorizations

privateApiKey

Type

API Key (query: apiKey)

Parameters

Path Parameters

placementId*

placementId

Type

string

Required

Query Parameters

apiKey*

apiKey

Type

string

Required

Request Body

application/json

{

  

"comments": "string",

  

"reasonId": "string",

  

"statusId": "string"

}

Responses

OK

Content-Type

application/json

{

  

"data": "string",

  

"error": "string",

  

"message": "string",

  

"requestId": "string",

  

"success": true

}

PUT

/api/nova/placements/{placementId}/status

Playground

Authorization

privateApiKey

Variables

Key

Value

placementId*

apiKey*

Body

Samples