Substy Developers
A I settings

Save agency banned word

Create or update an agency banned-word rule with its text and active state.

PUT/v1/agencies/{agencyId}/banned-words

Create or update an agency banned-word rule with its text and active state.

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 PUT "https://example.com/v1/agencies/string/banned-words" \  -H "Authorization: Bearer YOUR_API_KEY" \  -H "Content-Type: application/json" \  -d '{    "word": "string"  }'
{  "data": {    "agencyId": "string",    "id": "string",    "createdAt": "2019-08-24T14:15:22Z",    "updatedAt": "2019-08-24T14:15:22Z",    "isActive": true,    "word": "string"  },  "meta": {    "requestId": "string",    "operationId": "3051932a-fdd2-48fa-b330-7e7d41535969",    "status": "COMPLETED"  }}

Search agency banned words GET

Search the agency's banned-word rules by text and active state, using offset and limit for pagination.

Save agency banned words PUT

Create or update up to 1,000 agency banned-word rules in one request.