Marketo API

Getting access, Developing, Testing

Back to Marketo

Update Lead Field

Update metadata for a lead field in the target instance. See update rules here. Required Permissions: Read-Write Schema Standard Field, Read-Write Schema Custom Field

Input

type: object properties: parameters: type: object properties: fieldApiName: type: string description: The API name of lead field required: - fieldApiName title: Parameters data: required: - input type: object properties: input: type: array description: Single lead field for input items: type: object description: Lead field record for update properties: displayName: type: string description: UI display-name of the field description: type: string description: Description of the field isHidden: type: boolean description: If set to true, the field is hidden. Default is false example: false isHtmlEncodingInEmail: type: boolean description: >- If set to true, field is encoded as HTML in email. Default is true example: false isSensitive: type: boolean description: If set to true, field is marked as sensitive. Default is false example: false title: Data

Output

required: - errors - requestId - result - success - warnings type: object properties: errors: type: array description: Array of errors that occurred if the request was unsuccessful items: required: - code - message type: object properties: code: type: string description: >- Error code of the error. See full list of error codes <a href="https://developers.marketo.com/rest-api/error-codes/">here</a> message: type: string description: Message describing the cause of the error moreResult: type: boolean description: Boolean indicating if there are more results in subsequent pages example: false nextPageToken: type: string description: Paging token given if the result set exceeded the allowed batch size requestId: type: string description: Id of the request made result: type: array description: Array of results for individual records in the operation, may be empty items: required: - name - status type: object description: Lead field update status properties: name: type: string description: API name of the field status: type: string description: Status of the operation performed on the record enum: - created - updated success: type: boolean description: Whether the request succeeded example: false warnings: type: array description: Array of warnings given for the operation items: required: - code - message type: object properties: code: type: integer description: Integer code of the warning format: int32 message: type: string description: Message describing the warning