API ReferenceCompanions

/public/companions/{companionId}

PATCH
/public/companions/{companionId}

Path Parameters

companionId*string

Header Parameters

X-API-Version?string

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

curl -X PATCH "https://companion-api.napster.com/public/companions/string" \  -H "Content-Type: application/json" \  -d '{}'
{
  "id": "string",
  "firstName": "string",
  "lastName": "string",
  "previewUrl": "string",
  "videoLoopUrl": "string",
  "gender": "string",
  "ethnicity": "string",
  "assistantPrompt": "string",
  "status": "pending",
  "tags": {
    "property1": "string",
    "property2": "string"
  }
}
{
  "code": "string",
  "description": "string",
  "type": "failure",
  "numericType": 0
}