Atualizar instância RCS
curl --request PATCH \
--url https://api.notifique.dev/v1/rcs/instances/{instanceId} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"displayName": "Minha Marca Oficial",
"agentProfile": {
"brandName": "Minha Marca",
"displayName": "Minha Marca",
"hostingRegion": "NORTH_AMERICA",
"billingCategory": "NON_CONVERSATIONAL",
"agentUseCase": "PROMOTIONAL",
"description": "Campanhas e avisos promocionais da Minha Marca.",
"color": "#1A73E8",
"logoUri": "https://cdn.example.com/rcs/logo.png",
"heroUri": "https://cdn.example.com/rcs/hero.png",
"phoneNumbers": [
{
"value": "+551140028922",
"label": "SAC"
}
],
"emails": [
{
"value": "contato@minhamarca.com",
"label": "Suporte"
}
],
"websites": [
{
"uri": "https://minhamarca.com",
"label": "Site"
}
],
"privacy": {
"uri": "https://minhamarca.com/privacidade"
},
"termsConditions": {
"uri": "https://minhamarca.com/termos"
},
"brandContactName": "Maria Silva",
"brandContactEmailAddress": "maria@minhamarca.com",
"brandWebsiteUrl": "https://minhamarca.com",
"attachments": [],
"brazil": {
"cnpj": "12345678000199",
"legalName": "Minha Marca LTDA",
"brandAuthorizationAccepted": true
},
"launch": {
"contacts": [
{
"name": "Maria Silva",
"title": "Marketing",
"email": "maria@minhamarca.com"
}
],
"triggerDescription": "Cliente recebe RCS após opt-in no site.",
"interactionsDescription": "Botões de resposta e links para landing pages.",
"optoutDescription": "Responda SAIR para cancelar.",
"agentAccessInstructions": "Acesse pelo app Mensagens do Android."
}
}
}
'const options = {
method: 'PATCH',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
displayName: 'Minha Marca Oficial',
agentProfile: {
brandName: 'Minha Marca',
displayName: 'Minha Marca',
hostingRegion: 'NORTH_AMERICA',
billingCategory: 'NON_CONVERSATIONAL',
agentUseCase: 'PROMOTIONAL',
description: 'Campanhas e avisos promocionais da Minha Marca.',
color: '#1A73E8',
logoUri: 'https://cdn.example.com/rcs/logo.png',
heroUri: 'https://cdn.example.com/rcs/hero.png',
phoneNumbers: [{value: '+551140028922', label: 'SAC'}],
emails: [{value: 'contato@minhamarca.com', label: 'Suporte'}],
websites: [{uri: 'https://minhamarca.com', label: 'Site'}],
privacy: {uri: 'https://minhamarca.com/privacidade'},
termsConditions: {uri: 'https://minhamarca.com/termos'},
brandContactName: 'Maria Silva',
brandContactEmailAddress: 'maria@minhamarca.com',
brandWebsiteUrl: 'https://minhamarca.com',
attachments: [],
brazil: {
cnpj: '12345678000199',
legalName: 'Minha Marca LTDA',
brandAuthorizationAccepted: true
},
launch: {
contacts: [{name: 'Maria Silva', title: 'Marketing', email: 'maria@minhamarca.com'}],
triggerDescription: 'Cliente recebe RCS após opt-in no site.',
interactionsDescription: 'Botões de resposta e links para landing pages.',
optoutDescription: 'Responda SAIR para cancelar.',
agentAccessInstructions: 'Acesse pelo app Mensagens do Android.'
}
}
})
};
fetch('https://api.notifique.dev/v1/rcs/instances/{instanceId}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.notifique.dev/v1/rcs/instances/{instanceId}"
payload = {
"displayName": "Minha Marca Oficial",
"agentProfile": {
"brandName": "Minha Marca",
"displayName": "Minha Marca",
"hostingRegion": "NORTH_AMERICA",
"billingCategory": "NON_CONVERSATIONAL",
"agentUseCase": "PROMOTIONAL",
"description": "Campanhas e avisos promocionais da Minha Marca.",
"color": "#1A73E8",
"logoUri": "https://cdn.example.com/rcs/logo.png",
"heroUri": "https://cdn.example.com/rcs/hero.png",
"phoneNumbers": [
{
"value": "+551140028922",
"label": "SAC"
}
],
"emails": [
{
"value": "contato@minhamarca.com",
"label": "Suporte"
}
],
"websites": [
{
"uri": "https://minhamarca.com",
"label": "Site"
}
],
"privacy": { "uri": "https://minhamarca.com/privacidade" },
"termsConditions": { "uri": "https://minhamarca.com/termos" },
"brandContactName": "Maria Silva",
"brandContactEmailAddress": "maria@minhamarca.com",
"brandWebsiteUrl": "https://minhamarca.com",
"attachments": [],
"brazil": {
"cnpj": "12345678000199",
"legalName": "Minha Marca LTDA",
"brandAuthorizationAccepted": True
},
"launch": {
"contacts": [
{
"name": "Maria Silva",
"title": "Marketing",
"email": "maria@minhamarca.com"
}
],
"triggerDescription": "Cliente recebe RCS após opt-in no site.",
"interactionsDescription": "Botões de resposta e links para landing pages.",
"optoutDescription": "Responda SAIR para cancelar.",
"agentAccessInstructions": "Acesse pelo app Mensagens do Android."
}
}
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.notifique.dev/v1/rcs/instances/{instanceId}"
payload := strings.NewReader("{\n \"displayName\": \"Minha Marca Oficial\",\n \"agentProfile\": {\n \"brandName\": \"Minha Marca\",\n \"displayName\": \"Minha Marca\",\n \"hostingRegion\": \"NORTH_AMERICA\",\n \"billingCategory\": \"NON_CONVERSATIONAL\",\n \"agentUseCase\": \"PROMOTIONAL\",\n \"description\": \"Campanhas e avisos promocionais da Minha Marca.\",\n \"color\": \"#1A73E8\",\n \"logoUri\": \"https://cdn.example.com/rcs/logo.png\",\n \"heroUri\": \"https://cdn.example.com/rcs/hero.png\",\n \"phoneNumbers\": [\n {\n \"value\": \"+551140028922\",\n \"label\": \"SAC\"\n }\n ],\n \"emails\": [\n {\n \"value\": \"contato@minhamarca.com\",\n \"label\": \"Suporte\"\n }\n ],\n \"websites\": [\n {\n \"uri\": \"https://minhamarca.com\",\n \"label\": \"Site\"\n }\n ],\n \"privacy\": {\n \"uri\": \"https://minhamarca.com/privacidade\"\n },\n \"termsConditions\": {\n \"uri\": \"https://minhamarca.com/termos\"\n },\n \"brandContactName\": \"Maria Silva\",\n \"brandContactEmailAddress\": \"maria@minhamarca.com\",\n \"brandWebsiteUrl\": \"https://minhamarca.com\",\n \"attachments\": [],\n \"brazil\": {\n \"cnpj\": \"12345678000199\",\n \"legalName\": \"Minha Marca LTDA\",\n \"brandAuthorizationAccepted\": true\n },\n \"launch\": {\n \"contacts\": [\n {\n \"name\": \"Maria Silva\",\n \"title\": \"Marketing\",\n \"email\": \"maria@minhamarca.com\"\n }\n ],\n \"triggerDescription\": \"Cliente recebe RCS após opt-in no site.\",\n \"interactionsDescription\": \"Botões de resposta e links para landing pages.\",\n \"optoutDescription\": \"Responda SAIR para cancelar.\",\n \"agentAccessInstructions\": \"Acesse pelo app Mensagens do Android.\"\n }\n }\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}{
"success": true,
"data": {
"id": "inst_rcs_abc123",
"name": "Minha Marca RCS",
"status": "PENDING",
"slug": "minha-marca",
"displayName": "Minha Marca",
"connectionKind": "comtele",
"onboardingStatus": "DRAFT",
"onboardingError": null,
"googleAgentId": null,
"agentProfile": {
"brandName": "Minha Marca",
"displayName": "Minha Marca",
"hostingRegion": "NORTH_AMERICA",
"billingCategory": "NON_CONVERSATIONAL",
"agentUseCase": "PROMOTIONAL",
"description": "Campanhas e avisos promocionais da Minha Marca.",
"color": "#1A73E8",
"logoUri": "https://cdn.example.com/rcs/logo.png",
"heroUri": "https://cdn.example.com/rcs/hero.png",
"phoneNumbers": [
{
"value": "+551140028922",
"label": "SAC"
}
],
"emails": [
{
"value": "contato@minhamarca.com",
"label": "Suporte"
}
],
"websites": [
{
"uri": "https://minhamarca.com",
"label": "Site"
}
],
"privacy": {
"uri": "https://minhamarca.com/privacidade"
},
"termsConditions": {
"uri": "https://minhamarca.com/termos"
},
"brandContactName": "Maria Silva",
"brandContactEmailAddress": "maria@minhamarca.com",
"brandWebsiteUrl": "https://minhamarca.com",
"attachments": [],
"brazil": {
"cnpj": "12345678000199",
"legalName": "Minha Marca LTDA",
"brandAuthorizationAccepted": true
},
"launch": {
"contacts": [
{
"name": "Maria Silva",
"title": "Marketing",
"email": "maria@minhamarca.com"
}
],
"triggerDescription": "Cliente recebe RCS após opt-in no site.",
"interactionsDescription": "Botões de resposta e links para landing pages.",
"optoutDescription": "Responda SAIR para cancelar.",
"agentAccessInstructions": "Acesse pelo app Mensagens do Android."
}
},
"pendingDisplayName": null,
"pendingAgentProfile": null,
"revisionStatus": "NONE",
"revisionSubmittedAt": null,
"revisionRejectedAt": null,
"revisionRejectionReason": null,
"submittedAt": null,
"createdAt": "2025-02-10T10:00:00.000Z",
"updatedAt": "2025-02-10T10:00:00.000Z",
"awaitingPartner": false,
"revisionAwaitingPartner": false
}
}Instâncias
Atualizar instância RCS
Em agente ACTIVE, alterações vão para revisão (pendingAgentProfile).
PATCH
/
v1
/
rcs
/
instances
/
{instanceId}
Atualizar instância RCS
curl --request PATCH \
--url https://api.notifique.dev/v1/rcs/instances/{instanceId} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"displayName": "Minha Marca Oficial",
"agentProfile": {
"brandName": "Minha Marca",
"displayName": "Minha Marca",
"hostingRegion": "NORTH_AMERICA",
"billingCategory": "NON_CONVERSATIONAL",
"agentUseCase": "PROMOTIONAL",
"description": "Campanhas e avisos promocionais da Minha Marca.",
"color": "#1A73E8",
"logoUri": "https://cdn.example.com/rcs/logo.png",
"heroUri": "https://cdn.example.com/rcs/hero.png",
"phoneNumbers": [
{
"value": "+551140028922",
"label": "SAC"
}
],
"emails": [
{
"value": "contato@minhamarca.com",
"label": "Suporte"
}
],
"websites": [
{
"uri": "https://minhamarca.com",
"label": "Site"
}
],
"privacy": {
"uri": "https://minhamarca.com/privacidade"
},
"termsConditions": {
"uri": "https://minhamarca.com/termos"
},
"brandContactName": "Maria Silva",
"brandContactEmailAddress": "maria@minhamarca.com",
"brandWebsiteUrl": "https://minhamarca.com",
"attachments": [],
"brazil": {
"cnpj": "12345678000199",
"legalName": "Minha Marca LTDA",
"brandAuthorizationAccepted": true
},
"launch": {
"contacts": [
{
"name": "Maria Silva",
"title": "Marketing",
"email": "maria@minhamarca.com"
}
],
"triggerDescription": "Cliente recebe RCS após opt-in no site.",
"interactionsDescription": "Botões de resposta e links para landing pages.",
"optoutDescription": "Responda SAIR para cancelar.",
"agentAccessInstructions": "Acesse pelo app Mensagens do Android."
}
}
}
'const options = {
method: 'PATCH',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
displayName: 'Minha Marca Oficial',
agentProfile: {
brandName: 'Minha Marca',
displayName: 'Minha Marca',
hostingRegion: 'NORTH_AMERICA',
billingCategory: 'NON_CONVERSATIONAL',
agentUseCase: 'PROMOTIONAL',
description: 'Campanhas e avisos promocionais da Minha Marca.',
color: '#1A73E8',
logoUri: 'https://cdn.example.com/rcs/logo.png',
heroUri: 'https://cdn.example.com/rcs/hero.png',
phoneNumbers: [{value: '+551140028922', label: 'SAC'}],
emails: [{value: 'contato@minhamarca.com', label: 'Suporte'}],
websites: [{uri: 'https://minhamarca.com', label: 'Site'}],
privacy: {uri: 'https://minhamarca.com/privacidade'},
termsConditions: {uri: 'https://minhamarca.com/termos'},
brandContactName: 'Maria Silva',
brandContactEmailAddress: 'maria@minhamarca.com',
brandWebsiteUrl: 'https://minhamarca.com',
attachments: [],
brazil: {
cnpj: '12345678000199',
legalName: 'Minha Marca LTDA',
brandAuthorizationAccepted: true
},
launch: {
contacts: [{name: 'Maria Silva', title: 'Marketing', email: 'maria@minhamarca.com'}],
triggerDescription: 'Cliente recebe RCS após opt-in no site.',
interactionsDescription: 'Botões de resposta e links para landing pages.',
optoutDescription: 'Responda SAIR para cancelar.',
agentAccessInstructions: 'Acesse pelo app Mensagens do Android.'
}
}
})
};
fetch('https://api.notifique.dev/v1/rcs/instances/{instanceId}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.notifique.dev/v1/rcs/instances/{instanceId}"
payload = {
"displayName": "Minha Marca Oficial",
"agentProfile": {
"brandName": "Minha Marca",
"displayName": "Minha Marca",
"hostingRegion": "NORTH_AMERICA",
"billingCategory": "NON_CONVERSATIONAL",
"agentUseCase": "PROMOTIONAL",
"description": "Campanhas e avisos promocionais da Minha Marca.",
"color": "#1A73E8",
"logoUri": "https://cdn.example.com/rcs/logo.png",
"heroUri": "https://cdn.example.com/rcs/hero.png",
"phoneNumbers": [
{
"value": "+551140028922",
"label": "SAC"
}
],
"emails": [
{
"value": "contato@minhamarca.com",
"label": "Suporte"
}
],
"websites": [
{
"uri": "https://minhamarca.com",
"label": "Site"
}
],
"privacy": { "uri": "https://minhamarca.com/privacidade" },
"termsConditions": { "uri": "https://minhamarca.com/termos" },
"brandContactName": "Maria Silva",
"brandContactEmailAddress": "maria@minhamarca.com",
"brandWebsiteUrl": "https://minhamarca.com",
"attachments": [],
"brazil": {
"cnpj": "12345678000199",
"legalName": "Minha Marca LTDA",
"brandAuthorizationAccepted": True
},
"launch": {
"contacts": [
{
"name": "Maria Silva",
"title": "Marketing",
"email": "maria@minhamarca.com"
}
],
"triggerDescription": "Cliente recebe RCS após opt-in no site.",
"interactionsDescription": "Botões de resposta e links para landing pages.",
"optoutDescription": "Responda SAIR para cancelar.",
"agentAccessInstructions": "Acesse pelo app Mensagens do Android."
}
}
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.notifique.dev/v1/rcs/instances/{instanceId}"
payload := strings.NewReader("{\n \"displayName\": \"Minha Marca Oficial\",\n \"agentProfile\": {\n \"brandName\": \"Minha Marca\",\n \"displayName\": \"Minha Marca\",\n \"hostingRegion\": \"NORTH_AMERICA\",\n \"billingCategory\": \"NON_CONVERSATIONAL\",\n \"agentUseCase\": \"PROMOTIONAL\",\n \"description\": \"Campanhas e avisos promocionais da Minha Marca.\",\n \"color\": \"#1A73E8\",\n \"logoUri\": \"https://cdn.example.com/rcs/logo.png\",\n \"heroUri\": \"https://cdn.example.com/rcs/hero.png\",\n \"phoneNumbers\": [\n {\n \"value\": \"+551140028922\",\n \"label\": \"SAC\"\n }\n ],\n \"emails\": [\n {\n \"value\": \"contato@minhamarca.com\",\n \"label\": \"Suporte\"\n }\n ],\n \"websites\": [\n {\n \"uri\": \"https://minhamarca.com\",\n \"label\": \"Site\"\n }\n ],\n \"privacy\": {\n \"uri\": \"https://minhamarca.com/privacidade\"\n },\n \"termsConditions\": {\n \"uri\": \"https://minhamarca.com/termos\"\n },\n \"brandContactName\": \"Maria Silva\",\n \"brandContactEmailAddress\": \"maria@minhamarca.com\",\n \"brandWebsiteUrl\": \"https://minhamarca.com\",\n \"attachments\": [],\n \"brazil\": {\n \"cnpj\": \"12345678000199\",\n \"legalName\": \"Minha Marca LTDA\",\n \"brandAuthorizationAccepted\": true\n },\n \"launch\": {\n \"contacts\": [\n {\n \"name\": \"Maria Silva\",\n \"title\": \"Marketing\",\n \"email\": \"maria@minhamarca.com\"\n }\n ],\n \"triggerDescription\": \"Cliente recebe RCS após opt-in no site.\",\n \"interactionsDescription\": \"Botões de resposta e links para landing pages.\",\n \"optoutDescription\": \"Responda SAIR para cancelar.\",\n \"agentAccessInstructions\": \"Acesse pelo app Mensagens do Android.\"\n }\n }\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}{
"success": true,
"data": {
"id": "inst_rcs_abc123",
"name": "Minha Marca RCS",
"status": "PENDING",
"slug": "minha-marca",
"displayName": "Minha Marca",
"connectionKind": "comtele",
"onboardingStatus": "DRAFT",
"onboardingError": null,
"googleAgentId": null,
"agentProfile": {
"brandName": "Minha Marca",
"displayName": "Minha Marca",
"hostingRegion": "NORTH_AMERICA",
"billingCategory": "NON_CONVERSATIONAL",
"agentUseCase": "PROMOTIONAL",
"description": "Campanhas e avisos promocionais da Minha Marca.",
"color": "#1A73E8",
"logoUri": "https://cdn.example.com/rcs/logo.png",
"heroUri": "https://cdn.example.com/rcs/hero.png",
"phoneNumbers": [
{
"value": "+551140028922",
"label": "SAC"
}
],
"emails": [
{
"value": "contato@minhamarca.com",
"label": "Suporte"
}
],
"websites": [
{
"uri": "https://minhamarca.com",
"label": "Site"
}
],
"privacy": {
"uri": "https://minhamarca.com/privacidade"
},
"termsConditions": {
"uri": "https://minhamarca.com/termos"
},
"brandContactName": "Maria Silva",
"brandContactEmailAddress": "maria@minhamarca.com",
"brandWebsiteUrl": "https://minhamarca.com",
"attachments": [],
"brazil": {
"cnpj": "12345678000199",
"legalName": "Minha Marca LTDA",
"brandAuthorizationAccepted": true
},
"launch": {
"contacts": [
{
"name": "Maria Silva",
"title": "Marketing",
"email": "maria@minhamarca.com"
}
],
"triggerDescription": "Cliente recebe RCS após opt-in no site.",
"interactionsDescription": "Botões de resposta e links para landing pages.",
"optoutDescription": "Responda SAIR para cancelar.",
"agentAccessInstructions": "Acesse pelo app Mensagens do Android."
}
},
"pendingDisplayName": null,
"pendingAgentProfile": null,
"revisionStatus": "NONE",
"revisionSubmittedAt": null,
"revisionRejectedAt": null,
"revisionRejectionReason": null,
"submittedAt": null,
"createdAt": "2025-02-10T10:00:00.000Z",
"updatedAt": "2025-02-10T10:00:00.000Z",
"awaitingPartner": false,
"revisionAwaitingPartner": false
}
}Autorizações
ntfRcsBearerAuthntfRcsApiKeyHeader
API Key no header Authorization. Exemplo: Authorization: Bearer sk_live_xxxxx
Parâmetros de caminho
Corpo
application/json
Resposta
Instância atualizada.
Esta página foi útil?

