Sign in
Customers

Revoke agent access

Remove an agent's access to a customer

delete/customers/{customerId}/agents/{agentId}

Path parameters

customerIdstring required

Customer party ID (pty_*).

agentIdstring required

Agent ID (agt_*).

Headers

X-Instance-IDstring nullable

Caller-chosen identifier for the agent run, session, or conversation, required when an agent moves money.

Response

Successful Response

OR

Changes

Changed in 4 of the 28 revisions of this API.812

  • 359d267dca881See the full diff
    • ○

      deleted the header request parameter X-Agent-ID with deprecation

      request-parameter-removed-with-deprecation

  • b1ad79e918ac1See the full diff
    • ○

      header request parameter X-Agent-ID was deprecated

      request-parameter-deprecated

  • 270e233e401c88See the full diff
    • ●

      added the new ACTIVE enum value to the anyOf[subschema #1: CustomerResponse]/data/attributes/delegation/status response property for the response status 200

      response-property-enum-value-added

    • ●

      added the new ACTIVE enum value to the anyOf[subschema #2]/data/attributes/delegation/status response property for the response status 200

      response-property-enum-value-added

    • ●

      added the new EXPIRED enum value to the anyOf[subschema #1: CustomerResponse]/data/attributes/delegation/status response property for the response status 200

      response-property-enum-value-added

    • ●

      added the new EXPIRED enum value to the anyOf[subschema #2]/data/attributes/delegation/status response property for the response status 200

      response-property-enum-value-added

    • ●

      added the new REVOKED enum value to the anyOf[subschema #1: CustomerResponse]/data/attributes/delegation/status response property for the response status 200

      response-property-enum-value-added

    • ●

      added the new REVOKED enum value to the anyOf[subschema #2]/data/attributes/delegation/status response property for the response status 200

      response-property-enum-value-added

    • ●

      added the new SUSPENDED enum value to the anyOf[subschema #1: CustomerResponse]/data/attributes/delegation/status response property for the response status 200

      response-property-enum-value-added

    • ●

      added the new SUSPENDED enum value to the anyOf[subschema #2]/data/attributes/delegation/status response property for the response status 200

      response-property-enum-value-added

    • ○

      added subschema #1: ConnectedAgentLimits to the anyOf[subschema #1: CustomerResponse]/data/attributes/agents/items/limits response property anyOf list for the response status 200

      response-property-any-of-added

    • ○

      added subschema #1: ConnectedAgentLimits to the anyOf[subschema #2]/data/attributes/agents/items/limits response property anyOf list for the response status 200

      response-property-any-of-added

    • ○

      removed TransactionLimits from the anyOf[subschema #1: CustomerResponse]/data/attributes/agents/items/limits response property anyOf list for the response status 200

      response-property-any-of-removed

    • ○

      removed TransactionLimits from the anyOf[subschema #2]/data/attributes/agents/items/limits response property anyOf list for the response status 200

      response-property-any-of-removed

    • ○

      added the required property anyOf[subschema #1: CustomerResponse]/data/attributes/agents/items/handle to the response with the 200 status

      response-required-property-added

    • ○

      added the required property anyOf[subschema #1: CustomerResponse]/data/attributes/delegation/revokedAt to the response with the 200 status

      response-required-property-added

    • ○

      added the required property anyOf[subschema #2]/data/attributes/agents/items/handle to the response with the 200 status

      response-required-property-added

    • ○

      added the required property anyOf[subschema #2]/data/attributes/delegation/revokedAt to the response with the 200 status

      response-required-property-added

  • 8cc2aed458472See the full diff
    • ○

      added the required property anyOf[subschema #1: CustomerResponse]/data/attributes/avatarUrl to the response with the 200 status

      response-required-property-added

    • ○

      added the required property anyOf[subschema #2]/data/attributes/avatarUrl to the response with the 200 status

      response-required-property-added