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

post

/api-gateway/addresses/set-meta

Header parameters

x-api-public-keystring

Public API-key

x-api-signaturestring

Signing the request body with a private API-key

Content-typestring

Request content type

Example: application/json

Body

idstringrequired

ID of the address in the system

Example: 37e61abd-81cd-48fa-977d-c2ac9730ee50

metaobject | array | string | nullrequired

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

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://app.apollopayment.io/api-gateway/addresses/set-meta' \
  --header 'Content-Type: application/json' \
  --data '{
    "id": "37e61abd-81cd-48fa-977d-c2ac9730ee50",
    "meta": "some meta-data, allow free format (string, array, object etc)"
  }'

200

200

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