Skip to main content
POST
/
affiliates
/
encode
Encode IDs
curl --request POST \
  --url https://api.eflow.team/v1/affiliates/encode \
  --header 'Content-Type: application/json' \
  --header 'X-Eflow-Api-Key: <api-key>' \
  --data '
{
  "type": "tracking_link_affiliate",
  "ids": [
    1,
    2,
    3
  ]
}
'
{
  "encoded_values": [
    {
      "id": 123,
      "encoded": "<string>"
    }
  ]
}

Authorizations

​
X-Eflow-Api-Key
string
header
required

The affiliate's API key generated from the Affiliate Portal. Uses the X-Eflow-Api-Key header.

Body

application/json
​
type
enum<string>
required

The encoding context type. Determines how the IDs are encoded.

Available options:
tracking_link_affiliate,
tracking_link_offer,
smart_link_affiliate,
smart_link_smart_link,
signup_affiliate_employee,
signup_advertiser_employee,
signup_affiliate_affiliate
​
ids
integer[]
required

Array of numeric IDs to encode.

Response

200 - application/json

OK

​
encoded_values
object[]

Array of encoded string values corresponding to the input IDs.