Skip to content
Purser

Map Account

POST
/connections/{connection_id}/map
curl --request POST \
  --url https://example.com/connections/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/map \
  --header 'Content-Type: application/json' \
  --data '{ "account_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "create": { "additionalProperty": "example" }, "external_id": "example" }'

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
connection_id
required
Connection Id
string format: uuid

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
MapRequest
object
account_id
Any of:
string format: uuid
create
Any of:
object
key
additional properties
string
external_id
required
External Id
string

Example generated

{
  "account_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
  "create": {
    "additionalProperty": "example"
  },
  "external_id": "example"
}

Responses

Section titled “Responses”

200

Section titled “200”

Successful Response

Media typeapplication/json
Response Map Account Connections Connection Id Map Post
object
key
additional properties
string

Example generated

{
  "additionalProperty": "example"
}

422

Section titled “422”

Validation Error

Media typeapplication/json
HTTPValidationError
object
detail
Detail
Array<object>
ValidationError
object
ctx
Context
object
input
Input
loc
required
Location
Array
msg
required
Message
string
type
required
Error Type
string

Example generated

{
  "detail": [
    {
      "ctx": {},
      "input": "example",
      "loc": [
        "example"
      ],
      "msg": "example",
      "type": "example"
    }
  ]
}