Update a Single Object
Last updated
Last updated
This function updates a single object of the given type and with the given ID. If no object with the specified object exists yet, an error is returned.
/api/v4/
backend-deployment-id
/objects/
model
/
object-id
.json
PATCH
The parameters must be specified in the same way as for creating new objects. Please refer to the same section in and to the section.
The response includes the single updated object. The format of the object is the same as for .
In this example, we update only the status field of a task object:
Response:
This function replaces a single object of the given type with the given ID. If no object with the specified ID exists yet, a new object is created with the given ID.
/api/v4/
backend-deployment-id
/objects/
model
/
object-id
.json
PUT
In this example, we set only the name
field of a task
object. The other fields are cleared.
Response:
The ID must be a valid , and must be lowercase. 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
The parameters must be specified in the same way as for creating new objects. Please refer to the same section in and to the section.
For updating more than one object in a request, refer to the section.
The response includes the single updated object. The format of the object is the same as for .
The below examples contain a BASE-URL
placeholder. Please refer to the section to get the base URL relevant to your deployment.