Developers / API v3.0 / Addon Groups (addon_group)

Addon Groups (addon_group)

Addon groups are created first, then referenced by items using addon_group_id.

Auth

  • All addon_group endpoints require authorization:
    • Authorization: Bearer {{oauth_access_token}}, or
    • mobstep-customer-token: {{customer_token}}

Base URL

  • {{base_path}}{{api_v3_path}}/addon_group

Notes

  • Friendly entity names are supported in URLs (example: /addon_group).
  • Legacy internal names (example: /apps_addon_group) are still accepted.
GET

GET Addon Groups (Auth required)

URL
https://mobstep.com/api/v3.0/addon_group?fields=id,uuid,application_id,name,is_required,min_selections,max_selections,langcode,created,changed
Fields
Name Description
id -
uuid -
application_id -
name -
is_required -
min_selections -
max_selections -
langcode -
created -
changed -
Headers
Name Value Description
Authorization Bearer {{oauth_access_token}} -
mobstep-customer-token {{customer_token}} -
POST

POST Addon Groups: Create (Auth required)

URL
https://mobstep.com/api/v3.0/addon_group
Headers
Name Value Description
Content-Type application/json -
Authorization Bearer {{oauth_access_token}} -
mobstep-customer-token {{customer_token}} -
Body
{
  "name": "Sauces",
  "application_id": {{application_id}},
  "is_required": false,
  "min_selections": 0,
  "max_selections": 3
}
DELETE

DELETE Addon Groups (Auth required)

URL
https://mobstep.com/api/v3.0/addon_group/{{api_entity_id}}
Headers
Name Value Description
Authorization Bearer {{oauth_access_token}} -
mobstep-customer-token {{customer_token}} -