The lettering_objects element lets you modify existing lettering objects inside a design. Use it with editDesign or editDesignTrueview APIs. You can check if a design has lettering objects via designInfo or designTrueview.

XML structure

<lettering_objects>				
   <lettering_object index="0">		
      <simple_lettering ... />	<!-- Optional: modify lettering parameters -->
      <thread ... />		<!-- Optional: modify lettering color -->
   </lettering_object>
   <lettering_object index="n">		
      <simple_lettering ... />			
      <thread ... />				
   </lettering_object>
</lettering_objects>

Usage

1. index → the zero-based index of the lettering object to edit.
   
2. You can change:
   
1. Text (text)
   
2. Font (alphabet_name)
   
3. Height
   
4. Bold setting
   
5. Italic setting
   
6. Thread color
   
3. Multiple <lettering_object> edits can be done in one request.
   
4. Only supplied parameters are changed. For example, change just the text, or just the color, or both.
   
5. The thread tag lets you change the lettering color.

Examples

✅ Change the color of the first lettering object:

✅ Change the text of the first lettering object:

✅ Change text and alphabet of first object; text and color of second object:

Remarks

1. If you change alphabet_name, the new font must be valid.
   
2. If you only change other attributes, the original font must be valid.
   

1. If the color already exists in the design’s palette, it’s reused.
   
2. If not, the API adds it with the supplied details.

1. If the design has more than one, the edit only applies to the appointed colorway (if specified) or the current one.
   

Related video