A valid request URL is required to generate request examples{
"banner": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"environment_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"kind": "text",
"slot": "<string>",
"active": true,
"starts_at": "2023-11-07T05:31:56Z",
"ends_at": "2023-11-07T05:31:56Z",
"priority": 123,
"dismissible": true,
"title": "<string>",
"body": "<string>",
"icon": "<string>",
"tone": "info",
"cta_label": "<string>",
"cta_url": "<string>",
"image_url": "<string>",
"image_alt": "<string>",
"segment_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"dismissals": 123,
"views": 123,
"viewers": 123,
"clicks": 123,
"clickers": 123,
"created_by": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
},
"tones": [
"<string>"
],
"icons": [
"<string>"
]
}{
"error": {
"code": "forbidden",
"message": "your role does not allow this action"
}
}{
"error": {
"code": "forbidden",
"message": "your role does not allow this action"
}
}{
"error": {
"code": "forbidden",
"message": "your role does not allow this action"
}
}{
"error": {
"code": "forbidden",
"message": "your role does not allow this action"
}
}Read one banner
Requires engagement:manage. The banner, and the tone and icon vocabularies a text banner may name.
A valid request URL is required to generate request examples{
"banner": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"environment_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"kind": "text",
"slot": "<string>",
"active": true,
"starts_at": "2023-11-07T05:31:56Z",
"ends_at": "2023-11-07T05:31:56Z",
"priority": 123,
"dismissible": true,
"title": "<string>",
"body": "<string>",
"icon": "<string>",
"tone": "info",
"cta_label": "<string>",
"cta_url": "<string>",
"image_url": "<string>",
"image_alt": "<string>",
"segment_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"dismissals": 123,
"views": 123,
"viewers": 123,
"clicks": 123,
"clickers": 123,
"created_by": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
},
"tones": [
"<string>"
],
"icons": [
"<string>"
]
}{
"error": {
"code": "forbidden",
"message": "your role does not allow this action"
}
}{
"error": {
"code": "forbidden",
"message": "your role does not allow this action"
}
}{
"error": {
"code": "forbidden",
"message": "your role does not allow this action"
}
}{
"error": {
"code": "forbidden",
"message": "your role does not allow this action"
}
}Autorizações
A staff session token, uk_st_…. Minted by sign-up, sign-in or the two-factor exchange. Only a 401 means it is spent; not_a_member (403) is about the organization named in X-Organization-Id and leaves the token good for the others.
Cabeçalhos
The organization the caller is acting on — the org_… code that appears in the panel URL. It identifies; the membership JOIN is what authorizes, so a forged code reads nothing: the answer is not_a_member (403), which does not mean the session is over. Absent, the session's default organization answers, or — if that membership was revoked while the session was open — any other one the caller still holds.
Parâmetros de caminho
Resposta
The banner.
A message on your users' screens, in a slot your own developer left room for. kind decides which fields carry the content — text is drawn by the widget in your palette, image is a picture you made and the widget only frames — and it cannot change, because the two fill different columns and turning one into the other would discard what somebody wrote.
Show child attributes
Show child attributes