docs
  1. Admin Api
  2. Resources
  3. Promotions
  4. Audiences
  5. Update Audience

Update audience

Update an audience

Path Parameters

ParameterDetails
audienceId
  • required
  • MinLength: 24
  • MaxLength: 24
string
Example:
645e0c241a93369ff53f26e0

Request body

required
ParameterDetails
name
  • required
  • MinLength: 3
string
Example:
VIP customers
description
  • required
  • MinLength: 3
string
Example:
German VIP Customers from Hamburg only
customerIds
  • required
integer
Example:
345,456,567

Responses

200
Audience was successfully updated.
application/json
Success
id
string
Example:
645e0c241a93369ff53f26e0
namerequired
string
Example:
VIP customers
descriptionrequired
string
Example:
German VIP Customers from Hamburg only
companyIdsrequired
Array of integer
customerIdsrequired
Array of integer
createdAt
string
Example:
2023-05-10T10:00:00.000Z
updatedAt
string
Example:
2023-05-10T10:00:00.000Z
400
Bad Request
application/json
Error
401
Unauthorized
application/json
Error
404
Not Found
application/json
Error
PUT/promotions/audiences/{audienceId}

Request samples

Response samples

200
Audience:
Content type: application/json
Provide Feedback