Skip to content
EntitlerDocs

PUT/v1/indexes/{index_key}/values/{month}

Record an index value

Records an index's change for month, in thousandths of a percent from −99,999 to 1,000,000, which indexed prices apply at anniversaries in that month. Replaces the month's value until a subscription applies it; an environment holds at most 50 indexes. Needs customers:write.

curl -X PUT 'https://api.entitler.co/v1/indexes/<index_key>/values/<month>' \
  -H "Authorization: Bearer $ENTITLER_KEY" \
  -H "Content-Type: application/json" \
  -d '{"changeThousandths":1,"target":{"environmentId":"environmentId","projectId":"projectId","teamId":"teamId"}}'

Credentials

Send any one of these:

  • Bearer token

Path parameters

NameTypeDescription
index_keyrequiredstring
monthrequiredstring

Request body

object

  • changeThousandthsinteger (int32)
  • targetProductTarget
    • environmentIdstring
    • projectIdstring
    • teamIdstring

Responses

200The RecordIndexValueResponse message.

RecordIndexValueResponse

  • valueIndexValue
    • appliedAtinteger

      at least 0; at most 18446744073709552000

    • changeThousandthsinteger (int32)required
    • indexKeystringrequired
    • monthstringrequired
    • recordedAtintegerrequired

      at least 0; at most 18446744073709552000

ErrorA refusal, with the HTTP status of its gRPC code.

Error

  • errorobjectrequired
    • codestringrequired
    • parametersobjectrequired

      Each value: string

    • reasonstringor nullrequired