Skip to main content
Writing is currently supported for the employee and time_report domains.
There are several considerations to take into account when writing data to the API:
  • To write data, the role being used must have the create and/or update permissions for the domain you are writing to.
  • Following RESTful conventions, POST creates new resources, PUT updates existing resources, and PATCH partially updates existing resources.
  • Although PATCH does not touch unspecified dated properties, it still replaces all entries of the targeted dated properties with the values provided in the request body. To keep existing historical values for a given dated property, include them in the request body. This behavior may change in the future given enough demand.
  • If there are incoming domain mappings for the domain you are writing to, avoid updating any properties that are mapped in those integrations. Otherwise it becomes ambiguous which integration is responsible for the data.
  • If there is a configured twine integration with outgoing domain mappings for that domain, a replication job is created by default to push the changes to the configured integration.
    • For employee, suppress replication by adding a condition in the target integration.
    • For time_report, control replication per request through job_options on create and update (or the equivalent query parameters on delete) — for example, set queue_job to false to skip it, or scope it with domain_mapping_id, schedule_in, and date_range. See the Time Report endpoints for details.