DELETE/v1/customers/{external_id}

Delete a customer

Deletes the customer with this external ID and returns it as it was. A repeat is refused as not found, and registering the external ID again creates a new customer. Needs customers:write.

curl -X DELETE 'https://api.entitler.co/v1/customers/ada' \
  -H "Authorization: Bearer $ENTITLER_KEY"

Credentials

Send any one of these:

Bearer token

Path parameters

Name	Type	Description
`external_id`required	string

Query parameters

Name	Type	Description
`target.team_id`	string
`target.project_id`	string
`target.environment_id`	string
`expected_revision.value`	integer

Responses

`200`The DeleteCustomerResponse message.

DeleteCustomerResponse

customerCustomer
- attributesarray of CustomerAttributerequired
  - keystringrequired
  - setAtintegerrequired
    at least 0; at most 18446744073709552000
  - setBycommon.Actor
    - idstringrequired
    - typecommon.ActorTyperequired
      One of ACTOR_TYPE_UNSPECIFIED, ACTOR_TYPE_USER, ACTOR_TYPE_KEY, ACTOR_TYPE_SYSTEM.
  - sourceCustomerAttributeSourcerequired
    One of CUSTOMER_ATTRIBUTE_SOURCE_UNSPECIFIED, CUSTOMER_ATTRIBUTE_SOURCE_BUSINESS, CUSTOMER_ATTRIBUTE_SOURCE_CUSTOMER.
  - stateCustomerAttributeStaterequired
    One of CUSTOMER_ATTRIBUTE_STATE_UNSPECIFIED, CUSTOMER_ATTRIBUTE_STATE_FREE_FORM, CUSTOMER_ATTRIBUTE_STATE_VALID, CUSTOMER_ATTRIBUTE_STATE_EXPIRED, CUSTOMER_ATTRIBUTE_STATE_INVALID.
  - untilinteger
    at least 0; at most 18446744073709552000
  - valuestringrequired
  - verifiedAtinteger
    at least 0; at most 18446744073709552000
  - verifiedBycommon.Actor
    - idstringrequired
    - typecommon.ActorTyperequired
      One of ACTOR_TYPE_UNSPECIFIED, ACTOR_TYPE_USER, ACTOR_TYPE_KEY, ACTOR_TYPE_SYSTEM.
- blockedAtinteger
  at least 0; at most 18446744073709552000
- blockedReasonCustomerBlockReasonrequired
  One of CUSTOMER_BLOCK_REASON_UNSPECIFIED, CUSTOMER_BLOCK_REASON_PAYMENT_REVERSED.
- createdAtintegerrequired
  at least 0; at most 18446744073709552000
- emailstring
- environmentIdstringrequired
- externalIdstringrequired
- idstringrequired
- identityProviderIdstring
- marketIdstring
- moneyCustomerMoneyrequired
  One of CUSTOMER_MONEY_UNSPECIFIED, CUSTOMER_MONEY_REAL, CUSTOMER_MONEY_TEST.
- namestring
- projectIdstringrequired
- revisionintegerrequired
  at least 0; at most 18446744073709552000
- trackIdstring
- updatedAtintegerrequired
  at least 0; at most 18446744073709552000

`Error`A refusal, with the HTTP status of its gRPC code.

Error

errorobjectrequired
- codestringrequired
- parametersobjectrequired
  Each value: string
- reasonstringor nullrequired