REST RPC APICustomers

Rename grantee

View as Markdown

Renames a grantee belonging to a customer. Only the grantee’s display name can be changed; its external_id is immutable.

Requires Application API Scope authentication.

Authentication

x-api-keystring
API Key authentication via header

Path parameters

merchant_user_idstringRequired
Merchant User ID of the customer who owns the grantee
external_idstringRequired

Merchant-supplied identifier for the grantee

Request

This endpoint expects an object.
namestringRequired<=1024 characters

New display name for the grantee. Leading and trailing whitespace is trimmed; blank or whitespace-only values are rejected.

Response

200
external_idstringOptional
namestringOptional

Errors

400
Bad Request Error
403
Forbidden Error
404
Not Found Error