Teamwork CRM API

Getting access, Developing, Testing

Back to Teamwork CRM

Create a new custom field

Input

type: object properties: data: type: object title: Data properties: customField: type: object properties: fieldType: type: string description: Type of the of the custom field value. enum: - companies - contacts - date - duration - multi-select - number - select - text-long - text-short - time - url - users isMandatory: type: boolean description: >- Mandatory is true if the custom field must have a value set, when the entity to which the custom field is assigned to, is created or updated. isShownWhenAdding: type: boolean description: >- Shown when adding is true when the custom field should be shown in the entity's form. Also, it must be true if the custom field is mandatory. kind: type: string description: Kind of entity this custom field is defined for. enum: - deals - contacts - companies name: type: string options: type: array description: >- Options for the custom field with `fieldType` "select" or "multi-select". items: type: string

Output

type: object title: customFieldResponse properties: customField: type: object title: CustomField properties: createdAt: type: string description: When the item was created, as a datetime format: date-time createdBy: type: object properties: id: type: integer type: type: string enum: - users deletedAt: type: string description: When the item was deleted, as a datetime format: date-time deletedBy: type: object properties: id: type: integer type: type: string enum: - users fieldType: type: string description: Type of the of the custom field value. enum: - companies - contacts - date - duration - multi-select - number - select - text-long - text-short - time - url - users id: type: integer isMandatory: type: boolean description: >- Mandatory is true if the custom field must have a value set, when the entity to which the custom field is assigned to, is created or updated. isShownWhenAdding: type: boolean description: >- Shown when adding is true when the custom field should be shown in the entity's form. key: type: string description: >- Key is the custom field's identifier used in the entities responses that include custom fields. kind: type: string description: Kind of entity this custom field is defined for. enum: - deals - contacts - companies name: type: string options: type: array description: >- Options for the custom field with `fieldType` "select" or "multi-select". items: type: string orderIndex: type: integer description: >- Position of the custom field in the set of all non deleted custom fields. Lower numbers come first when retrieving multiple elements at once. updatedAt: type: string description: When the item was last updated, as a datetime format: date-time updatedBy: type: object properties: id: type: integer type: type: string enum: - users updatedSourceId: type: integer description: Source ID of the latest request made (API / Web app)