Partners Portal API
string · uuid · requiredinteger · int32integer · int32string · requiredinteger · int32integer · int32
string · uuid · requiredstring · requiredstringstring
Simulations Message List
GET
https://api-qua-portalparceiros.bancoctt.pt
/v1/simulations/{simulationUniqueId}/message
Obtains all messages associated with a simulation.
path Parameters
simulationUniqueIdSimulation's unique identifier
query Parameters
pageNumberPage number for pagination (default is 1).
Default: 1
pageSizeNumber of items per page for pagination (default is 20).
Default: 20
Headers
AuthorizationBearer token for authentication. Format: Bearer {token}
Simulations Message List › Responses
OK
object[]
totalCountTotal number of messages associated with the simulation
countNumber of messages in the current response
Simulations Message Create
POST
https://api-qua-portalparceiros.bancoctt.pt
/v1/simulations/{simulationUniqueId}/message
SimulationsMessageCreate -> Creates a new message associated to a simulation.
path Parameters
simulationUniqueIdUnique identifier of the simulation
Headers
AuthorizationBearer token for authentication. Format: Bearer {token}
Simulations Message Create › Request Body
subjectSubject of the message
textBody text of the message
Simulations Message Create › Responses
Created
object