V1
The JourneyApps API (V1) → 5. Updating an Object
Updating an Object
This function updates a single existing object of the given type and with the given ID. If no object with the specified object exists yet, a new object is created with the given ID.
Please Note:
The ID must be a valid UUID, and must be lower case. For example,550e8400-e29b-41d4-a716-446655440000 is a valid UUID. When updating objects using the JourneyApps API, use the UUIDs returned by JourneyApps (in the id field of each object) when you retrieve objects.
| Relative URL | HTTP Request Method |
|---|---|
| /api/v1/object-type/object-id.format | PUT |
Note: Replace object-type with the type of object that you wish to update (as defined in your app's Data Model) and object-id with the ID of the specific object. Replace format with the response data format (
json or xml), or leave it out.
Parameters
The parameters must be specified in the same way as for creating new objects. Please refer to the same section at Creating New Objects and to the Attribute Representation section.
Please Note:
Bulk/batch updating of objects is not supported. You can only update one object at a time.Response
The response includes the single updated object. The format of the object is the same as for Retrieving All Objects.
Example
In this example, we update only the name attribute of a task object.
Tip: The
-X parameter to curl allows you to use a specific HTTP request method.
Next Section:
6. Deleting an Object
Previous Section
Next Section