Skip to main content
POST
/
objects
cURL
curl --request POST \
  --url https://api.unifygtm.com/data/v1/objects \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '{
  "api_name": "<string>",
  "display_name": "<string>",
  "description": "<string>"
}'
{
  "status": "success",
  "data": {
    "provider": "UNIFY",
    "api_name": "<string>",
    "display_name": "<string>",
    "description": "<string>"
  }
}

Authorizations

​
x-api-key
string
header
required

Body

application/json
​
api_name
string
required

This is the unique identifier for the object at the API level. It is unique within Unify and cannot be changed.

​
display_name
string
required

This is the user-facing object name shown within Unify. It is not required to be unique within Unify and can be changed at any time.

​
description
string
required

This is a description of the object. It is not required but will be shown in the UI to help understand the purpose of the object. Typically, this should be a short sentence or two explaining the object.

Response

Response for a successful create operation.

​
status
enum<string>
required
Available options:
success
​
data
object
required
⌘I