Substy Developers
Account and agency

Rename agency

Replace the selected agency’s name and return its updated profile. Requires current permission to edit agency settings; this does not select or rename another agency.

PATCH/v1/agencies/{agencyId}/profile

Replace the selected agency’s name and return its updated profile. Requires current permission to edit agency settings; this does not select or rename another agency.

Authorization

bearerAuth
AuthorizationBearer <token>

In: header

Path Parameters

agencyId*string
Length1 <= length

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/profile" \  -H "Authorization: Bearer YOUR_API_KEY" \  -H "Content-Type: application/json" \  -d '{    "name": "string"  }'
{  "data": {    "id": "string",    "name": "string",    "slug": "string",    "imageUrl": "string"  },  "meta": {    "requestId": "string",    "operationId": "3051932a-fdd2-48fa-b330-7e7d41535969",    "status": "COMPLETED"  }}

Get agency profile GET

Read the selected agency’s ID, name, slug and imageUrl. Use its exact name as confirmation when requesting agency deletion.

Create agency POST

Create an agency owned by the authenticated user using the supplied name. Returns its ID and profile, subject to account agency-creation limits. The selected agency supplies the current permission context; approve a separate connection to the newly created agency before managing it.