!Only supports Custom Objects and Company (Business) today. Will be extended to other Standard Objects in the future.
Request
Use the Access Token generated with user type as Sub-Account (OR) Private Integration Token of Sub-Account.
Provide your bearer token in the Authorization header when making requests to protected resources.
Example: Authorization: Bearer 123
Provide your bearer token in the Authorization header when making requests to protected resources.
Path Parameters
id
stringBody
name
stringField name
Example:
Name
locationId
stringLocation Id
Example:
ve9EPM428h8vShlRW1KT
Headers
Authorization
stringAccess Token
Example:
Bearer 9c48df2694a849b6089f9d0d3513efe
Version
stringAPI Version
Allowed value:
2021-07-28
Responses
200
Successful response
Body
id
stringUnique identifier of the object
objectKey
stringThe key for your custom object. This key uniquely identifies the custom object. Example: "custom_object.pet" for a custom object related to pets.
Example:
custom_object.pet
locationId
stringLocation Id
Example:
ve9EPM428h8vShlRW1KT
name
stringField name
Example:
Name
422
Unprocessable Entity
Body
statusCode
number
Example:
422
message
array[string]
Example:
["Unprocessable Entity"]
error
string
Example:
Unprocessable Entity
401
Unauthorized
Body
statusCode
number
Example:
401
message
string
Example:
Invalid token: access token is invalid
error
string
Example:
Unauthorized
400
Bad Request
Body
statusCode
number
Example:
400
message
string
Example:
Bad Request