Type Delegation
Description
Notification about a DELEGATION event. DELEGATION notification type is generated when:
- Brand (explicit or "shadow") is delegated to a partner.
- Brand is updated or deleted.
- Brand location is created, updated, or deleted.
Response Body
| Parent | Name | Output |
|---|---|---|
$. | data[] | |
data[] | orgId | |
data[] | id | |
data[] | createdDate | |
data[] | feedbackUrl | |
data[] | operation | |
data[] | resourceDetails | |
data[] | type | |
resourceDetails | resourceId | |
resourceDetails | resourceType | |
resourceDetails | state | |
resourceDetails | delegationDetails | |
delegationDetails | orgId | |
delegationDetails | orgLegalName | |
delegationDetails | state | |
resourceDetails | brandId | |
resourceDetails | etag |
Brand ID
brandId (string) is the unique identifier of the brand associated with the delegated location. This field is only applicable for delegation notifications related to locations, and will be present when a location is delegated to a partner, or when a delegated location is updated or deleted.
Etag
etag (string) is the unique identifier representing a specific version of the resource. This field is only applicable for delegation notifications related to locations, and will be present when a location is delegated to a partner, or when a delegated location is updated or deleted. Delegated partners can use the etag value to determine if their local copy of the resource is up to date, and to detect if any changes have been made to the resource since it was last retrieved.
Operation
operation (string) identifies the API operation invoked by an organization. Possible values: CREATE, DELETE, or UPDATE.
Org ID
delegationDetails.orgId (string) identifies the organization that delegated you.
State
state (string) describes the delegation relationship that exists between the organizations (location owner/partner). Possible values: ACTIVE, NOT_ACTIVE, or PENDING.
Example Response Bodies
Example One
New brand is created which is then delegated to partner. The following notification is generated.
| Notification For | Process Initiated by |
|---|---|
| Delegated partner | Location owner |
Delegated partner calls the notification API using their own orgId as the URI parameter, along with their own access token, to retrieve the notification
{
"data": [
{
"orgId": "9467895078742654994",
"id": "9467895078742654921",
"createdDate": "2026-10-02T01:32:59.00Z",
"type": "DELEGATION",
"feedbackUrl": "/v1/orgs/9467895078742654934/feedback?ql=id==9467895078742654610",
"operation": "CREATE",
"resourceDetails": {
"resourceType": "BRAND",
"resourceId": "9467895078742654918",
"state": "SUBMITTED",
"delegationDetails": {
"orgId": "9467895078742654934",
"orgLegalName": "Organization Legal Name",
"state": "ACTIVE"
}
}
}
],
"pagination": {
"cursors": {
"after": "3T94a61d9b495118"
},
"next": "/v1/orgs/9467895078742654994/notifications?ql=createdDate=ge=2026-07-01T00:00:00Z;createdDate=le=2026-10-03T00:00:00Z;resourceType==BRAND&limit=1&after=3T94a61d9b495118"
}
}
Example Two
Delegated brand is updated. The following notification is generated.
| Notification For | Process Initiated by |
|---|---|
| Delegated partner | Location owner |
Delegated partner calls the notification API using their own orgId as the URI parameter, along with their own access token, to retrieve the notification
{
"data": [
{
"orgId": "9467895078742654994",
"id": "9467895078742654969",
"createdDate": "2026-10-10T00:00:00.00Z",
"type": "DELEGATION",
"feedbackUrl": "/v1/orgs/9467895078742654934/feedback?ql=id==9467895078742654603",
"operation": "UPDATE",
"resourceDetails": {
"resourceType": "BRAND",
"resourceId": "9467895078742654918",
"state": "SUBMITTED",
"delegationDetails": {
"orgId": "9467895078742654934",
"orgLegalName": "Organization Legal Name",
"state": "ACTIVE"
}
}
}
],
"pagination": {
"cursors": {
"after": "6Y89a61d9b492245"
},
"next": "/v1/orgs/9467895078742654994/notifications?ql=createdDate=ge=2026-07-01T00:00:00Z;createdDate=le=2026-10-03T00:00:00Z;resourceType==BRAND&limit=1&after=6Y89a61d9b492245"
}
}