--- title: "Forward Incoming Subscriber Message" method: PATCH path: "/partyInteraction/{id}" tags: ["Tmf683PartyInteraction"] --- # Forward Incoming Subscriber Message `PATCH /partyInteraction/{id}` ## Request - Base URL: `https://api.mtn.com/v1` - URL: `https://api.mtn.com/v1/partyInteraction/{id}` - Auth: OAuth 2 - Client credentials - Token URL: `https://api.mtn.com/v1/oauth/access_token` - TypeScript: (a function with typed inputs; its response is checked against the schema) This operation forwards an Agent message to a Subscriber (conversation). Maps to PATCH /zigi/v1/conversations/{id}/messages on the backend. ## Path parameters - `id` string, required ## Headers - `systemId` string - `transactionId` string - `x-country-code` string ## Request body - object - `creationDate` string - `id` string - `href` string - `interactionDate` ComMtnAggregatorModelsRequestInteractionDate - `startDateTime` string - `description` string - `reason` string - `requestType` string - `externalIdentifier` ComMtnAggregatorModelsRequestExternalIdentifier - `id` string - `owner` string - `externalIdentifierType` string - `status` string - `direction` string - `relatedParty` ComMtnAggregatorModelsRequestRelatedParty[] - `role` string - `id` string - `@referredType` string - `@schemaLocation` string - `href` string - `name` string - `engagedParty` object - `id` string - `@referredType` string - `@schemaLocation` string - `href` string - `partyOrPartyRole` object - `id` string - `name` string - `@type` string - `@referredType` string - `href` string - `relatedChannel` object[] - `id` string - `channel` object - `name` string - `role` string - `id` string - `@referredType` string - `@schemaLocation` string - `href` string - `interactionItem` object[] - `id` string - `item` object - `id` string - `href` string - `customFields` object - `productOrderGroup` string[] - `registrationType` string - `externalSystem` object[] - `id` string - `system` string - `@type` string - `@baseType` string - `@baseType` string - `@type` string - `@schemaLocation` string - `request` object - `id` string - `@referredType` string - `@baseType` string - `@schemaLocation` string - `href` string - `createdDate` string - `orderItem` object[] - `id` string - `href` string - `action` string - `actionSubType` string - `productOffering` object - `id` string - `href` string - `externalSystem` ComMtnAggregatorModelsRequestExternalSystem[] - `id` string - `system` string - `@type` string - `@baseType` string - `name` string - `category` object[] - `name` string - `version` string - `id` string - `@referredType` string - `@schemaLocation` string - `href` string - `@type` string - `@schemaLocation` string - `product` object - `id` string - `href` string - `customFields` ComMtnAggregatorModelsRequestCustomFields - `productOrderGroup` string[] - `registrationType` string - `externalSystem` ComMtnAggregatorModelsRequestExternalSystem[] - `id` string - `system` string - `@type` string - `@baseType` string - `name` string - `startDate` string - `status` string - `createdDate` string - `modifiedDate` string - `businessType` string - `technology` string - `publicIdentifier` string - `productSpecification` object - `id` string - `@referredType` string - `@baseType` string - `@type` string - `@schemaLocation` string - `href` string - `name` string - `version` string - `technology` string[] - `LoB` string - `productOffering` ComMtnAggregatorModelsRequestProductOffering - `id` string - `href` string - `externalSystem` ComMtnAggregatorModelsRequestExternalSystem[] - … - `name` string - `category` object[] - … - `@type` string - `@schemaLocation` string - `productOrder` object[] - `orderItemId` string - `orderItemAction` string - `id` string - `@referredType` string - `@schemaLocation` string - `href` string - `channel` ComMtnAggregatorModelsRequestChannel[] - `name` string - `role` string - `id` string - `@referredType` string - `@schemaLocation` string - `href` string - `relatedParty` ComMtnAggregatorModelsRequestRelatedParty[] - `role` string - `id` string - `@referredType` string - `@schemaLocation` string - `href` string - `name` string - `engagedParty` object - … - `partyOrPartyRole` object - … - `productRelationship` object[] - `product` ComMtnAggregatorModelsRequestProduct - … - `type` string - `relationshipType` string - `productPrice` object[] - `href` string - `priceType` string - `price` object - … - `@schemaLocation` string - `productTerm` object[] - `description` string - `status` string - `validFor` object - … - `@type` string - `activationDate` string - `imsiNumber` string - `simNumber` string - `@baseType` string - `@type` string - `@schemaLocation` string - `isCustomerVisible` boolean - `LoB` string - `xDir` string - `productSpecification` ComMtnAggregatorModelsRequestProductSpecification - `id` string - `@referredType` string - `@baseType` string - `@type` string - `@schemaLocation` string - `href` string - `name` string - `version` string - `technology` string[] - `LoB` string - `modifiable` boolean - `@schemaLocation` string - `channel` ComMtnAggregatorModelsRequestChannel[] - `name` string - `role` string - `id` string - `@referredType` string - `@schemaLocation` string - `href` string - `modifiedDate` string - `state` string - `relatedParty` ComMtnAggregatorModelsRequestRelatedParty[] - `role` string - `id` string - `@referredType` string - `@schemaLocation` string - `href` string - `name` string - `engagedParty` object - `id` string - `@referredType` string - `@schemaLocation` string - `href` string - `partyOrPartyRole` object - `id` string - `name` string - `@type` string - `@referredType` string - `href` string - `modifiable` boolean - `orderDate` string - `cancellable` boolean - `requestedStartDate` string - `role` string - `interactionItemType` string - `note` ComMtnAggregatorModelsRequestNote[] - `id` string - `text` string - `creationDate` string - `actionDate` string - `reasonCode` string - `reason` string - `csrUserName` string - `csrUserId` string - `prefLang` string - `location` string - `externalUser` string - `channel` ComMtnAggregatorModelsRequestChannel[] - `name` string - `role` string - `id` string - `@referredType` string - `@schemaLocation` string - `href` string - `note` ComMtnAggregatorModelsRequestNote[] - `id` string - `text` string - `customerId` string - `productId` string[] - `publicIdentifier` string[] - `productOrderId` string[] - `createdDate` string - `modifiedDate` string - `@baseType` string - `@type` string - `@schemaLocation` string - `retryable` boolean - `retryableCount` integer - `systemId` string - `countryCode` string - `path` string ## Response `200` HTTP 200 indicating the request succeeded; the response body follows the documented schema for this operation and includes correlation identifiers where applicable for traceability across MTN MADAPI tmf683 party interaction flows. - object - `statusCode` string - `statusMessage` string - `supportMessage` string - `transactionId` string - `error` object - `timestamp` string - `status` string - `error` string - `message` string - `path` string - `existingResourceId` string - `data` object ## Other responses - `400`: Bad request. Invalid request parameters, missing required fields, or validation errors. - `401`: Unauthorized. Invalid or missing authorization credentials, insufficient permissions, or authentication failure. - `403`: Forbidden. Access denied. The request is valid but the server refuses to perform it. - `404`: Not found. The requested resource was not found or does not exist. - `500`: Internal server error. Unexpected system failure, database connectivity issues, or external service integration problems. - `502`: Bad gateway. The server acting as a gateway received an invalid response from an upstream server. - `503`: Service unavailable. The server is temporarily unable to handle the request due to maintenance or overload. --- [API](https://skmtc.dev/mtn/apis/tmf683-party-interaction.md) - [All operations](https://skmtc.dev/mtn/apis/tmf683-party-interaction/llms.txt) - [OpenAPI document](https://skmtc.dev/mtn/apis/tmf683-party-interaction/revisions/6fe280d55cb2?raw)