/api/applications/{applicationId}/maverick-notes

POST /api/applications/{applicationId}/maverick-notes

Create a Maverick application note

Creates a new note on the Maverick boarding application associated with this application. The application must have been submitted to Maverick (has a maverickApplicationId).

After creating the note in Maverick, this endpoint also syncs the notes back to the local application.

Requires writeApplications permission.

Required Parameters

x-account-id header string

Account ID for the request

applicationId path string

The unique ID of the application

{
  "note": "Requested additional documentation from merchant"
}

{
  "note": "Requested additional documentation from merchant"
}

Try it out

Output:

Responses

Description

Note created successfully

{
  "success": true,
  "note": {
    "id": 0,
    "note": "string",
    "createdOn": "string"
  }
}

Description

Bad request - validation error or application not submitted to Maverick

{
  "error": "Note content is required"
}

Description

Unauthorized - user not authenticated

{
  "error": "Unauthorized"
}

Description

Forbidden - user lacks writeApplications permission

{
  "error": "writeApplications permission is required"
}

Description

Application not found

{
  "error": "Application not found"
}

Description

Internal server error - failed to create note in Maverick

{
  "error": "Failed to create note in Maverick"
}

References

#/components/parameters/xAccountIdHeader

OpenAPI
TypeScript

in: header
name: x-account-id
schema:
  type: string
description: Account ID for the request
required: true
example: "2311"

|
export type xAccountIdHeader = any; // Schema type not fully supported

Or the swagger.yaml spec this documentation was generated from: /applications/[applicationId]/maverick-notes/swagger.yaml