rmaConfigurationUpdate

Updates an existing RMA configuration. All fields except id are optional — only the fields you provide will be updated.

Required scope: edit_rma_configurations

---

Mutation

mutation RmaConfigurationUpdate($input: RmaConfigurationUpdateInput!) {
  rmaConfigurationUpdate(input: $input) {
    id
    locationId
    portalIsActive
    autoAccept
    acceptMulti
    needsPictures
    requestProductState
    authorizationDelay
    maxAuthorizationDelay
    reasonLines
    expectedResolutions
    emailContact
    shopUrl
    domain
    autoGenerateFinancialResolution
    autoExecuteFinancialResolution
    retainedAmountForShipping
    refundShippingOnPartialReturn
    refundShippingOnCompleteReturn
  }
}

---

Input: RmaConfigurationUpdateInput

Field	Type	Required	Description
id	ID	✅	UUID of the configuration to update
locationId	String	❌	Location UUID this configuration applies to
portalIsActive	Boolean	❌	Enable or disable the customer-facing return portal
domain	String	❌	Custom domain for the return portal
organizationId	String	❌	Organization UUID
tpAppIds	[String]	❌	Third-party application IDs
needsPictures	Boolean	❌	Require customers to upload photos of returned items
authorizationDelay	Int	❌	Number of days after purchase within which returns are authorized
maxAuthorizationDelay	Int	❌	Maximum number of days for return authorization
autoAccept	Boolean	❌	Automatically accept return requests without manual review
acceptMulti	Boolean	❌	Allow multiple returns per original order
requestProductState	Boolean	❌	Require customers to specify product condition
reasonLines	[RmaOrderReturnReason]	❌	Allowed return reasons: WRONG_ITEM, NOT_RECEIVED, SIZE_PROBLEM, COLOR_PROBLEM, DEFECTIVE, DAMAGED_PRODUCT, UNSATISFIED, ITEMS_NOT_SOLD
expectedResolutions	[RmaOrderExpectedResolution]	❌	Allowed resolution types: NONE, VOUCHER, REPLACE, REFUND
emailContact	String	❌	Contact email displayed on the return portal
shopUrl	String	❌	Shop URL for linking back to the store
customCss	String	❌	Custom CSS to style the return portal
titleColor	String	❌	Title color for the return portal (hex code)
backgroundColor	String	❌	Background color for the return portal (hex code)
headline	String	❌	Headline text displayed on the return portal
metaDescription	String	❌	Meta description for SEO
metaTitle	String	❌	Meta title for SEO
autoGenerateFinancialResolution	Boolean	❌	Auto-generate financial resolution when return is completed
autoExecuteFinancialResolution	Boolean	❌	Auto-execute financial resolution without manual review
retainedAmountForShipping	Float	❌	Default amount to retain for return shipping costs
refundShippingOnPartialReturn	Boolean	❌	Refund original shipping cost on partial returns
refundShippingOnCompleteReturn	Boolean	❌	Refund original shipping cost on complete returns

---

Example Variables

{
  "input": {
    "id": "config-uuid-001",
    "autoAccept": true,
    "authorizationDelay": 14,
    "retainedAmountForShipping": 6.99,
    "refundShippingOnPartialReturn": true,
    "headline": "Easy returns within 14 days"
  }
}

---

Example Response

{
  "data": {
    "rmaConfigurationUpdate": {
      "id": "config-uuid-001",
      "locationId": "loc-uuid-001",
      "portalIsActive": true,
      "autoAccept": true,
      "acceptMulti": true,
      "needsPictures": true,
      "requestProductState": true,
      "authorizationDelay": 14,
      "maxAuthorizationDelay": 60,
      "reasonLines": [
        "WRONG_ITEM",
        "SIZE_PROBLEM",
        "COLOR_PROBLEM",
        "DEFECTIVE",
        "DAMAGED_PRODUCT",
        "UNSATISFIED"
      ],
      "expectedResolutions": [
        "REFUND",
        "VOUCHER",
        "REPLACE"
      ],
      "emailContact": "returns@mystore.com",
      "shopUrl": "https://mystore.com",
      "domain": "returns.mystore.com",
      "autoGenerateFinancialResolution": true,
      "autoExecuteFinancialResolution": false,
      "retainedAmountForShipping": 6.99,
      "refundShippingOnPartialReturn": true,
      "refundShippingOnCompleteReturn": true
    }
  }
}

---

Code Examples

curl

curl -X POST https://api-v3.happycolis.com/graphql \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  -d '{
    "query": "mutation RmaConfigurationUpdate($input: RmaConfigurationUpdateInput!) { rmaConfigurationUpdate(input: $input) { id locationId portalIsActive autoAccept authorizationDelay retainedAmountForShipping } }",
    "variables": {
      "input": {
        "id": "config-uuid-001",
        "autoAccept": true,
        "authorizationDelay": 14,
        "retainedAmountForShipping": 6.99,
        "headline": "Easy returns within 14 days"
      }
    }
  }'

Node.js

const mutation = `
  mutation RmaConfigurationUpdate($input: RmaConfigurationUpdateInput!) {
    rmaConfigurationUpdate(input: $input) {
      id
      locationId
      portalIsActive
      autoAccept
      authorizationDelay
      retainedAmountForShipping
    }
  }
`;

const variables = {
  input: {
    id: 'config-uuid-001',
    autoAccept: true,
    authorizationDelay: 14,
    retainedAmountForShipping: 6.99,
    headline: 'Easy returns within 14 days',
  },
};

const response = await fetch('https://api-v3.happycolis.com/graphql', {
  method: 'POST',
  headers: {
    'Content-Type': 'application/json',
    'Authorization': `Bearer ${process.env.ACCESS_TOKEN}`,
  },
  body: JSON.stringify({ query: mutation, variables }),
});

const { data } = await response.json();
console.log(data.rmaConfigurationUpdate);

Python

import os
import requests

mutation = """
mutation RmaConfigurationUpdate($input: RmaConfigurationUpdateInput!) {
  rmaConfigurationUpdate(input: $input) {
    id
    locationId
    portalIsActive
    autoAccept
    authorizationDelay
    retainedAmountForShipping
  }
}
"""

variables = {
    "input": {
        "id": "config-uuid-001",
        "autoAccept": True,
        "authorizationDelay": 14,
        "retainedAmountForShipping": 6.99,
        "headline": "Easy returns within 14 days",
    }
}

response = requests.post(
    'https://api-v3.happycolis.com/graphql',
    headers={'Authorization': f'Bearer {os.environ["ACCESS_TOKEN"]}'},
    json={'query': mutation, 'variables': variables},
)

data = response.json()['data']
print(data['rmaConfigurationUpdate'])

PHP

<?php
$mutation = <<<'GQL'
mutation RmaConfigurationUpdate($input: RmaConfigurationUpdateInput!) {
  rmaConfigurationUpdate(input: $input) {
    id
    locationId
    portalIsActive
    autoAccept
    authorizationDelay
    retainedAmountForShipping
  }
}
GQL;

$variables = [
    'input' => [
        'id'                        => 'config-uuid-001',
        'autoAccept'                => true,
        'authorizationDelay'        => 14,
        'retainedAmountForShipping' => 6.99,
        'headline'                  => 'Easy returns within 14 days',
    ],
];

$ch = curl_init('https://api-v3.happycolis.com/graphql');
curl_setopt_array($ch, [
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_POST           => true,
    CURLOPT_POSTFIELDS     => json_encode(['query' => $mutation, 'variables' => $variables]),
    CURLOPT_HTTPHEADER     => [
        'Content-Type: application/json',
        'Authorization: Bearer ' . getenv('ACCESS_TOKEN'),
    ],
]);

$result = json_decode(curl_exec($ch), true);
curl_close($ch);

print_r($result['data']['rmaConfigurationUpdate']);

Go

package main

import (
	"bytes"
	"encoding/json"
	"fmt"
	"net/http"
	"os"
)

func main() {
	mutation := `
		mutation RmaConfigurationUpdate($input: RmaConfigurationUpdateInput!) {
			rmaConfigurationUpdate(input: $input) {
				id
				locationId
				portalIsActive
				autoAccept
				authorizationDelay
				retainedAmountForShipping
			}
		}`

	variables := map[string]any{
		"input": map[string]any{
			"id":                        "config-uuid-001",
			"autoAccept":                true,
			"authorizationDelay":        14,
			"retainedAmountForShipping": 6.99,
			"headline":                  "Easy returns within 14 days",
		},
	}

	body, _ := json.Marshal(map[string]any{
		"query":     mutation,
		"variables": variables,
	})

	req, _ := http.NewRequest("POST", "https://api-v3.happycolis.com/graphql", bytes.NewBuffer(body))
	req.Header.Set("Content-Type", "application/json")
	req.Header.Set("Authorization", "Bearer "+os.Getenv("ACCESS_TOKEN"))

	resp, _ := http.DefaultClient.Do(req)
	defer resp.Body.Close()

	var result map[string]any
	json.NewDecoder(resp.Body).Decode(&result)
	fmt.Println(result["data"])
}