Set start day of the week

This API allows you to set the org's start day of the week.

๐Ÿ‘

Note

  • For detailed information about our APIs and for hands-on testing, refer documentation in API overview and step-by-step guide on making your first API call in Make your first API call .

Prerequisites

  • Authentication: Basic or OAuth authentication
  • Default access group

Resource information

URIapi_gateway/rewards/core/v1/brand/config
HTTP MethodPOST
PaginationNo
Batch supportNo
Rate limit informationNone

API endpoint example

https://eucrm.cc.capillarytech.com/api_gateway/rewards/core/v1/brand/config

Request body parameters

ParameterData TypeDescription
configKeyNameStringThe name of the configuration setting: CONF_START_OF_THE_WEEK_FOR_ORG_RESTRICTION
configKeyValueEnumThe value of the configuration setting. Supported values: MONDAY, TUESDAY, WEDNESDAY, THURSDAY, FRIDAY, SATURDAY, SUNDAY.
By default, the start day will be MONDAY.
brandIdIntegerYou can use the API and retrieve the brand ID of your brand.
labelStringA descriptive note or label regarding the start date of the restriction.
{
    "configKeyName": "CONF_START_OF_THE_WEEK_FOR_ORG_RESTRICTION",
    "configKeyValue": "SUNDAY",
    "brandId": 47,
    "label": ""
}

Response parameters

ParameterData TypeDescription
successBooleanIndicates if the API call was successful.
codeIntegerA code representing the API status.
messageStringA description of the API call.
configKeyNameStringThe name of the configuration setting.
configKeyValueStringThe value assigned to the configuration setting.
brandIdIntegerYou can use the API and retrieve the brand ID of your brand.
labelStringA descriptive label explaining the configuration setting, its implications, and the context where it applies.
{
    "status": {
        "success": true,
        "code": 3008,
        "message": "Org config updated successfully"
    },
    "configList": [
        {
            "configKeyName": "CONF_START_OF_THE_WEEK_FOR_ORG_RESTRICTION",
            "configKeyValue": "TUESDAY",
            "brandId": null,
            "label": "Add the start of the week for the org level restrictions, this will be applied to all org level restrictions with Week configurations"
        }
    ]
}

API- specific errors

Error codeDescription
3004Brand not found. Pass a valid brand identifier.
Language
Authorization
Basic
base64
:
URL
Click Try It! to start a request and see the response here!