younifyd
Menu

Create Brand

Create Brand

POST/management/v1/projects/{projectId}/branding

Use it in a workflow

  1. Add a step and choose the Voucherify connector.
  2. Pick the Create Brand action (under Management).
  3. Fill in the fields below, then reference the result from later steps as {{createBrand.response.data}}.

Request

Path parameters

projectIdstringrequired

Provide the unique identifier of the project.

Request body

Enter the body as JSON in the step's Body field.

brandobject

Defines basic brand details.

namestring

Defines brand name.

privacy_policy_urlstring

Defines the URL to the brand's privacy policy. It must be a valid URL format.

terms_of_use_urlstring

Defines the URL to the brand's terms of use. It must be a valid URL format.

permission_reminderstring

Defines the message that is displayed to customers who opted in an email newsletter.

Default "You are receiving this email because you opted in at our website."

website_urlstring

Defines the URL to the brand's website. It must be a valid URL format.

addressobject

Defines the address details.

streetstring

Defines the brand's street.

citystring

Defines the brand's city.

postalstring

Defines the brand's postal code.

statestring

Defines the brand's state or similar administrative area.

countrystring

Defines the brand's country.

contactobject

Defines contact details.

emailstring

Defines the brand's email address. It must be a valid email format.

phonestring

Defines the brand's phone number.

json
{
  "brand": {
    "name": "string",
    "privacy_policy_url": "string",
    "terms_of_use_url": "string",
    "permission_reminder": "You are receiving this email because you opted in at our website.",
    "website_url": "string"
  },
  "address": {
    "street": "string",
    "city": "string",
    "postal": "string",
    "state": "string",
    "country": "string"
  },
  "contact": {
    "email": "string",
    "phone": "string"
  }
}

Response

Returns 200 with an object. Read it in later steps with {{createBrand.response.data.<field>}}.

Need more? See the Voucherify guide for connection setup and behaviour shared by every action.