Skip to content
OpenPostDocs
OpenPostDocs
Voice Profiles

Resolve effective Voice Profiles

Resolves Publication override, account override, then Workspace default in that order.

POST/voice-profiles/effective

Authorization

bearerAuth
AuthorizationBearer <token>

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

curl -X POST "https://example.com/voice-profiles/effective" \  -H "Content-Type: application/json" \  -d '{    "account_ids": [      "string"    ],    "workspace_id": "string"  }'
[  {    "$schema": "https://example.com/api/v1/schemas/EffectiveProfile.json",    "account_id": "string",    "profile": {      "$schema": "https://example.com/api/v1/schemas/VoiceProfile.json",      "assigned_account_ids": [        "string"      ],      "created_at": "2019-08-24T14:15:22Z",      "definition": {        "boundaries": [          "string"        ],        "corrections": [          {            "lesson": "string",            "original": "string",            "preferred": "string"          }        ],        "disliked_patterns": [          "string"        ],        "examples": [          {            "platform": "string",            "text": "string",            "why_it_fits": "string"          }        ],        "expertise": [          "string"        ],        "forbidden_phrases": [          "string"        ],        "formality": "string",        "humor": "string",        "identity_summary": "string",        "interview_answers": [          {            "answer": "string",            "question": "string"          }        ],        "opinions": [          "string"        ],        "preferred_language": "string",        "recurring_expressions": [          "string"        ],        "traits": [          "string"        ],        "vocabulary": [          "string"        ]      },      "id": "string",      "is_default": true,      "name": "string",      "revision": 0,      "schema_version": 0,      "updated_at": "2019-08-24T14:15:22Z",      "workspace_id": "string"    },    "source": "string"  }]