Config

Changed on

Beta feature (not production ready yet) - Builds the transaction payload used to override (or cancel) an existing campaign on-chain, from pre-encoded on-chain args. Requires campaignId and distributionChainId query parameters.

post/v4/config/encode/override

Request

  • Base URL: https://api.merkl.xyz (the document declares no server; this is the origin it was published from)
  • URL: https://api.merkl.xyz/v4/config/encode/override
  • Auth: apiKey (a scheme the document does not define)

Query parameters

campaignIdstring required

The identifier of the campaign to override.

string numeric required
OR
number required

The chain the campaign is distributed on.

Request body

campaignIdstring required
creatorstring required

Address

rewardTokenstring required

Address

amountstring required
campaignTypeinteger required
startTimestampnumber required

Unix timestamp in seconds (not milliseconds).

durationinteger required
campaignDatastring required

Response

Response for status 200

payloadstring required

The transaction payload (EVM: calldata, Stellar: XDR).

Changes

  • 3af328974da5Revision changes
    • info

      added the success response with the status

  • b7784c9a78b9Revision changes
    • warning

      changed the pattern of the request property from ^(0x[a-fA-F0-9]{40}|[1-9A-HJ-NP-Za-km-z]{32,44}|[CG][A-Z0-9]{55})$ to ^(0x[a-fA-F0-9]{40}|[1-9A-HJ-NP-Za-km-z]{32,44}|[CG][A-Z0-9]{55}|0x[a-fA-F0-9]{64})$ (media type: application/json)

    • warning

      changed the pattern of the request property from ^(0x[a-fA-F0-9]{40}|[1-9A-HJ-NP-Za-km-z]{32,44}|[CG][A-Z0-9]{55})$ to ^(0x[a-fA-F0-9]{40}|[1-9A-HJ-NP-Za-km-z]{32,44}|[CG][A-Z0-9]{55}|0x[a-fA-F0-9]{64})$ (media type: application/x-www-form-urlencoded)

    • warning

      changed the pattern of the request property from ^(0x[a-fA-F0-9]{40}|[1-9A-HJ-NP-Za-km-z]{32,44}|[CG][A-Z0-9]{55})$ to ^(0x[a-fA-F0-9]{40}|[1-9A-HJ-NP-Za-km-z]{32,44}|[CG][A-Z0-9]{55}|0x[a-fA-F0-9]{64})$ (media type: multipart/form-data)

    • warning

      changed the pattern of the request property from ^(0x[a-fA-F0-9]{40}|[1-9A-HJ-NP-Za-km-z]{32,44}|[CG][A-Z0-9]{55})$ to ^(0x[a-fA-F0-9]{40}|[1-9A-HJ-NP-Za-km-z]{32,44}|[CG][A-Z0-9]{55}|0x[a-fA-F0-9]{64})$ (media type: application/json)

    • warning

      changed the pattern of the request property from ^(0x[a-fA-F0-9]{40}|[1-9A-HJ-NP-Za-km-z]{32,44}|[CG][A-Z0-9]{55})$ to ^(0x[a-fA-F0-9]{40}|[1-9A-HJ-NP-Za-km-z]{32,44}|[CG][A-Z0-9]{55}|0x[a-fA-F0-9]{64})$ (media type: application/x-www-form-urlencoded)

    • warning

      changed the pattern of the request property from ^(0x[a-fA-F0-9]{40}|[1-9A-HJ-NP-Za-km-z]{32,44}|[CG][A-Z0-9]{55})$ to ^(0x[a-fA-F0-9]{40}|[1-9A-HJ-NP-Za-km-z]{32,44}|[CG][A-Z0-9]{55}|0x[a-fA-F0-9]{64})$ (media type: multipart/form-data)