v1

latestOpenAPI 3.0.02026-08-04891301.4 MB

Create a team custom object

Creates a new custom object owned by the specified team. The object is instantiated against the schema identified by type (the schema's lookup_key). All field values are validated against that schema's field definitions before the object is persisted.

The authenticated user must be a member of the team with sufficient access. If the team is not found or the caller lacks access, the endpoint returns 404. If type does not match a registered schema for the team's organization, the endpoint also returns 404.

post/api/v1/teams/{team}/custom_objects

Path parameters

teamstring required

Team ID (team_...). The team that will own the created object.

Request body

fieldsobject required

Map of field values to set on the new object. Keys and value types must conform to the schema identified by type.

typestring required

Schema type identifier (lookup_key) that defines the object's fields and validation rules.

Example request

{
  "fields": {},
  "type": "string"
}

Response

Successful response

created_atstring date-time

When the custom object was created (ISO 8601).

fieldsobject

Map of field names to their current values as defined by the object's schema type.

idstring required

Unique identifier for the custom object (cobj_...).

orgstring

ID of the organization this object belongs to (org_...).

row_keystring

An optional stable key used to identify this object by a caller-controlled string rather than its generated ID. null if not set.

sandboxstring

ID of the sandbox environment this object is scoped to (dsb_...). null for production objects.

schema_typestring

The lookup key of the schema type that defines this object's field structure. null if the schema type has not been set.

teamstring

ID of the team that owns this object (tem_...). null if the object is not team-scoped.

updated_atstring date-time

When the custom object was last modified (ISO 8601). null if the object has never been updated after creation.

userstring

ID of the user that owns this object (usr_...). null if the object is not user-scoped.

versioninteger

Optimistic concurrency version of the object. Increments with each successful update; pass this value in write operations to detect conflicting changes.

Example response

{
  "created_at": "2024-01-01T00:00:00Z",
  "fields": {
    "key": "value"
  },
  "id": "cobj_0aBcDeFgHiJkLmNoPqRsTu",
  "org": "org_0aBcDeFgHiJkLmNoPqRsTu",
  "row_key": "string",
  "sandbox": "dsb_0aBcDeFgHiJkLmNoPqRsTu",
  "schema_type": "contact",
  "team": "tem_0aBcDeFgHiJkLmNoPqRsTu",
  "updated_at": "2024-01-01T00:00:00Z",
  "user": "usr_0aBcDeFgHiJkLmNoPqRsTu",
  "version": 1
}