Update Licensee

Update the licensee object.

You can update the licensee Seller Object, except the status (which is managed through the disable, enable, deleteendpoints) buyers id and sellers id.

PreviousCreate Licensee NextDelete Licensee

Last updated 17 days ago

Was this helpful?

put

/v1/accounts/licensees/{id}

Path parameters

idstringrequired

Body

idstring

auditobject

$metaobject

hrefstring

contactobject

namestring · max: 500 | nullable

externalIdstring · max: 250 | nullable

statusstring · enum

Options: Active, Enabled, Disabled, Deleted

addressobject

useBuyerAddressboolean | nullable

iconstring · max: 2000 | nullable

descriptionstring · max: 2000 | nullable

accountobject

buyerobject

sellerobject

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request PUT \
  --url '/v1/accounts/licensees/{id}' \
  --header 'Content-Type: application/json' \
  --data '{"audit":{"created":{"by":{"audit":{"created":{"by":"[Circular Reference]"},"updated":{"by":"[Circular Reference]"}},"$meta":{"omitted":[null]}}},"updated":{"by":"[Circular Reference]"}},"$meta":{"omitted":[null]},"contact":{"phone":{},"user":{"audit":{"created":{"by":{"audit":{"created":{"by":"[Circular Reference]"},"updated":{"by":"[Circular Reference]"}},"$meta":{"omitted":[null]}}},"updated":{"by":{"audit":{"created":{"by":"[Circular Reference]"},"updated":{"by":"[Circular Reference]"}},"$meta":{"omitted":[null]}}}},"$meta":{"omitted":[null]},"phone":{},"settings":{},"currentAccount":{"audit":{"created":{"by":{"audit":{"created":{"by":"[Circular Reference]"},"updated":{"by":"[Circular Reference]"}},"$meta":{"omitted":[null]}}},"updated":{"by":"[Circular Reference]"}},"$meta":{"omitted":[null]},"externalIds":{},"type":"Client","status":"Active","serviceLevel":"Express","address":{"addressLine1":"text","postCode":"text","city":"text","state":"text","country":"text"},"name":"text","groups":[{"audit":"[Circular Reference]","$meta":{"omitted":[null]},"account":"[Circular Reference]","modules":"[Circular Reference]","users":"[Circular Reference]","buyers":"[Circular Reference]"}]},"accounts":[{"audit":{"created":{"by":{"audit":{"created":{"by":"[Circular Reference]"},"updated":{"by":"[Circular Reference]"}},"$meta":{"omitted":[null]}}},"updated":{"by":"[Circular Reference]"}},"$meta":{"omitted":[null]},"externalIds":{},"type":"Client","status":"Active","serviceLevel":"Express","address":{"addressLine1":"text","postCode":"text","city":"text","state":"text","country":"text"},"name":"text","groups":[{"audit":"[Circular Reference]","$meta":{"omitted":[null]},"account":"[Circular Reference]","modules":"[Circular Reference]","users":"[Circular Reference]","buyers":"[Circular Reference]"}]}]}},"status":"Active","address":{"addressLine1":"text","postCode":"text","city":"text","state":"text","country":"text"},"account":{"audit":{"created":{"by":{"audit":{"created":{"by":"[Circular Reference]"},"updated":{"by":"[Circular Reference]"}},"$meta":{"omitted":[null]}}},"updated":{"by":"[Circular Reference]"}},"$meta":{"omitted":[null]},"externalIds":{},"type":"Client","status":"Active","serviceLevel":"Express","address":{"addressLine1":"text","postCode":"text","city":"text","state":"text","country":"text"},"name":"text","groups":[{"audit":"[Circular Reference]","$meta":{"omitted":[null]},"account":"[Circular Reference]","modules":"[Circular Reference]","users":"[Circular Reference]","buyers":"[Circular Reference]"}]},"buyer":{"audit":{"created":{"by":{"audit":{"created":{"by":"[Circular Reference]"},"updated":{"by":"[Circular Reference]"}},"$meta":{"omitted":[null]}}},"updated":{"by":{"audit":{"created":{"by":"[Circular Reference]"},"updated":{"by":"[Circular Reference]"}},"$meta":{"omitted":[null]}}},"activated":{"by":{"audit":{"created":{"by":"[Circular Reference]"},"updated":{"by":"[Circular Reference]"}},"$meta":{"omitted":[null]}}},"unassigned":{"by":{"audit":{"created":{"by":"[Circular Reference]"},"updated":{"by":"[Circular Reference]"}},"$meta":{"omitted":[null]}}}},"$meta":{"omitted":[null]},"contact":{"phone":{},"user":{"audit":{"created":{"by":{"audit":{"created":{"by":"[Circular Reference]"},"updated":{"by":"[Circular Reference]"}},"$meta":{"omitted":[null]}}},"updated":{"by":{"audit":{"created":{"by":"[Circular Reference]"},"updated":{"by":"[Circular Reference]"}},"$meta":{"omitted":[null]}}}},"$meta":{"omitted":[null]},"phone":{},"settings":{},"currentAccount":{"audit":{"created":{"by":{"audit":{"created":{"by":"[Circular Reference]"},"updated":{"by":"[Circular Reference]"}},"$meta":{"omitted":[null]}}},"updated":{"by":"[Circular Reference]"}},"$meta":{"omitted":[null]},"externalIds":{},"type":"Client","status":"Active","serviceLevel":"Express","address":{"addressLine1":"text","postCode":"text","city":"text","state":"text","country":"text"},"name":"text","groups":[{"audit":"[Circular Reference]","$meta":{"omitted":[null]},"account":"[Circular Reference]","modules":"[Circular Reference]","users":"[Circular Reference]","buyers":"[Circular Reference]"}]},"accounts":[{"audit":{"created":{"by":{"audit":{"created":{"by":"[Circular Reference]"},"updated":{"by":"[Circular Reference]"}},"$meta":{"omitted":[null]}}},"updated":{"by":"[Circular Reference]"}},"$meta":{"omitted":[null]},"externalIds":{},"type":"Client","status":"Active","serviceLevel":"Express","address":{"addressLine1":"text","postCode":"text","city":"text","state":"text","country":"text"},"name":"text","groups":[{"audit":"[Circular Reference]","$meta":{"omitted":[null]},"account":"[Circular Reference]","modules":"[Circular Reference]","users":"[Circular Reference]","buyers":"[Circular Reference]"}]}]}},"externalIds":{},"status":"Active","address":{"addressLine1":"text","postCode":"text","city":"text","state":"text","country":"text"},"account":{"audit":{"created":{"by":{"audit":{"created":{"by":"[Circular Reference]"},"updated":{"by":"[Circular Reference]"}},"$meta":{"omitted":[null]}}},"updated":{"by":"[Circular Reference]"}},"$meta":{"omitted":[null]},"externalIds":{},"type":"Client","status":"Active","serviceLevel":"Express","address":{"addressLine1":"text","postCode":"text","city":"text","state":"text","country":"text"},"name":"text","groups":[{"audit":"[Circular Reference]","$meta":{"omitted":[null]},"account":"[Circular Reference]","modules":"[Circular Reference]","users":"[Circular Reference]","buyers":"[Circular Reference]"}]},"errors":[{"message":"text"}],"sellers":[{"audit":{"created":{"by":{"audit":{"created":{"by":"[Circular Reference]"},"updated":{"by":"[Circular Reference]"}},"$meta":{"omitted":[null]}}},"updated":{"by":"[Circular Reference]"}},"$meta":{"omitted":[null]},"status":"Active","address":{"addressLine1":"text","postCode":"text","city":"text","state":"text","country":"text"},"currencies":[null]}]},"seller":{"audit":{"created":{"by":{"audit":{"created":{"by":"[Circular Reference]"},"updated":{"by":"[Circular Reference]"}},"$meta":{"omitted":[null]}}},"updated":{"by":"[Circular Reference]"}},"$meta":{"omitted":[null]},"status":"Active","address":{"addressLine1":"text","postCode":"text","city":"text","state":"text","country":"text"},"currencies":[null]}}'

200

400

404

{
  "id": "text",
  "audit": {
    "created": {
      "by": {
        "audit": {
          "created": {
            "by": "[Circular Reference]"
          },
          "updated": {
            "by": "[Circular Reference]"
          }
        },
        "$meta": {
          "omitted": [
            null
          ]
        }
      }
    },
    "updated": {
      "by": "[Circular Reference]"
    }
  },
  "$meta": {
    "omitted": [
      "text"
    ]
  },
  "href": "text",
  "contact": {
    "name": "text",
    "firstName": "text",
    "lastName": "text",
    "email": "hello@example.com",
    "phone": {},
    "user": {
      "audit": {
        "created": {
          "by": {
            "audit": {
              "created": {
                "by": "[Circular Reference]"
              },
              "updated": {
                "by": "[Circular Reference]"
              }
            },
            "$meta": {
              "omitted": [
                null
              ]
            }
          }
        },
        "updated": {
          "by": {
            "audit": {
              "created": {
                "by": "[Circular Reference]"
              },
              "updated": {
                "by": "[Circular Reference]"
              }
            },
            "$meta": {
              "omitted": [
                null
              ]
            }
          }
        }
      },
      "$meta": {
        "omitted": [
          null
        ]
      },
      "phone": {},
      "settings": {},
      "currentAccount": {
        "audit": {
          "created": {
            "by": {
              "audit": {
                "created": {
                  "by": "[Circular Reference]"
                },
                "updated": {
                  "by": "[Circular Reference]"
                }
              },
              "$meta": {
                "omitted": [
                  null
                ]
              }
            }
          },
          "updated": {
            "by": "[Circular Reference]"
          }
        },
        "$meta": {
          "omitted": [
            null
          ]
        },
        "externalIds": {},
        "type": "Client",
        "status": "Active",
        "serviceLevel": "Express",
        "address": {
          "addressLine1": "text",
          "postCode": "text",
          "city": "text",
          "state": "text",
          "country": "text"
        },
        "name": "text",
        "groups": [
          {
            "audit": "[Circular Reference]",
            "$meta": {
              "omitted": [
                null
              ]
            },
            "account": "[Circular Reference]",
            "modules": "[Circular Reference]",
            "users": "[Circular Reference]",
            "buyers": "[Circular Reference]"
          }
        ]
      },
      "accounts": [
        {
          "audit": {
            "created": {
              "by": {
                "audit": {
                  "created": {
                    "by": "[Circular Reference]"
                  },
                  "updated": {
                    "by": "[Circular Reference]"
                  }
                },
                "$meta": {
                  "omitted": [
                    null
                  ]
                }
              }
            },
            "updated": {
              "by": "[Circular Reference]"
            }
          },
          "$meta": {
            "omitted": [
              null
            ]
          },
          "externalIds": {},
          "type": "Client",
          "status": "Active",
          "serviceLevel": "Express",
          "address": {
            "addressLine1": "text",
            "postCode": "text",
            "city": "text",
            "state": "text",
            "country": "text"
          },
          "name": "text",
          "groups": [
            {
              "audit": "[Circular Reference]",
              "$meta": {
                "omitted": [
                  null
                ]
              },
              "account": "[Circular Reference]",
              "modules": "[Circular Reference]",
              "users": "[Circular Reference]",
              "buyers": "[Circular Reference]"
            }
          ]
        }
      ]
    },
    "type": "text"
  },
  "name": "text",
  "externalId": "text",
  "status": "Active",
  "address": {
    "addressLine1": "text",
    "addressLine2": "text",
    "postCode": "text",
    "city": "text",
    "state": "text",
    "country": "text"
  },
  "useBuyerAddress": true,
  "icon": "text",
  "description": "text",
  "account": {
    "id": "text",
    "audit": {
      "created": {
        "by": {
          "audit": {
            "created": {
              "by": "[Circular Reference]"
            },
            "updated": {
              "by": "[Circular Reference]"
            }
          },
          "$meta": {
            "omitted": [
              null
            ]
          }
        }
      },
      "updated": {
        "by": "[Circular Reference]"
      }
    },
    "$meta": {
      "omitted": [
        null
      ]
    },
    "href": "text",
    "externalIds": {},
    "externalId": "text",
    "externalName": "text",
    "type": "Client",
    "status": "Active",
    "serviceLevel": "Express",
    "address": {
      "addressLine1": "text",
      "postCode": "text",
      "city": "text",
      "state": "text",
      "country": "text"
    },
    "icon": "text",
    "technicalSupportEmail": "hello@example.com",
    "website": "text",
    "description": "text",
    "name": "text",
    "groups": [
      {
        "audit": "[Circular Reference]",
        "$meta": {
          "omitted": [
            null
          ]
        },
        "account": "[Circular Reference]",
        "modules": "[Circular Reference]",
        "users": "[Circular Reference]",
        "buyers": "[Circular Reference]"
      }
    ]
  },
  "buyer": {
    "id": "text",
    "audit": {
      "created": {
        "by": {
          "audit": {
            "created": {
              "by": "[Circular Reference]"
            },
            "updated": {
              "by": "[Circular Reference]"
            }
          },
          "$meta": {
            "omitted": [
              null
            ]
          }
        }
      },
      "updated": {
        "by": {
          "audit": {
            "created": {
              "by": "[Circular Reference]"
            },
            "updated": {
              "by": "[Circular Reference]"
            }
          },
          "$meta": {
            "omitted": [
              null
            ]
          }
        }
      },
      "activated": {
        "by": {
          "audit": {
            "created": {
              "by": "[Circular Reference]"
            },
            "updated": {
              "by": "[Circular Reference]"
            }
          },
          "$meta": {
            "omitted": [
              null
            ]
          }
        }
      },
      "unassigned": {
        "by": {
          "audit": {
            "created": {
              "by": "[Circular Reference]"
            },
            "updated": {
              "by": "[Circular Reference]"
            }
          },
          "$meta": {
            "omitted": [
              null
            ]
          }
        }
      }
    },
    "$meta": {
      "omitted": [
        null
      ]
    },
    "href": "text",
    "contact": {
      "phone": {},
      "user": {
        "audit": {
          "created": {
            "by": {
              "audit": {
                "created": {
                  "by": "[Circular Reference]"
                },
                "updated": {
                  "by": "[Circular Reference]"
                }
              },
              "$meta": {
                "omitted": [
                  null
                ]
              }
            }
          },
          "updated": {
            "by": {
              "audit": {
                "created": {
                  "by": "[Circular Reference]"
                },
                "updated": {
                  "by": "[Circular Reference]"
                }
              },
              "$meta": {
                "omitted": [
                  null
                ]
              }
            }
          }
        },
        "$meta": {
          "omitted": [
            null
          ]
        },
        "phone": {},
        "settings": {},
        "currentAccount": {
          "audit": {
            "created": {
              "by": {
                "audit": {
                  "created": {
                    "by": "[Circular Reference]"
                  },
                  "updated": {
                    "by": "[Circular Reference]"
                  }
                },
                "$meta": {
                  "omitted": [
                    null
                  ]
                }
              }
            },
            "updated": {
              "by": "[Circular Reference]"
            }
          },
          "$meta": {
            "omitted": [
              null
            ]
          },
          "externalIds": {},
          "type": "Client",
          "status": "Active",
          "serviceLevel": "Express",
          "address": {
            "addressLine1": "text",
            "postCode": "text",
            "city": "text",
            "state": "text",
            "country": "text"
          },
          "name": "text",
          "groups": [
            {
              "audit": "[Circular Reference]",
              "$meta": {
                "omitted": [
                  null
                ]
              },
              "account": "[Circular Reference]",
              "modules": "[Circular Reference]",
              "users": "[Circular Reference]",
              "buyers": "[Circular Reference]"
            }
          ]
        },
        "accounts": [
          {
            "audit": {
              "created": {
                "by": {
                  "audit": {
                    "created": {
                      "by": "[Circular Reference]"
                    },
                    "updated": {
                      "by": "[Circular Reference]"
                    }
                  },
                  "$meta": {
                    "omitted": [
                      null
                    ]
                  }
                }
              },
              "updated": {
                "by": "[Circular Reference]"
              }
            },
            "$meta": {
              "omitted": [
                null
              ]
            },
            "externalIds": {},
            "type": "Client",
            "status": "Active",
            "serviceLevel": "Express",
            "address": {
              "addressLine1": "text",
              "postCode": "text",
              "city": "text",
              "state": "text",
              "country": "text"
            },
            "name": "text",
            "groups": [
              {
                "audit": "[Circular Reference]",
                "$meta": {
                  "omitted": [
                    null
                  ]
                },
                "account": "[Circular Reference]",
                "modules": "[Circular Reference]",
                "users": "[Circular Reference]",
                "buyers": "[Circular Reference]"
              }
            ]
          }
        ]
      }
    },
    "externalIds": {},
    "status": "Active",
    "icon": "text",
    "address": {
      "addressLine1": "text",
      "postCode": "text",
      "city": "text",
      "state": "text",
      "country": "text"
    },
    "taxId": "text",
    "account": {
      "audit": {
        "created": {
          "by": {
            "audit": {
              "created": {
                "by": "[Circular Reference]"
              },
              "updated": {
                "by": "[Circular Reference]"
              }
            },
            "$meta": {
              "omitted": [
                null
              ]
            }
          }
        },
        "updated": {
          "by": "[Circular Reference]"
        }
      },
      "$meta": {
        "omitted": [
          null
        ]
      },
      "externalIds": {},
      "type": "Client",
      "status": "Active",
      "serviceLevel": "Express",
      "address": {
        "addressLine1": "text",
        "postCode": "text",
        "city": "text",
        "state": "text",
        "country": "text"
      },
      "name": "text",
      "groups": [
        {
          "audit": "[Circular Reference]",
          "$meta": {
            "omitted": [
              null
            ]
          },
          "account": "[Circular Reference]",
          "modules": "[Circular Reference]",
          "users": "[Circular Reference]",
          "buyers": "[Circular Reference]"
        }
      ]
    },
    "name": "text",
    "errors": [
      {
        "message": "text"
      }
    ],
    "sellers": [
      {
        "audit": {
          "created": {
            "by": {
              "audit": {
                "created": {
                  "by": "[Circular Reference]"
                },
                "updated": {
                  "by": "[Circular Reference]"
                }
              },
              "$meta": {
                "omitted": [
                  null
                ]
              }
            }
          },
          "updated": {
            "by": "[Circular Reference]"
          }
        },
        "$meta": {
          "omitted": [
            null
          ]
        },
        "status": "Active",
        "address": {
          "addressLine1": "text",
          "postCode": "text",
          "city": "text",
          "state": "text",
          "country": "text"
        },
        "currencies": [
          null
        ]
      }
    ]
  },
  "seller": {
    "id": "text",
    "audit": {
      "created": {
        "by": {
          "audit": {
            "created": {
              "by": "[Circular Reference]"
            },
            "updated": {
              "by": "[Circular Reference]"
            }
          },
          "$meta": {
            "omitted": [
              null
            ]
          }
        }
      },
      "updated": {
        "by": "[Circular Reference]"
      }
    },
    "$meta": {
      "omitted": [
        null
      ]
    },
    "href": "text",
    "externalId": "text",
    "status": "Active",
    "icon": "text",
    "address": {
      "addressLine1": "text",
      "postCode": "text",
      "city": "text",
      "state": "text",
      "country": "text"
    },
    "name": "text",
    "currencies": [
      "text"
    ]
  }
}