gainsight-px-rest-api
PUT /v1/engagement/envs

Move engagement between environments.

Parameters

  • engagementId: ID of engagement to be modified
  • envs: Which environments to set the engagement to. Valid values: Production,Stage,QA,Integration (case insensitive)
application/json

Body Required

Engagement Environments Change Request

  • engagementId string Required

    ID of engagement to modify

  • envs array[string] Required

    Collection of environments

    Values are PRODUCTION, INTEGRATION, QA, or STAGE.

Responses

  • 200 application/json

    Success

    Hide response attributes Show response attributes object
    • errors array[string]
    • status integer(int32)
  • 400

    Bad request

  • 401

    Unauthorized or bad API Key

  • 404

    Account not found

  • 429

    Rate limit exceeded

PUT /v1/engagement/envs 
curl \
 --request PUT 'https://api.aptrinsic.com/v1/engagement/envs' \
 --header "Content-Type: application/json" \
 --data '{"engagementId":"string","envs":["PRODUCTION"]}'
Request examples 
{
  "engagementId": "string",
  "envs": [
    "PRODUCTION"
  ]
}
Response examples (200) 
{
  "errors": [
    "string"
  ],
  "status": 42
}