Crea un brand

Crea un brand: l'oggetto di primo livello della Social API. A un brand appartengono gli account social che vi colleghi e ogni post pubblicato da questi account. Non puoi effettuare altre chiamate alla Social API finché non esiste almeno un brand, quindi questa è la prima richiesta di qualsiasi integrazione Social.

Caso d'uso: configurare la pubblicazione sui social per un cliente. Quando un cliente si registra nel tuo prodotto, crea un brand per ogni attività per cui vuole pubblicare. Memorizza il valore socialProfile.id restituito nel tuo record di quell'attività: è il token di percorso brandId in POST /social/brands/{brandId}/connections/link e GET /social/brands/{brandId}/posts, e il campo socialProfileId nel corpo di ogni post che crei. Poi indirizza l'utente al link di collegamento ospitato per ogni piattaforma su cui vuole pubblicare.

Note.

• Il corpo della richiesta deve essere racchiuso in un oggetto input. Ogni operazione di scrittura nella Social API usa questa struttura, con una sola eccezione: il link di collegamento accetta un corpo senza oggetto contenitore.
• Controlla success, non lo stato HTTP. Un errore di validazione — un valore profileName mancante o un valore timezone.tzCode sconosciuto — restituisce HTTP 200 con success: false e il motivo in error. Considera la chiamata riuscita solo quando success è true.
• Solo profileName e timezone sono obbligatori. businessIntent e categories hanno come valori predefiniti rispettivamente general e un elenco vuoto, quindi un'integrazione che non ha un equivalente di questi campi può ometterli del tutto.
• timezone.tzCode non è un elemento decorativo. Un post programmato con scheduleDate + scheduleTime viene interpretato nel fuso orario del brand, non in quello di chi effettua la chiamata né in UTC. Modificarlo in seguito non cambia l'orario dei post già programmati.
• Il brand appartiene sempre all'account associato alla chiave API. Non è possibile creare un brand in un altro account: qualsiasi identificatore di account presente nel corpo viene ignorato.
• Gli ID dei brand sono semplici UUID. Non sono gli ID relay in Base64 usati da Locations e dai Posts delle sedi, quindi non codificarli né decodificarli. Lo stesso ID compare come token di percorso brandId e come campo socialProfileId nel corpo: brandId è sempre e solo un token dell'URL, mai un campo del corpo.
• Un piano API non prevede alcun limite al numero di brand. I brand sono illimitati e non vengono conteggiati ai fini dell'utilizzo, quindi questa chiamata non viene mai rifiutata per il raggiungimento di un limite e non devi verificare la capacità residua prima di crearne uno. A essere conteggiati sono i collegamenti — un account social collegato a un brand su una rete. Consulta Piani e componenti aggiuntivi per le fasce di collegamenti e il prezzo di un pacchetto di collegamenti, e GET /social/limits per verificare quanti collegamenti puoi ancora creare prima di indirizzare un utente a un link di collegamento.

Operazione di scrittura: non eseguita sull'account reale. La richiesta e la risposta mostrate sono costruite a partire dallo schema API.