{"_id":"5d3efc26400ffa007369e480","project":"543469460ef9c00800164f0e","version":{"_id":"54346a2a0ef9c00800164f28","forked_from":"543469460ef9c00800164f11","project":"543469460ef9c00800164f0e","__v":8,"createdAt":"2014-10-07T22:33:14.982Z","releaseDate":"2014-10-07T22:33:14.982Z","categories":["54346a2b0ef9c00800164f29","543473445b10711400c6c21a","543473500ef9c00800164fde","54347c625b10711400c6c301","5434918d0ef9c008001651ff","5434b72c008ec22200d86ae7","5435990c495d5d0800f3a510","5b6af3dffc81e4000383db74"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":true,"codename":"","version_clean":"2.0.0","version":"2.0"},"category":{"_id":"5434918d0ef9c008001651ff","pages":["5435626c5ff8a51a006e4110","543553953513400800a14736","543555cc3513400800a14752","54355bcc35740020002a1b3b","5434928b0ef9c0080016520e","54347c8e5b10711400c6c30a","54346f750ef9c00800164fa0","543470f45b10711400c6c1e5","543477b70ef9c0080016505b","543478fb5b10711400c6c29f","54347d105b10711400c6c318","54347df00ef9c008001650d2","54347edf5b10711400c6c336","54357a175e1b2020004380dc","543483520ef9c0080016512a","543484820ef9c0080016513a","5434887e5b10711400c6c3cd","543488c05b10711400c6c3d2","54348ac85b10711400c6c401","5434959c0ef9c0080016522d","543497030ef9c00800165244","543498ae5b10711400c6c4f6","54349b7f0ef9c00800165293","54349c070ef9c00800165298","54349dbf0ef9c008001652ad","5434ab8e0ef9c00800165384","5434abbb0ef9c0080016538f","5434ac495b10711400c6c626","5434ada40ef9c008001653a8","5434af0a0ef9c008001653bc","5434af5f0ef9c008001653c8","5434b00a5b10711400c6c66b","5434b0d15b10711400c6c68c","5434b1ee0ef9c00800165406","5434b26d0ef9c0080016541c","5434b3560ef9c00800165427","5434b3b40ef9c0080016545a","5434b49f008ec22200d86ab9","5434b51f008ec22200d86aca","5434b5a80ef9c0080016546f","5434b5f4008ec22200d86ad8","5434b676008ec22200d86add","5434b6e6008ec22200d86ae5"],"version":"54346a2a0ef9c00800164f28","__v":30,"project":"543469460ef9c00800164f0e","sync":{"url":"","isSync":false},"reference":false,"createdAt":"2014-10-08T01:21:17.804Z","from_sync":false,"order":1,"slug":"rest-api","title":"REST API"},"user":"5d038ca81e85e00027d975a8","__v":9,"parentDoc":null,"metadata":{"title":"","description":"","image":[]},"updates":[],"next":{"pages":[],"description":""},"createdAt":"2019-07-29T14:01:10.907Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"settings":"5d24a85d679189012c4d5dff","results":{"codes":[{"name":null,"code":"{\n  \"id\": 2,\n  \"name\": \"portal name\",\n  \"description\": \"portal description\",\n  \"avatar\": \"https://...\",\n  \"created\": \"2019-01-01 13:40:40\",\n  \"timezone\": \"Europe/London\",\n  \"participantCount\": 1,\n  \"portalForms\": [\n    {\n      \"id\": 2,\n      \"name\": \"test form\",\n      \"deadline\": null,\n      \"completedUserCount\": 0,\n      \"description\": null,\n      \"formUrl\": \"https://formstack.com/form-url\",\n      \"formId\": 1,\n      \"notifyUsers\": null,\n      \"usersPerformance\": [\n        {\n          \"id\": 3,\n          \"formCompletionDate\": null,\n          \"lastSubmissionId\": null\n        }\n      ]\n    },\n  ],\n  \"portalUsers\": [\n    {\n      \"id\": 3,\n      \"avatarUrl\": \"https://url\",\n      \"email\": \"portal.participant:::at:::example.com\",\n      \"name\": \"participant name\",\n      \"type\": \"external\"\n    }\n  ]\n}","language":"json","status":200},{"code":"","language":"text","status":404}]},"examples":{"codes":[{"code":"","language":"text"}]},"method":"post","auth":"required","params":[{"_id":"5d3efbb94df70a00124ff0ec","ref":"","in":"path","required":true,"desc":"","default":"","type":"int","name":"id"},{"_id":"5d3f029ed033e7003014dfe9","ref":"","in":"body","required":true,"desc":"image contents","default":"","type":"string","name":"avatar"},{"_id":"5d3f02f5eafec90018b1f578","ref":"","in":"header","required":true,"desc":"Should be `multipart/form-data`","default":"","type":"string","name":"Content-type"}],"url":"/v2/portal/:id/avatar"},"isReference":false,"order":62,"body":"See model definition: https://developers.formstack.com/v2.0/docs/portals#section-portal\n\nPayload is expected to be `multipart/form-data` encode'd.\n\nOn success - returns updated portal representation.","excerpt":"Upload an avatar for specified portal","slug":"portal-upload-avatar","type":"endpoint","title":"/portal/:id/avatar"}

post/portal/:id/avatar

Upload an avatar for specified portal

Definition

{{ api_url }}{{ page_api_url }}

Parameters

Path Params

id:
required
integer

Body Params

avatar:
required
string
image contents

Headers

Content-type:
required
string
Should be `multipart/form-data`

Result Format


Documentation

See model definition: https://developers.formstack.com/v2.0/docs/portals#section-portal Payload is expected to be `multipart/form-data` encode'd. On success - returns updated portal representation.

User Information

Try It Out

post
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}