Set engagement state

Pauses or starts an engagement.

Parameters

engagementId: ID of engagement to be modified
state: Desired state for engagement (START or PAUSE)
envs: If changing the state to START, list of environments to start the engagement on, defaults to [PRODUCTION]

put/v1/engagement/state

Request

Base URL
https://app.aptrinsic.com
Auth
none declared
TypeScript
https://skmtc.dev/gainsight/apis/gainsight-px-rest-api/docs/v1/engagement/state/put.ts
A function with typed inputs. Its response is checked against the schema.

Request body

engagementIdstring required

ID of engagement to modify

state'START' | 'PAUSE' required

New state for given engagement

envsstring[]

Collection of environments on which to change the state. Defaults to [PRODUCTION]

Response

Success

bodyobject

statusCode'100' | '101' | '102' | '103' | '200' | '201' | '202' | '203' | '204' | '205' | '206' | '207' | '208' | '226' | '300' | '301' | '302' | '303' | '304' | '305' | '307' | '308' | '400' | '401' | '402' | '403' | '404' | '405' | '406' | '407' | '408' | '409' | '410' | '411' | '412' | '413' | '414' | '415' | '416' | '417' | '418' | '419' | '420' | '421' | '422' | '423' | '424' | '426' | '428' | '429' | '431' | '451' | '500' | '501' | '502' | '503' | '504' | '505' | '506' | '507' | '508' | '509' | '510' | '511'

statusCodeValueinteger

Changes

No recorded changes to this operation across all 1 revision of this API.