Context Tag (GET, POST, PATCH)

Query, create, and update context tag.

Resource

1/connect/context-definitions/{contextDefinitionId}/context-tags

The {contextDefinitionId} parameter is the ID of the context definition.

Example for GET

1https://{yourInstance}.salesforce.com/services/data/v59.0/connect/context-definitions/{contextDefinitionId}/context-tags

{yourInstance} is the domain name of your Salesforce instance.

Example for POST

1https://{yourInstance}.salesforce.com/services/data/v59.0/connect/context-definitions/{contextDefinitionId}/context-tags

Example for PATCH

1https://{yourInstance}.salesforce.com/services/data/v59.0/connect/context-definitions/{contextDefinitionId}/context-tags

Available Version

59.0

Requires Chatter

HTTP Methods

GET, POST, PATCH

Response Body for GET

Context Tag List Output

When the includeReferencedDefinitionTag query parameter is set to true in a GET request, the response will include the name of the context tag in the format ContextDeveloperName.tagName.

Note

Request Body for POST

JSON Example

1{
2    "contextTags": [
3        {
4            "name": "Attribute_Tag",
5            "contextAttributeId": "11nxx000001hOozAAE"
6        },
7        {
8            "name": "Node_Tag",
9            "contextNodeId": "11oxx000001G9D2AAK"
10        }
11    ]
12}

Properties

Name	Type	Description	Required or Optional	Available Version
`contextAttributeId`	String	ID of the (parent) context attribute.	Required	59.0
`contextNodeId`	String	ID of the (parent) context node.	Required	59.0
`contextTagId`	String	ID of this Context tag. Required only for update.	Optional	59.0
`name`	String	Name of the context tag.	Required	59.0

Response Body for POST

Context Tag List Output

Request Body for PATCH

JSON Example

1{
2    "contextTags": [
3        {
4            "name": "Updated_ATag",
5            "contextTagId": "11kxx00000ZzcDpAAJ"
6        }
7    ]
8}

Response Body for PATCH

Context Tag List Output