Skip to main content

Map Tenant To Product

PATCH /api/v1/tenants/:tenantId/products/:productId/map

Description

Map a tenant to a product with the specified configuration.

Request

  • Authentication:

    • Type: Bearer Token

    • Token: {{bearerToken}} (Replace with the actual bearer token)

  • Headers:

    • Content-Type: application/json
  • URL:

    • Raw URL: /api/v1/tenants/:tenantId/products/:productId/map

    • Host:

    • Path: /api/v1/tenants/:tenantId/products/:productId/map

    • Variables:

      • tenantId: (Required)

      • productId: (Required)

Headers

Content-TypeValue
Content-Typeapplication/json

Body (raw)

{
"userId": "<string>",
"services": [
{
"serviceId": "<string>",
"servicesConfig": [
{
"label": "<string>",
"key": "<string>",
"value": "<string>",
"required": "<boolean>",
"valueType": "array-email",
"formType": "multi-select",
"formOptions": [
{
"label": "<string>",
"value": "<string>",
"key": "<string>"
},
{
"label": "<string>",
"value": "<string>",
"key": "<string>"
}
]
},
{
"label": "<string>",
"key": "<string>",
"value": "<string>",
"required": "<boolean>",
"valueType": "string",
"formType": "multi-select",
"formOptions": [
{
"label": "<string>",
"value": "<string>",
"key": "<string>"
},
{
"label": "<string>",
"value": "<string>",
"key": "<string>"
}
]
}
]
},
{
"serviceId": "<string>",
"servicesConfig": [
{
"label": "<string>",
"key": "<string>",
"value": "<string>",
"required": "<boolean>",
"valueType": "base64",
"formType": "input",
"formOptions": [
{
"label": "<string>",
"value": "<string>",
"key": "<string>"
},
{
"label": "<string>",
"value": "<string>",
"key": "<string>"
}
]
},
{
"label": "<string>",
"key": "<string>",
"value": "<string>",
"required": "<boolean>",
"valueType": "url",
"formType": "input",
"formOptions": [
{
"label": "<string>",
"value": "<string>",
"key": "<string>"
},
{
"label": "<string>",
"value": "<string>",
"key": "<string>"
}
]
}
]
}
],
"themesConfig": [
{
"label": "<string>",
"key": "<string>",
"value": "<string>",
"required": "<boolean>",
"valueType": "string",
"formType": "multi-select",
"formOptions": [
{
"label": "<string>",
"value": "<string>",
"key": "<string>"
},
{
"label": "<string>",
"value": "<string>",
"key": "<string>"
}
]
},
{
"label": "<string>",
"key": "<string>",
"value": "<string>",
"required": "<boolean>",
"valueType": "url",
"formType": "multi-select",
"formOptions": [
{
"label": "<string>",
"value": "<string>",
"key": "<string>"
},
{
"label": "<string>",
"value": "<string>",
"key": "<string>"
}
]
}
],
"actionBy": "<string>",
"apiKeyRotationPeriod": "CUSTOM",
"apiKeyRotationValue": "<number>",
"apiKeyRotationCustomDate": {},
"callBackUrl": "<string>"
}

🔑 Authentication bearer

ParamvalueType
tokenbearerTokenstring

Response: 200

{
"message": "Tenant Product Mapping in progress. Use the API key to retrieve the product key.",
"apiKey": "e991d546-03f4-4b3d-8ef8-49bc979a91b2",
"apiCode": "intelligent_granite_gloves"
}

LANGUAGE

AUTHORIZATION

Bearer

CURL REQUEST


curl --request PATCH \ 
--url /api/v1/tenants/:tenantId/products/:productId/map \
--header 'accept: application/json' \
--header 'content-type: application/json'

RESPONSE


Click Try It! to start a request and see the response here!