Associate App Customization Configuration API (v1)
Download OpenAPI specification:Download
Use this API to retrieve and update the current customization configuration for NewStore Associate App set up for your business.
Get NewStore Associate App customization configuration
Returns the current customization configuration for the NewStore Associate App in your business.
Responses
Response samples
- 200
Content type
application/json
{- "customizations": [
- {
- "id": "string",
- "label": "string",
- "enabled": true,
- "slot": "string",
- "type": "deeplink",
- "url": "string"
}
]
}Retrieve specific NewStore Associate App customization configuration
Returns the configuration of a specific customization.
Authorizations:
newStoreAccessToken
path Parameters
| customization_id required | any (Id of a particular customization) |
Responses
Response samples
- 200
Content type
application/json
Example
{- "label": "string",
- "enabled": true,
- "slot": "string",
- "type": "deeplink",
- "url": "string"
}Update NewStore Associate App customization configuration
Updates and replaces the customization configuration values for a given id.
Authorizations:
newStoreAccessToken
path Parameters
| customization_id required | any (Id of a particular customization) |
Request Body schema: application/json
One of
| label required | string |
| enabled required | boolean |
| slot required | string |
| type required | any Value: "deeplink" |
| url required | string |
Responses
Request samples
- Payload
Content type
application/json
Example
{- "label": "string",
- "enabled": true,
- "slot": "string",
- "type": "deeplink",
- "url": "string"
}Response samples
- 200
Content type
application/json
Example
{- "label": "string",
- "enabled": true,
- "slot": "string",
- "type": "deeplink",
- "url": "string"
}