Confirm Processing of a Message

Use this request to process a message.

This request updates the status to confirmed.

To confirm the processing of a message, use a POST operation and the following URL:

https://{service_url}/api/v1/messages/{messageId}/confirm

where:

{service_url} is the service's URL.
{messageId} is the message ID you want to retrieve. This is explained in the Path parameter section of this topic.

For example:

curl --request POST \
     --url https://e-invoicing-message.vertexcloud.com/api/v1/messages/asidasd%20/confirm \
     --header 'accept: application/json' \
     --header 'content-type: application/json' \
     --data '
{
  "result": true,
  "index": {
    "Custom": "12345"
  },
  "text": "Note to self"
}

Details

Type	Value
Endpoint	`/api/v1/messages`
Method	POST
API Reference Topic	Confirm processing of a message

Path parameter

This path parameter is required:

Field	Details	Description
`messageId`	UUID	Specify the ID of the message that you want to confirm.

Body parameters

Field	Details	Required	Description
`index`	String	No	You can use this field to specify custom field and value pairs.
`result`	Boolean	Yes	If true, indicates that the message processing was successful.
`text`	String	No	You can use this field to add custom text.

Example

Request

curl --request POST \
     --url https://e-invoicing-message.vertexcloud.com/api/v1/messages/asidasd%20/confirm \
     --header 'accept: application/json' \
     --header 'content-type: application/json' \
     --data '
{
  "result": true,
  "index": {
    "Custom": "12345"
  },
  "text": "Note to self"
}

Updated about 18 hours ago