Update a reseller

Updates the specified reseller by setting the values of the parameters passed. Any parameters not provided will be left unchanged.

PATCH/v3/resellers/{id}
JWT
reseller:write

Parameters

NameTypeInDescription
id*stringpathUnique identifier for the reseller.

Request Body Schema

PropertyTypeDescriptionConstraints
namestringName of the reseller.min: 1, max: 256
emailstringNotification email of the reseller.min: 1, max: 256, format: email
descriptionstringDescription for the reseller.min: 0, max: 256
allowedUsersintegerMax number of users the reseller is allowed to create. Set to -1 to allow unlimited users.min: -1, max: 2147483647, format: int32
allowedOrganizationsintegerMax number of organizations the reseller is allowed to create. Set to -1 to allow unlimited organizations.min: -1, max: 2147483647, format: int32

Request Example

{
  "name": "string",
  "email": "user@example.com",
  "description": "string",
  "allowedUsers": -1,
  "allowedOrganizations": -1
}
Triggers webhook: reseller.updated
POST <your-webhook-url>
{
  "event": "reseller.updated",
  "data": {
    "id": "string",
    "createdAt": "2019-08-24T14:15:22Z",
    "updatedAt": "2019-08-24T14:15:22Z",
    "name": "string",
    "email": "string",
    "description": "string",
    "allowedUsers": 0,
    "allowedOrganizations": 0
  },
  "triggeredAt": "string"
}

Responses

200 OK
{
  "id": "string",
  "createdAt": "2019-08-24T14:15:22Z",
  "updatedAt": "2019-08-24T14:15:22Z",
  "name": "string",
  "email": "string",
  "description": "string",
  "allowedUsers": 0,
  "allowedOrganizations": 0
}