Meta-data

The method allows you to set the meta-data for the address. The field type is free, you can set any value

Examples of the request body:

{
  "id": "...",
  "meta": 199
}

{
  "id": "...",
  "meta": [1,2,3,4]
}

{
  "id": "...",
  "meta": "some str"
}

{
  "id": "...",
  "meta": ["one", "two"]
}

{
  "id": "...",
  "meta": {
    "arr": ["1","2"],
    " some": "field"
  }
}

{
  "id": "...",
  "meta": null
}

Meta-data

POSThttps://app.apollopayment.io/api-gateway/addresses/set-meta

Header parameters

Body

application/json

id*string

ID of the address in the system

Example: "d08ba5d4-c055-4ede-85c4-a007acf72e6b"

meta*objectarraystringnull

Example: "some meta-data, allow free format (string, array, object etc)"

Response

200

Body

application/json

success*boolean

Request success indicator

response*null

Request

JavaScriptCurlPython

const response = await fetch('https://app.apollopayment.io/api-gateway/addresses/set-meta', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "id": "d08ba5d4-c055-4ede-85c4-a007acf72e6b",
      "meta": "some meta-data, allow free format (string, array, object etc)"
    }),
});
const data = await response.json();

Response

200

{
  "success": false,
  "response": null
}