POST
/
api
/
v1
/
brand-coding
const response = await api.coding.createBrandJob({
  surveyIdentifier: 'CSAT-2024-Q1',
  surveyName: 'Customer Satisfaction',
  surveyDescription: 'Tracking customer satisfaction and loyalty',
  surveyResponses: [
    {
      questionIdentifier: 'Q1',
      question: 'What did you like about our service?',
      brandContext: {
        industryDescription: 'E-commerce retail',
        brands: [
          { name: 'Acme Store', variations: ['Acme', 'AcmeOnline'] }
        ]
      },
      responseEntries: [
        {
          responseIdentifier: '12345',
          answer: 'The customer service representatives were very helpful.',
          followupResponses: [
            { question: 'Which rep assisted you?', answer: 'Alice from support' }
          ]
        }
      ]
    }
  ]
});
{
  "batchJobId": "123e4567-e89b-12d3-a456-426614174001",
  "surveyIdentifier": "CSAT-2024-Q1",
  "status": "queued",
  "results": null
}

Authorizations

X-Aftercare-Key
string
header
required

API key for authentication

Body

application/json

Response

202
application/json

Brand coding job accepted

The response is of type object.