Substy Developers
Team

Rename team member

Change an agency employee's display name without changing their login identity.

PATCH/v1/agencies/{agencyId}/team/employees/{employeeId}/display-name

Change an agency employee's display name without changing their login identity.

Authorization

bearerAuth
AuthorizationBearer <token>

In: header

Path Parameters

agencyId*string
Length1 <= length
employeeId*string

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X PATCH "https://example.com/v1/agencies/string/team/employees/string/display-name" \  -H "Authorization: Bearer YOUR_API_KEY" \  -H "Content-Type: application/json" \  -d '{    "displayName": "string"  }'
{  "data": {    "employeeId": "string",    "displayName": "string"  },  "meta": {    "requestId": "string",    "operationId": "3051932a-fdd2-48fa-b330-7e7d41535969",    "status": "COMPLETED"  }}

Set team member role PUT

Change an existing agency employee's role to one the current account can grant.

Remove team member DELETE

Remove an employee's membership from the agency, subject to role and ownership restrictions.