Upsert brand

1 import requests 2 3 url = "https://api.cash.app/network/v1/brands" 4 5 payload = { "brand": { 6 "name": "brand name", 7 "reference_id": "reference ID", 8 "profile_image_url": "https://upload.wikimedia.org/wikipedia/commons/thumb/6/60/Earth_from_Space.jpg/480px-Earth_from_Space.jpg", 9 "color": "#ffffff" 10 } } 11 headers = { 12 "Accept": "Accept", 13 "X-Region": "X-Region", 14 "X-Signature": "X-Signature", 15 "User-Agent": "User-Agent", 16 "Content-Type": "application/json" 17 } 18 19 response = requests.put(url, json=payload, headers=headers) 20 21 print(response.json())

1 { 2 "brand": { 3 "id": "string", 4 "name": "string", 5 "created_at": "2021-01-01T00:00:00Z", 6 "updated_at": "2021-01-01T00:00:00Z", 7 "reference_id": "example-id", 8 "color": "#ffffff", 9 "profile_image_url": "https://franklin-assets.s3.amazonaws.com/merchants/assets/v3/generic/m_category_business.png", 10 "metadata": {} 11 } 12 }

Creates or updates a brand based on the brand’s reference_id.

If a brand with a matching reference_id is found, it will be updated. Ensure proper mapping; if no matching brand is found, a new one will be created.

The HTTP response code (200 OK or 201 Created) indicates whether the resource was updated or created, respectively.

Note

brand_id is the primary unique identifier for all Brand APIs. Be cautious when using reference_id as a unique identifier.

This endpoint is not rate limited.

Scopes: BRANDS_WRITE

Creates or updates a brand based on the brand's `reference_id`. If a brand with a matching `reference_id` is found, it will be updated. Ensure proper mapping; if no matching brand is found, a new one will be created. The HTTP response code (`200 OK` or `201 Created`) indicates whether the resource was updated or created, respectively. <Note title="Note"> `brand_id` is the primary unique identifier for all Brand APIs. Be cautious when using `reference_id` as a unique identifier. </Note> **This endpoint is not rate limited.** Scopes: `BRANDS_WRITE`

Request

brandobjectRequired

Details about the brand to create or update.

Response

brandobject or null

A brand is the entity a customer perceives that they are transacting with.

Note

Headers

Request

Response

Errors

Note