---
title: "Create Vendor"
method: POST
path: "/vendors"
tags: ["Vendor"]
---
# Create Vendor
`POST /vendors`
Creates a new vendor organization. A vendor represents an external LSP that can be assigned translation tasks. The key contact provided will become the primary point of contact for the vendor.
Creating a vendor automatically provisions a dedicated folder and a `VendorProjectManager` group within the account hierarchy.
**Managing vendor members:** Users can be added to a vendor by inviting them via the [Create User](#/operations/CreateUser) endpoint, specifying the auto-created `VendorProjectManager` group as one of the `groups` in the request. Users can be removed from the vendor by removing them from that group using the [Update Group](#/operations/UpdateGroup) or [Update User](#/operations/UpdateUser) endpoints.
## Query parameters
- `fields` string
## Headers
- `X-LC-Tenant` string, required
- `Authorization` string, required
## Request body
- VendorCreateRequest — Request body for creating a new vendor. Creating a vendor automatically provisions a dedicated folder and a `VendorProjectManager` group.
- `name` string, required — The name of the vendor.\ Unsupported characters in the name: `\` `/` `:` ` *` `?` `"` `<` `>` `|`
- `description` string — A description of the vendor.
- `keyContact` KeyContact, required — The key contact of a vendor — the primary point of contact within the LSP organization.
- `firstName` string, required — The first name of the key contact.
- `lastName` string, required — The last name of the key contact.
- `email` string, email, required — The email address of the key contact.
- `selfManaged` boolean — Indicates whether the vendor can manage its own users and settings independently. When true (default), users with access to the vendor folder can manage the vendor's group membership. When false, only account-level administrators can manage the vendor. Can be updated after creation via the Update Vendor endpoint.
- `quoteTemplateId` string — The identifier of the quote template to associate with the vendor. Use the [List Quote Templates](#/operations/ListQuoteTemplates) endpoint to retrieve available values.
The quote template must be in the same folder as the vendor or above.
- `customFields` CustomFieldRequest[] — Custom field values to associate with the vendor. Use the [List Custom Field Definitions](#/operations/ListCustomFields) endpoint with `location` set to the vendor's folder identifier and `resourceType=vendor` to retrieve applicable definitions.
- `key` string, required — Custom Field friendly key.
- `value` object — The value of the custom field. A date will be serialized as a ISO_8601 string. For read only custom fields (`isReadOnly`), it must be set exactly as the `defaultValue` from custom field definition.
## Response `201`
Vendor created successfully.
- Vendor — Represents an external LSP (Language Service Provider) organization that can be assigned translation tasks through vendor order templates.
- `id` string, required — The unique identifier of the vendor. Generated by the system.
- `name` string — default
The name of the vendor.
- `description` string — A description of the vendor.
- `keyContact` User — User in the account.
- `id` string, required — User account identifier.
- `description` string — Description of this account user. For Service account users only.
- `email` string — default
The user's email address. Retrieved only for RWS ID (formerly SDL ID) users (not service users) that the authenticated entity is authorized to read.
- `name` string — default
The user's name. Retrieved only for Service users (not RWS ID users) that the authenticated entity is authorized to read.
- `firstName` string — default
The user's first name. Retrieved only for RWS ID (formerly SDL ID) users (not service users) that the authenticated entity is authorized to read.
- `lastName` string — default
The user's last name. Retrieved only for RWS ID (formerly SDL ID) users (not service users) that the authenticated entity is authorized to read.
- `anonymized` boolean, nullable — default
This shows if the authenticated entity has access to read the details of the user or not. If true, then the 'anonymizedUserName' should be retrieved.
- `anonymizedUserName` string — default
Retrieved if the authenticated entity does not have access to read the User.
- `account` Account
- `id` string, required — The account identifier.
- `name` string — default
The account name.
- `location` FolderV2 — Folder used for resource storage.
- `id` string, required — The folder identifier.
- `name` string — default
The name of the folder.
- `hasParent` boolean, nullable — Indicates if the folder has a parent folder.
- `path` FolderPath[] — The hierarchical path. It consists of all the items of the path in reverse order, the parent of the current folder being the first in the list, and the root of the account being the last.
- `id` string, required — The folder identifier.
- `name` string, required — The name of the folder.
- `location` string — default
The location identifier.
- `hasParent` boolean, nullable — default
Indicates if the folder has a parent folder.
- `groups` Group[]
- `id` string, required — The group identifier.
- `name` string — default
The group name.
- `description` string — The group description.
- `location` FolderV2 — Folder used for resource storage.
- `id` string, required — The folder identifier.
- `name` string — default
The name of the folder.
- `hasParent` boolean, nullable — Indicates if the folder has a parent folder.
- `path` FolderPath[] — The hierarchical path. It consists of all the items of the path in reverse order, the parent of the current folder being the first in the list, and the root of the account being the last.
- `id` string, required — The folder identifier.
- `name` string, required — The name of the folder.
- `location` string — default
The location identifier.
- `hasParent` boolean, nullable — default
Indicates if the folder has a parent folder.
- `users` User[]
- `roles` Role[] — **Note**: The identifier of `Administrator` role will not be exposed publicly and a `********` placeholder will be returned on this endpoint for the role.
- `id` string, required — The identifier of the role.
- `type` 'provisioned' | 'custom', required — The role type.
- `name` string, required — Name of the role.
- `description` string — Description of the role.
- `permissions` Permission[] — List of permissions associated with role.
- `name` string, required — Name of the permission.
- `description` string, required — Human-readable description of the permission.
- `category` string, required — The category a permission belongs to.
- `entityType` PermissionEntityType, required — The entity type a permission applies to.
- `name` string, required — Name of the entity type.
- `description` string, required — Human-readable description of the entity type.
- `dependsOn` string[], required — List of permission names that this permission depends on. Empty array if no dependencies.
- `additionalRoles` GroupAdditionalRoles[]
- `location` FolderV2, required — Folder used for resource storage.
- `id` string, required — The folder identifier.
- `name` string — default
The name of the folder.
- `hasParent` boolean, nullable — Indicates if the folder has a parent folder.
- `path` FolderPath[] — The hierarchical path. It consists of all the items of the path in reverse order, the parent of the current folder being the first in the list, and the root of the account being the last.
- `id` string, required — The folder identifier.
- `name` string, required — The name of the folder.
- `location` string — default
The location identifier.
- `hasParent` boolean, nullable — default
Indicates if the folder has a parent folder.
- `roles` Role[], required
- `id` string, required — The identifier of the role.
- `type` 'provisioned' | 'custom', required — The role type.
- `name` string, required — Name of the role.
- `description` string — Description of the role.
- `permissions` Permission[] — List of permissions associated with role.
- `name` string, required — Name of the permission.
- `description` string, required — Human-readable description of the permission.
- `category` string, required — The category a permission belongs to.
- `entityType` PermissionEntityType, required — The entity type a permission applies to.
- …
- `dependsOn` string[], required — List of permission names that this permission depends on. Empty array if no dependencies.
- `groupType` 'default' | 'custom' | 'vendor' | 'customer' — - default : groups in the Root folder (location) provisioned by the system, automatically. Examples: Administrator, Project Manager, Engineer, Terminologist. - customer : groups provisioned by the system, automatically, for each customer location you add. Examples: Customer Requester, Customer Reviewer. - vendor : group provisioned by the system, automatically, for each vendor location you add. Examples: Vendor Project Manager. - custom : groups you can create in a location of your choice. Examples: Project Manager, Translator.
- `metadata` unknown
- `userType` 'user' | 'serviceUser' — The type of the account user.
- `status` 'inactive' | 'active' | 'deleted' | 'provisioned' — Status of this account user.
- `invitationLink` string — The user's invitation link. Retrieved only for RWS ID (formerly SDL ID) users—not service users. It is available only if the user has not yet accepted the invitation (status is `inactive`).
- `membership` 'member' | 'collaborator' — Type of membership of this account user.
- `metadata` unknown
- `vendorFolder` FolderV2 — Folder used for resource storage.
- `id` string, required — The folder identifier.
- `name` string — default
The name of the folder.
- `hasParent` boolean, nullable — Indicates if the folder has a parent folder.
- `path` FolderPath[] — The hierarchical path. It consists of all the items of the path in reverse order, the parent of the current folder being the first in the list, and the root of the account being the last.
- `id` string, required — The folder identifier.
- `name` string, required — The name of the folder.
- `location` string — default
The location identifier.
- `hasParent` boolean, nullable — default
Indicates if the folder has a parent folder.
- `groups` Group[] — The groups located in this vendor's folder. Includes the auto-provisioned `VendorProjectManager` group as well as any custom groups created in the vendor folder. The `VendorProjectManager` group identifier can be used when inviting users to the vendor via the [Create User](#/operations/CreateUser) endpoint.
- `id` string, required — The group identifier.
- `name` string — default
The group name.
- `description` string — The group description.
- `location` FolderV2 — Folder used for resource storage.
- `id` string, required — The folder identifier.
- `name` string — default
The name of the folder.
- `hasParent` boolean, nullable — Indicates if the folder has a parent folder.
- `path` FolderPath[] — The hierarchical path. It consists of all the items of the path in reverse order, the parent of the current folder being the first in the list, and the root of the account being the last.
- `id` string, required — The folder identifier.
- `name` string, required — The name of the folder.
- `location` string — default
The location identifier.
- `hasParent` boolean, nullable — default
Indicates if the folder has a parent folder.
- `users` User[]
- `id` string, required — User account identifier.
- `description` string — Description of this account user. For Service account users only.
- `email` string — default
The user's email address. Retrieved only for RWS ID (formerly SDL ID) users (not service users) that the authenticated entity is authorized to read.
- `name` string — default
The user's name. Retrieved only for Service users (not RWS ID users) that the authenticated entity is authorized to read.
- `firstName` string — default
The user's first name. Retrieved only for RWS ID (formerly SDL ID) users (not service users) that the authenticated entity is authorized to read.
- `lastName` string — default
The user's last name. Retrieved only for RWS ID (formerly SDL ID) users (not service users) that the authenticated entity is authorized to read.
- `anonymized` boolean, nullable — default
This shows if the authenticated entity has access to read the details of the user or not. If true, then the 'anonymizedUserName' should be retrieved.
- `anonymizedUserName` string — default
Retrieved if the authenticated entity does not have access to read the User.
- `account` Account
- `id` string, required — The account identifier.
- `name` string — default
The account name.
- `location` FolderV2 — Folder used for resource storage.
- `id` string, required — The folder identifier.
- `name` string — default
The name of the folder.
- `hasParent` boolean, nullable — Indicates if the folder has a parent folder.
- `path` FolderPath[] — The hierarchical path. It consists of all the items of the path in reverse order, the parent of the current folder being the first in the list, and the root of the account being the last.
- `id` string, required — The folder identifier.
- `name` string, required — The name of the folder.
- `location` string — default
The location identifier.
- `hasParent` boolean, nullable — default
Indicates if the folder has a parent folder.
- `groups` Group[]
- `userType` 'user' | 'serviceUser' — The type of the account user.
- `status` 'inactive' | 'active' | 'deleted' | 'provisioned' — Status of this account user.
- `invitationLink` string — The user's invitation link. Retrieved only for RWS ID (formerly SDL ID) users—not service users. It is available only if the user has not yet accepted the invitation (status is `inactive`).
- `membership` 'member' | 'collaborator' — Type of membership of this account user.
- `metadata` unknown
- `roles` Role[] — **Note**: The identifier of `Administrator` role will not be exposed publicly and a `********` placeholder will be returned on this endpoint for the role.
- `id` string, required — The identifier of the role.
- `type` 'provisioned' | 'custom', required — The role type.
- `name` string, required — Name of the role.
- `description` string — Description of the role.
- `permissions` Permission[] — List of permissions associated with role.
- `name` string, required — Name of the permission.
- `description` string, required — Human-readable description of the permission.
- `category` string, required — The category a permission belongs to.
- `entityType` PermissionEntityType, required — The entity type a permission applies to.
- `name` string, required — Name of the entity type.
- `description` string, required — Human-readable description of the entity type.
- `dependsOn` string[], required — List of permission names that this permission depends on. Empty array if no dependencies.
- `additionalRoles` GroupAdditionalRoles[]
- `location` FolderV2, required — Folder used for resource storage.
- `id` string, required — The folder identifier.
- `name` string — default
The name of the folder.
- `hasParent` boolean, nullable — Indicates if the folder has a parent folder.
- `path` FolderPath[] — The hierarchical path. It consists of all the items of the path in reverse order, the parent of the current folder being the first in the list, and the root of the account being the last.
- `id` string, required — The folder identifier.
- `name` string, required — The name of the folder.
- `location` string — default
The location identifier.
- `hasParent` boolean, nullable — default
Indicates if the folder has a parent folder.
- `roles` Role[], required
- `id` string, required — The identifier of the role.
- `type` 'provisioned' | 'custom', required — The role type.
- `name` string, required — Name of the role.
- `description` string — Description of the role.
- `permissions` Permission[] — List of permissions associated with role.
- `name` string, required — Name of the permission.
- `description` string, required — Human-readable description of the permission.
- `category` string, required — The category a permission belongs to.
- `entityType` PermissionEntityType, required — The entity type a permission applies to.
- `name` string, required — Name of the entity type.
- `description` string, required — Human-readable description of the entity type.
- `dependsOn` string[], required — List of permission names that this permission depends on. Empty array if no dependencies.
- `groupType` 'default' | 'custom' | 'vendor' | 'customer' — - default : groups in the Root folder (location) provisioned by the system, automatically. Examples: Administrator, Project Manager, Engineer, Terminologist. - customer : groups provisioned by the system, automatically, for each customer location you add. Examples: Customer Requester, Customer Reviewer. - vendor : group provisioned by the system, automatically, for each vendor location you add. Examples: Vendor Project Manager. - custom : groups you can create in a location of your choice. Examples: Project Manager, Translator.
- `metadata` unknown
- `selfManaged` boolean — Indicates whether the vendor is self-managed. When true, the vendor can manage its own users.
- `quoteTemplate` ProjectQuoteTemplate — Project Quote Template resource.
- `id` string, required — The identifier of the quote template.
- `name` string — The name of the quote template.
- `description` string — The description of the quote template.
- `location` FolderV2 — Folder used for resource storage.
- `id` string, required — The folder identifier.
- `name` string — default
The name of the folder.
- `hasParent` boolean, nullable — Indicates if the folder has a parent folder.
- `path` FolderPath[] — The hierarchical path. It consists of all the items of the path in reverse order, the parent of the current folder being the first in the list, and the root of the account being the last.
- `id` string, required — The folder identifier.
- `name` string, required — The name of the folder.
- `location` string — default
The location identifier.
- `hasParent` boolean, nullable — default
Indicates if the folder has a parent folder.
- `members` User[] — The users that are members of this vendor, belonging to the vendor's `VendorProjectManager` group. To add users to the vendor, invite them via the [Create User](#/operations/CreateUser) endpoint specifying the `VendorProjectManager` group. To remove users, use the [Update Group](#/operations/UpdateGroup) or [Update User](#/operations/UpdateUser) endpoints.
- `id` string, required — User account identifier.
- `description` string — Description of this account user. For Service account users only.
- `email` string — default
The user's email address. Retrieved only for RWS ID (formerly SDL ID) users (not service users) that the authenticated entity is authorized to read.
- `name` string — default
The user's name. Retrieved only for Service users (not RWS ID users) that the authenticated entity is authorized to read.
- `firstName` string — default
The user's first name. Retrieved only for RWS ID (formerly SDL ID) users (not service users) that the authenticated entity is authorized to read.
- `lastName` string — default
The user's last name. Retrieved only for RWS ID (formerly SDL ID) users (not service users) that the authenticated entity is authorized to read.
- `anonymized` boolean, nullable — default
This shows if the authenticated entity has access to read the details of the user or not. If true, then the 'anonymizedUserName' should be retrieved.
- `anonymizedUserName` string — default
Retrieved if the authenticated entity does not have access to read the User.
- `account` Account
- `id` string, required — The account identifier.
- `name` string — default
The account name.
- `location` FolderV2 — Folder used for resource storage.
- `id` string, required — The folder identifier.
- `name` string — default
The name of the folder.
- `hasParent` boolean, nullable — Indicates if the folder has a parent folder.
- `path` FolderPath[] — The hierarchical path. It consists of all the items of the path in reverse order, the parent of the current folder being the first in the list, and the root of the account being the last.
- `id` string, required — The folder identifier.
- `name` string, required — The name of the folder.
- `location` string — default
The location identifier.
- `hasParent` boolean, nullable — default
Indicates if the folder has a parent folder.
- `groups` Group[]
- `id` string, required — The group identifier.
- `name` string — default
The group name.
- `description` string — The group description.
- `location` FolderV2 — Folder used for resource storage.
- `id` string, required — The folder identifier.
- `name` string — default
The name of the folder.
- `hasParent` boolean, nullable — Indicates if the folder has a parent folder.
- `path` FolderPath[] — The hierarchical path. It consists of all the items of the path in reverse order, the parent of the current folder being the first in the list, and the root of the account being the last.
- `id` string, required — The folder identifier.
- `name` string, required — The name of the folder.
- `location` string — default
The location identifier.
- `hasParent` boolean, nullable — default
Indicates if the folder has a parent folder.
- `users` User[]
- `roles` Role[] — **Note**: The identifier of `Administrator` role will not be exposed publicly and a `********` placeholder will be returned on this endpoint for the role.
- `id` string, required — The identifier of the role.
- `type` 'provisioned' | 'custom', required — The role type.
- `name` string, required — Name of the role.
- `description` string — Description of the role.
- `permissions` Permission[] — List of permissions associated with role.
- `name` string, required — Name of the permission.
- `description` string, required — Human-readable description of the permission.
- `category` string, required — The category a permission belongs to.
- `entityType` PermissionEntityType, required — The entity type a permission applies to.
- `name` string, required — Name of the entity type.
- `description` string, required — Human-readable description of the entity type.
- `dependsOn` string[], required — List of permission names that this permission depends on. Empty array if no dependencies.
- `additionalRoles` GroupAdditionalRoles[]
- `location` FolderV2, required — Folder used for resource storage.
- `id` string, required — The folder identifier.
- `name` string — default
The name of the folder.
- `hasParent` boolean, nullable — Indicates if the folder has a parent folder.
- `path` FolderPath[] — The hierarchical path. It consists of all the items of the path in reverse order, the parent of the current folder being the first in the list, and the root of the account being the last.
- `id` string, required — The folder identifier.
- `name` string, required — The name of the folder.
- `location` string — default
The location identifier.
- `hasParent` boolean, nullable — default
Indicates if the folder has a parent folder.
- `roles` Role[], required
- `id` string, required — The identifier of the role.
- `type` 'provisioned' | 'custom', required — The role type.
- `name` string, required — Name of the role.
- `description` string — Description of the role.
- `permissions` Permission[] — List of permissions associated with role.
- `name` string, required — Name of the permission.
- `description` string, required — Human-readable description of the permission.
- `category` string, required — The category a permission belongs to.
- `entityType` PermissionEntityType, required — The entity type a permission applies to.
- …
- `dependsOn` string[], required — List of permission names that this permission depends on. Empty array if no dependencies.
- `groupType` 'default' | 'custom' | 'vendor' | 'customer' — - default : groups in the Root folder (location) provisioned by the system, automatically. Examples: Administrator, Project Manager, Engineer, Terminologist. - customer : groups provisioned by the system, automatically, for each customer location you add. Examples: Customer Requester, Customer Reviewer. - vendor : group provisioned by the system, automatically, for each vendor location you add. Examples: Vendor Project Manager. - custom : groups you can create in a location of your choice. Examples: Project Manager, Translator.
- `metadata` unknown
- `userType` 'user' | 'serviceUser' — The type of the account user.
- `status` 'inactive' | 'active' | 'deleted' | 'provisioned' — Status of this account user.
- `invitationLink` string — The user's invitation link. Retrieved only for RWS ID (formerly SDL ID) users—not service users. It is available only if the user has not yet accepted the invitation (status is `inactive`).
- `membership` 'member' | 'collaborator' — Type of membership of this account user.
- `metadata` unknown
- `customFields` CustomField[] — Custom field values associated with the vendor.
- `id` string, required — Custom Field identifier.
- `name` string — Custom Field name. (Not available for List Projects, Get Project Template and List Project Templates endpoints)
- `key` string — Custom Field friendly key.
- `value` object — The value of the custom property. A date will be serialized as an ISO_8601 string.
## Other responses
- `400` — Error codes: * "invalid": Invalid input in the field mentioned in the "name" field on the error response. * "empty": Empty input in the body parameter mentioned in the "name" field on the error response. * "minSize": Minimum size exceeded for the value mentioned in the "name" field on the error response. * "maxSize": Maximum size exceeded for the value mentioned in the "name" field on the error response. * "missing": Missing required field for the value mentioned in the "name" field on the error response.
- `401` — The user could not be identified.
- `403` — Error codes: * "forbidden": the authenticated user is not allowed to create vendor order templates.
- `409` — Error codes: * “duplicate”: duplicate value for the field mentioned in the error details.
---
[API](https://skmtc.net/rws/apis/trados-cloud-platform-api.md) · [All operations](https://skmtc.net/rws/apis/trados-cloud-platform-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/rws/trados-cloud-platform-api/revisions/d42dac7c28a3/schema)