API reference · Sites
Update a site
PATCH/v1/sites/{siteId}
Update a site.
Requires a Bearer access token.
Parameters
This field has no description in the spec.
siteId#stringin pathrequired
Body
UpdateSiteDtosubdomain#stringSubdomain to register. Required if customDomain not provided.
Required in the spec, optional for the API.
customDomain#stringCustom domain to register. Required if subdomain not provided.
Required in the spec, optional for the API.
accountId#stringUUIDOnly required to link the created entity to a child account instead of the current one.
Response
200 · SiteNo field is described in the spec.
Errors
400Invalid customDomain
{ "statusCode": 400, "message": "Invalid customDomain", "error": "Bad Request" }400A field is missing, has the wrong type, or is not part of the request schema.
Every request with a body or query is validated.
{ "statusCode": 400, "message": [ "amount must not be less than 1", "property foo should not exist" ], "error": "Bad Request" }401Unauthorized
Missing, expired or invalid access token.
{ "statusCode": 401, "message": "Unauthorized" }402Plan upgrade required
{ "statusCode": 402, "message": "Plan upgrade required" }403Subdomain can't be updated
{ "statusCode": 403, "message": "Subdomain can't be updated", "error": "Forbidden" }403Account closed
{ "message": "Account closed", "code": "ACCOUNT_CLOSED" }403Forbidden
Your credentials cannot perform this action on this resource. An id from another account answers 404 in the path, 400 in the body or the query.
{ "statusCode": 403, "message": "Forbidden" }404Not Found
No resource with this id on your account: the API answers as if it did not exist.
{ "statusCode": 404, "message": "Not Found" }
curl -X PATCH https://api.sandbox.charitips.com/v1/sites/<siteId> \ -H "Authorization: Bearer $CHARITIPS_TOKEN" \ -H "Content-Type: application/json" \ -d '{ "subdomain": "donations" }'Request bodies are written for this docs and checked against the API's validation; ids in angle brackets are placeholders. Response values are placeholders built from the schema.