Update a deploy

PATCH

/v1/deploys/{deployId}

curl --request PATCH \
  --url https://api.presscloud.example/v1/deploys/example \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "slug": "example", "name": "example" }'

Updates deploy-level basic metadata such as name and slug. Provide at least one field.

Authorizations

• bearerAuth

Parameters

Path Parameters

deployId

required

string

>= 1 characters

Request Body ^required

Media type application/json

Any of:

object

object

slug

required

string

>= 1 characters

name

string

>= 1 characters

object

object

slug

string

>= 1 characters

name

required

string

>= 1 characters

Example ^generated

{
  "slug": "example",
  "name": "example"
}

Responses

200

Updated deploy detail.

Media type application/json

object

deploy

required

object

id

required

string

accountId

required

string

slug

required

string

name

required

string

createdAt

required

integer

Example ^generated

{
  "deploy": {
    "id": "example",
    "accountId": "example",
    "slug": "example",
    "name": "example",
    "createdAt": 1
  }
}

404

Requested resource was not found.

Media type application/json

object

error

required

string

message

required

string

Example ^generated

{
  "error": "example",
  "message": "example"
}

409

Requested operation conflicts with the current resource state.

Media type application/json

object

error

required

string

message

required

string

Example ^generated

{
  "error": "example",
  "message": "example"
}