Skip to content
EntitlerDocs

PUT/v1/customers/{external_id}/release-channel

Assign a customer to a release channel

Puts the customer on the release channel named by releaseChannelId; leaving it absent assigns the default release channel. A closed or missing release channel is refused. Needs release_channels:assign.

curl -X PUT 'https://api.entitler.co/v1/customers/ada/release-channel' \
  -H "Authorization: Bearer $ENTITLER_KEY" \
  -H "Content-Type: application/json" \
  -d '{"releaseChannelId":"releaseChannelId","target":{"environmentId":"environmentId","projectId":"projectId","teamId":"teamId"}}'

Credentials

Send any one of these:

  • Bearer token

Path parameters

NameTypeDescription
external_idrequiredstring

Request body

object

  • releaseChannelIdstring
  • targetProductTarget
    • environmentIdstring
    • projectIdstring
    • teamIdstring

Responses

200The AssignReleaseChannelResponse message.

AssignReleaseChannelResponse

  • assignmentCustomerReleaseChannel
    • customerIdstringrequired
    • externalIdstringrequired
    • modeModerequired

      One of MODE_UNSPECIFIED, MODE_LIVE, MODE_TEST.

    • previousReleaseChannelIdstring
    • releaseChannelIdstring
    • revisionintegerrequired

      at least 0; at most 18446744073709552000

    • sourceAssignmentSourcerequired

      One of ASSIGNMENT_SOURCE_UNSPECIFIED, ASSIGNMENT_SOURCE_SERVER, ASSIGNMENT_SOURCE_DASHBOARD.

  • changedbooleanrequired
  • endedTestHoldingsinteger (int64)required

    at least 0; at most 4294967295

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

Error

  • errorobjectrequired
    • codestringrequired
    • parametersobjectrequired

      Each value: string

    • reasonstringor nullrequired