Create Customer Grants

Overview

Use this API to provide grants on a customer to other customers. Refer Customer grants section for information about what is a grant. For the successful execution of this API:

  • The customer to whom grant is being provided, must be an individual customer.
  • The customer on whom the grant is being provided, must be an individual customer.
  • If the customer departmentalization is enabled in the application, both the customers must belong to the same department.
  • The number of customers to whom grants are being provided must not exceed 75.

    Permissions

    Actor Permission
    User All of the following are required:
    • User must have 'Edit Customer' action.
    • If "Customer departmentalization" setting is enabled in the application, then all customers (granted on and granted to) must belong to either the user's home department, or to a department where the user is a foreign user.
    Client Application No additional permission is required.
SecurityoAuthUser or oAuthClient
Request
header Parameters
Accept
required
string
Default: application/json

Content type accepted by client.

Enum: "application/json" "application/xml"
Content-Type
required
string
Default: application/json

Media type sent by the client.

Enum: "application/json" "application/xml" "application/x-www-form-urlencoded" "multipart/form-data" "text/plain"
Accept-Language
required
string
Default: en-US

Language locale accepted by client (used for locale specific fields in resource representation and in error responses).

Enum: "en-US" "es-ES" "fr-FR" "it-IT" "de-DE" "nl-NL" "pt-BR" "pt-PT" "da-DK" "ru-RU" "fr-CA" "zh-CN" "ja-JP" "ko-KR" "sv-SE"
Request Body schema: application/json

The request body is mandatory. Request body can be in either XML or JSON format.

Elements required in request body

Name Description
grantsOn.customer.id Customer on whom the grants are provided.
grantsTo.customer.id This specifies the customers to whom the grant is provided.
object (grantsOn)
object (grantsTo)
Responses
201

When created successfully

400

Bad Request

401

Unauthorized

403

Forbidden

406

Not Acceptable

500

Internal server error

post/customer/grant
Request samples
application/json

Provides grants to a single customer

{
  • "grantsOn": {
    },
  • "grantsTo": {
    }
}
Response samples
application/json
{
  • "code": "400-101",
  • "developerMessage": "Unsupported query parameter(s) supplied: '<query_parameter>'."
}