Describe Custom Activity Type
Returns metadata for a specific custom activity type.
Parameters
Path 1
apiName string requiredAPI Name of the activity type
Query 1
Responses
200 OK ResponseOfCustomActivityType
errors array of Error required
Array of errors that occurred if the request was unsuccessful
Model Error
code string required Error code of the error. See full list of error codes here
message string required Message describing the cause of the error
moreResult boolean Boolean indicating if there are more results in subsequent pages
nextPageToken string Paging token given if the result set exceeded the allowed batch size
requestId string required Id of the request made
result array of CustomActivityType required
Array of results for individual records in the operation, may be empty
Model CustomActivityType
apiName string API Name of the type. The API name must be unique and alphanumeric, containing at least one letter. It is highly recommended to prepend a unique namespace of up to sixteen characters to the API name. Required on creation
attributes array of CustomActivityTypeAttribute
List of attributes for the activity type. May only be added or update through Create or Update Custom Activity Type Attributes
Model CustomActivityTypeAttribute
apiName string required API Name of the attribute
dataType string Data type of the attribute
Show all 11 values
string boolean integer float link email currency date datetime phone text
description string Description of the attribute
isPrimary boolean Whether the attribute is the primary attribute of the activity type. There may only be one primary attribute at a time
name string required Human-readable display name of the attribute
createdAt string Datetime when the activity type was created
description string Description of the activity type
filterName string Human-readable name for the associated filter of the activity type. Required on creation
id integer (int32) name string Human-readable display name of the type. Required on creation
primaryAttribute CustomActivityTypeAttribute
Primary Attribute of the activity type. Required on creation
Model CustomActivityTypeAttribute
apiName string required API Name of the attribute
dataType string Data type of the attribute
Show all 11 values
string boolean integer float link email currency date datetime phone text
description string Description of the attribute
isPrimary boolean Whether the attribute is the primary attribute of the activity type. There may only be one primary attribute at a time
name string required Human-readable display name of the attribute
status string State of the activity type
Values draft approved deleted approved with draft
triggerName string Human-readable name for the associated trigger of the activity type. Required on creation
updatedAt string Datetime when the activity type was most recently updated
success boolean required Whether the request succeeded
warnings array of Warning required
Array of warnings given for the operation
Model Warning
code integer (int32) required Integer code of the warning
message string required Message describing the warning
Generated example
{
"errors": [
{
"code": "string",
"message": "string"
}
],
"moreResult": false,
"nextPageToken": "example-token",
"requestId": "123",
"result": [
{
"apiName": "Example name",
"attributes": [
{
"apiName": "Example name",
"dataType": "string",
"description": "string",
"isPrimary": false,
"name": "Example name"
}
],
"createdAt": "string",
"description": "string",
"filterName": "Example name",
"id": 123,
"name": "Example name",
"primaryAttribute": {
"apiName": "Example name",
"dataType": "string",
"description": "string",
"isPrimary": false,
"name": "Example name"
},
"status": "draft",
"triggerName": "Example name",
"updatedAt": "string"
}
],
"success": false,
"warnings": [
{
"code": 123,
"message": "string"
}
]
}Referenced models
Generated from swagger-mapi.json. Generated examples are inferred from the schema; they are illustrative and may not be valid production payloads.