PUT /v2/partnerSubscription/{id}

Content

• Description
• Parameters
• Request
• Response
• Example
• Revision History

Description

Updates a specific partner subscription record.

Note: This API is only available for partners.

Parameters

Parameter	Type	Required	Description
X-API-KEY	String (header)	Mandatory	The X-API-KEY parameter is the authorization key for the organization. It is obtained from the MarketONE Developer Portal.
Content-Type	String (header)	Mandatory	The Content-Type parameter is the content-type of the request body.
X-B3-TraceId	String (header)	Optional	The X-B3-TraceId parameter is the TraceId that indicates the overall id of the trace. Every span in a trace shares this id. The X-B3-TraceId header is encoded as 32 or 16 lower-hex characters. For example, a 128-bit TraceId header might look like this: 463ac35c9f6413ad48485a3953bb6124.
X-B3-SpanId	String (header)	Optional	The X-B3-SpanId parameter is a 64-bit SpanId that indicates the position of the current operation in the trace tree. The value should not be interpreted; it may or may not be derived from the value of the TraceId. The X-B3-SpanId header is encoded as 16 lower-hex characters. For example, a SpanId header might look like this: a2fb4a1d1a96d312. Note: Unless propagating only the Sampling State, the X-B3-SpanId header is required.
X-B3-ParentSpanId	String (header)	Optional	The X-B3-ParentSpanId parameter is a 64-bit ParentSpanId that indicates the position of the parent operation in the trace tree. When the span is the root of the trace tree, there is no ParentSpanId. The X-B3-ParentSpanId header may be present on a child span and must be absent on the root span. It is encoded as 16 lower-hex characters. For example, a ParentSpanId header might look like this: 0020000000000001.
id	String (path)	Mandatory	The id parameter is the MarketONE id of the partner subscription record to be retrieved.

Request

Parameter	Type	Required	Description
servicesStatus	String	Mandatory	The servicesStatus parameter when ACTIVE inidicates that the service entitlement has been successfully provisioned, and a partner service user claimed it. Enum: Array [ ACTIVE ]

Response

Parameter	Type	Required	Description
Status: 200 - OK
Status: 4xx
Error Type Required Description code String(maxSize: 50) Optional The code is the error code for the status. message String(maxSize: 256) Optional The message is the error description. validationErrors String(maxSize: 256) Optional The validationErrors is the validation errors. debugTrace String(maxSize: 256) Optional The debugTrace is the debug trace.
Status: 400 - Bad request
Status: 401 - Authorization failure
Status: 403 - Permissions denied
Status: 404 - Not found
Status: 409 - Conflict
Status: 500 - Internal server error
Status: 501 - Not implemented

Example

Request

PUT /v2/partnerSubscription/{id}
Content-Type: application/json
X-API-KEY: "string"
{
  "servicesStatus": "string"
}

Response

HTTP/1.1 200 OK

Error

{
  "code": "string",
  "message": "string",
  "validationErrors": [
    null
  ],
  "debugTrace": [
    "string"
  ]
}

Note: See the MarketONE Developer Portal for an OpenAPI instance of the MarketONE APIs.

Revision History

Version	Description
20.01.03	Added this topic.