Update Campaign

Purpose: Specifies the campaign to be used for the application.

---

Endpoint Details

• HTTP Verb: PATCH
• URL Segment: /v3/order/{orderId}/campaign
• OpenAPI Spec: View in Swagger UI
• Notes: Allowed only if status is Approved. The campaignId must be one of the values listed in the selectableCampaigns field. |

---

Path Parameters

Field Name	Description	Type	Additional Information
orderId	The unique ID of the order to update.	string ($uuid)	Required.

---

Request Body (UpdateCampaignRequest)

This method requires a JSON body containing the new campaign ID.

Field Name	Description	Type	Additional Information
campaignId	The ID of the campaign to be selected.	integer	Required. Must be one of the selectableCampaigns.

---

Example Request

{
  "campaignId": 100002
}

---

Successful Response (200 OK)

The API returns an OrderResponse object containing the updated Order.

For schema and examples, see the OrderResponse Schema page.

---

Error Responses

Status Code	Description
400 Bad Request	The request was invalid (e.g., the specified campaignId is not selectable or order status is not Approved).
401 Unauthorized	Authentication failure (e.g., missing or invalid API key/credentials).
404 Not Found	The specified orderId does not exist.